Partner API V1

Authentication

Bolt manually issues a client ID and client secret to each approved channel-manager partner. Exchange them for a short-lived token before calling any connection, room, mapping, or availability endpoint.

Create an access token

POST/auth/token
This is the only Partner API endpoint that does not require a bearer token.
FieldTypeRequiredDescription
request_idstringCorrelation identifier for this token request.
client_idstringYesThe non-empty partner identifier issued by Bolt; maximum 255 characters.
client_secretstringYesThe non-empty secret issued with the client ID; maximum 4,096 bytes. Treat it like a password.
Request
curl --request POST \
  --url "$BASE_URL/auth/token" \
  --header "Content-Type: application/json" \
  --data '{
    "client_id": "<CLIENT_ID>",
    "client_secret": "<CLIENT_SECRET>"
  }'
200 response
{
  "request_id": "req_example",
  "access_token": "<ACCESS_TOKEN>",
  "token_type": "Bearer",
  "expires_in": 3600
}
FieldTypeDescription
access_tokenstringPartner-scoped JWT used in the Authorization header.
token_typestringAlways Bearer.
expires_inintegerToken lifetime in seconds. V1 returns 3600.

Use the bearer token

Send the access token in the Authorizationheader on every other request. The token identifies the partner, not a Bolt user or property owner.

Authenticated request
curl --request GET \
  --url "$BASE_URL/connections?status=PENDING&limit=100" \
  --header "Authorization: Bearer <ACCESS_TOKEN>"

Authentication errors

401 response
{
  "request_id": "req_example",
  "error": {
    "code": "PARTNER_UNAUTHORIZED",
    "message": "Invalid partner credentials."
  }
}
ConditionHTTP statusCodeAction
Unknown client ID, invalid secret, malformed token, or expired token401PARTNER_UNAUTHORIZEDCheck the credentials or obtain a new token.
Bolt has disabled the partner account403PARTNER_DISABLEDStop retries and contact Bolt.
Authentication request rate exceeded429RATE_LIMIT_EXCEEDEDBack off before requesting another token.

Authentication rate limit

The default is 20 token requests per source IP per minute. Bolt can configure this operational limit, so always honor an HTTP 429 response and avoid requesting a new token for every API call.

Credential security and rotation

  • Store the client secret in a server-side secret manager.
  • Never include credentials or tokens in frontend code, URLs, screenshots, logs, analytics, or public support conversations.
  • Cache and reuse an access token until shortly before its 3,600-second lifetime ends.
  • Contact Bolt to rotate a client secret. Update your secret store and obtain a new token using the replacement credential.
  • Treat an unexpected authentication failure as a possible rotation, revocation, or account-status event and escalate through your secure partner support channel.

Never send a property secret

Property owners do not receive Partner API credentials. A property connection is discovered through GET /connections; no property token or connection key is exchanged.