Sync Reseller Accounts

Synchronizes multiple reseller accounts in one request.

Request URL

POST {base_url}/uc-user/api/v1/accounts/resellers/sync/batch

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code No String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
ppAccountIds Yes Array<String> The list of PP user IDs, which are the same as the NovoOne user IDs. You can obtain the IDs using the Search Syncable Accounts interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Object<Sync_Accounts_Result> The synchronization result.
Sync_Accounts_Result
Parameter Type Description
successCount Integer The number of accounts synchronized successfully.
failed Array<Sync_Failure_Item> The list of failed synchronization details. An empty array indicates that all accounts are synchronized successfully.
Sync_Failure_Item
Parameter Type Description
ppAccountId String The PP user ID, which is the same as the NovoOne user ID.
errorCode String

The error code of the failure:

  • INVALID_ID_FORMAT: The account ID format is invalid.
  • USER_NOT_FOUND: The user does not exist.
  • USER_DELETED: The user has been deleted.
  • SUB_TYPE_NOT_ADMIN: The user role is not ADMIN.
  • NOT_SYNCABLE: The account is not within the scope of the current administrator.
errorMessage String The description of the failure reason.