NSns-api
Resellers

Update Reseller

Changed on
put/resellers/{reseller}

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/resellers/{reseller}
  • Auth
    HTTP bearer

Path parameters

resellerstring required

Request body

descriptionstring

This description can be used to give a more complete description and notes for this reseller.

domains-totalinteger

This is the total number of domains in this Reseller's account.

users-totalinteger

This is the total number of users in all domains owned by this reseller.

email-send-smtp-hostnamestring hostname

This is the SMTP server hostname

email-send-smtp-portinteger nullable

This is the SMTP port for sending emails.

email-send-smtp-usernamestring nullable

This is the username used in connecting to SMTP server for sending email.

email-send-smtp-passwordstring pas nullable

This is the password used in connecting to SMTP server for sending email.

active-calls-against-license-countinteger

This is the current active calls counting against the license including on net calls.

active-calls-offnet-currentinteger

This is the current active calls across all domains that are calls coming from or going to offnet numbers.

Example request

{
  "email-send-smtp-hostname": "email-smtp.us-west-2.amazonaws.com",
  "email-send-smtp-port": 587
}

Response

resellerstring required

The name of the Reseller. This is the main ID for the group which will be used to link domains for ownership.

descriptionstring

This description can be used to give a more complete description and notes for this reseller.

domains-totalinteger

This is the total number of domains in this Reseller's account.

users-totalinteger

This is the total number of users in all domains owned by this reseller.

email-send-smtp-hostnamestring hostname

This is the SMTP server hostname

email-send-smtp-portinteger nullable

This is the SMTP port for sending emails.

email-send-smtp-usernamestring nullable

This is the username used in connecting to SMTP server for sending email.

email-send-smtp-passwordstring pas nullable

This is the password used in connecting to SMTP server for sending email.

active-calls-against-license-countinteger

This is the current active calls counting against the license including on net calls.

active-calls-offnet-currentinteger

This is the current active calls across all domains that are calls coming from or going to offnet numbers.

Example response

[
  {
    "reseller": "myReseller",
    "email-send-smtp-hostname": "email-smtp.us-west-2.amazonaws.com",
    "email-send-smtp-port": 587
  }
]

Changes

  • bce16087d479Revision changes
    • breaking

      the response property / became nullable for the status

    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property / to the response with the status