Reseller Users

A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

• GET/account/reseller-user

  Gets a list of all users currently allowed to access and manage this reseller and their sub-resellers

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "contact_first_name" : "Pete",
              "contact_last_name" : "Plumber",
              "created_on" : "2023-06-07",
              "role_id" : 1,
              "updated_on" : "2023-06-07",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/account/reseller-user/{uuid}

  Gets the details for the specified reseller user

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Reseller User to be queried

  Response Details

  200 Response

  {
      "result" : {
          "contact_first_name" : "Pete",
          "contact_last_name" : "Plumber",
          "created_on" : "2023-06-07",
          "role_id" : 1,
          "updated_on" : "2023-06-07",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• POST/account/reseller-user

  Creates a new reseller user, users can't be created with a role_id of 1

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • contact_first_name

    • String

    • False

    This Reseller User's first name

  • • contact_last_name

    • String

    • False

    This Reseller User's last name

  • • role_id

    • int

    • True

    This Reseller User's role id, which determines their level of access.

  JSON all-fields example:

  {
      "contact_first_name" : "Pete",
      "contact_last_name" : "Plumber",
      "role_id" : 1
  }

  Response Details

  201 Response

  {
      "result" : {
          "contact_first_name" : "Pete",
          "contact_last_name" : "Plumber",
          "created_on" : "2023-06-07",
          "role_id" : 1,
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

  409 Response

  {
      "result" : {},
      "status_code" : 409,
      "status_message" : "Conflict"
  }

• PUT/account/reseller-user/{uuid}

  Updates the user name or password of the specified user, the role ID can't be changed on the primary account holder

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Reseller User to be updated

  PUT body

  • Name

  • Type

  • Required

  • • contact_first_name

    • String

    • False

    This Reseller User's first name

  • • contact_last_name

    • String

    • False

    This Reseller User's last name

  • • role_id

    • int

    • True

    This Reseller User's role id, which determines their level of access.

  JSON all-fields example:

  {
      "contact_first_name" : "Pete",
      "contact_last_name" : "Plumber",
      "role_id" : 1
  }

  Response Details

  200 Response

  {
      "result" : {
          "contact_first_name" : "Pete",
          "contact_last_name" : "Plumber",
          "created_on" : "2023-06-07",
          "role_id" : 1,
          "updated_on" : "2023-06-07",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

  409 Response

  {
      "result" : {},
      "status_code" : 409,
      "status_message" : "Conflict"
  }

• DELETE/account/reseller-user/{uuid}

  Deletes the specified reseller user, can't be used to delete the user performing the command, or the last user on an account

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Reseller User to be deleted

  Response Details

  204 Response

  {
      "result" : {},
      "status_code" : 204,
      "status_message" : "No Content"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }