Users

Disables a user (or sets a future disable date).

If no date is provided, the user's status is set to Disabled immediately.

Example request body:

             { "DisableOnDate": "2025-01-31T00:00:00Z" }
post/v1/users/{id}/disable

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/users/{id}/disable
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

idinteger required

User ID.

Query parameters

profileidinteger

Request body

DisableOnDatestring date-time

Date to disable the user.

Response

OK

Object required

Changes

No recorded changes to this operation across all 1 revision of this API.