Skip to main content
PUT
Save Connector Credentials

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

salesChannelId
string
required

Sales channel id of the connector account whose credentials are replaced. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing.

Body

application/json

Request model for SaveConnectorCredentials command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

apiToken
string
required

API token in plain text. Write-only. Maximum 111 bytes in UTF-8; multi-byte characters count as several bytes.

Response

The credentials were stored. No content is returned; the token is never echoed back.