Users

Partially updates an existing user.

Validation notes:

  • LoginName, FirstName, LastName cannot be empty strings if provided.
  • PhoneNumber may be cleared by providing an empty string.

Example request body (PATCH):

             {
               "FirstName": "Updated",
               "EnableSAMLDirectLogin": true
             }
patch/v1/users/{id}

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/users/{id}
  • 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

LoginNamestring

New login name. Cannot be empty string.

FirstNamestring

New first name. Cannot be empty string.

LastNamestring

New last name. Cannot be empty string.

PhoneNumberstring

New phone number. Empty string clears the value.

BillingAccessboolean

Billing access flag.

DisableOnDatestring date-time

Date to disable the user.

EnableSAMLDirectLoginboolean

Enable SAML direct login flag.

Enabledboolean

Enable or disable the user.

CorrespondenceEmailAddressstring

Correspondence email address. If not provided, LoginName will be used.

Response

OK

Object required

Changes

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