Update a connected account

Update a connected account. Supports updating the alias and/or credentials. Only specified fields will be updated. Set a credential field to null to remove it. Alias must be unique within the same project, entity, and toolkit scope.

patch/api/v3.1/connected_accounts/{nanoid}

Path parameters

nanoidstring connectedAccountId required

The unique identifier (nanoid) of the connected account

Request body

aliasstring

A human-readable alias for this connected account. Pass an empty string to clear the alias. Must be unique per entity and toolkit within the project.

Response

Successfully updated connected account

successboolean required

Whether the update was successful

idstring connectedAccountId required

The unique identifier of the updated connected account

statusstring required

The current status of the connected account after the update (ACTIVE, EXPIRED, INACTIVE, etc.)

Example response

{
  "success": true,
  "id": "ca_1a2b3c4d5e6f",
  "status": "ACTIVE"
}

Changes

Changed in 9 of the 61 revisions of this API.5138

Jun 17, 2026589a7d115a5e2See the full diff
- ○
  the endpoint scheme security CookieAuth was removed from the API
  api-security-removed
- ○
  the endpoint scheme security UserApiKeyAuth was removed from the API
  api-security-removed
Jun 11, 20262f373d80a589225See the full diff
- ●
  removed the request property connection/state/val/COMPANYDOMAIN
  request-property-removed
- ●
  removed the request property connection/state/val/account_id
  request-property-removed
- ●
  removed the request property connection/state/val/account_url
  request-property-removed
- ●
  removed the request property connection/state/val/api_url
  request-property-removed
- ●
  removed the request property connection/state/val/base_url
  request-property-removed
- ●
  removed the request property connection/state/val/borneo_dashboard_url
  request-property-removed
- ●
  removed the request property connection/state/val/dc
  request-property-removed
- ●
  removed the request property connection/state/val/domain
  request-property-removed
- ●
  removed the request property connection/state/val/extension
  request-property-removed
- ●
  removed the request property connection/state/val/form_api_base_url
  request-property-removed
- ●
  removed the request property connection/state/val/instanceEndpoint
  request-property-removed
- ●
  removed the request property connection/state/val/instanceName
  request-property-removed
- ●
  removed the request property connection/state/val/proxy_password
  request-property-removed
- ●
  removed the request property connection/state/val/proxy_username
  request-property-removed
- ●
  removed the request property connection/state/val/region
  request-property-removed
- ●
  removed the request property connection/state/val/server_location
  request-property-removed
- ●
  removed the request property connection/state/val/shop
  request-property-removed
- ●
  removed the request property connection/state/val/site_name
  request-property-removed
- ●
  removed the request property connection/state/val/subdomain
  request-property-removed
- ●
  removed the request property connection/state/val/version
  request-property-removed
- ●
  removed the request property connection/state/val/your-domain
  request-property-removed
- ●
  removed the request property connection/state/val/your_server
  request-property-removed
- ○
  added the new optional request property connection/state/val/api_key_prefix
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/generic_id
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/generic_secret
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/generic_token
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/user_agent
  new-optional-request-property
Jun 9, 2026c3f42a0d0fcb522See the full diff
- ●
  removed the request property connection/state/val/api_key_prefix
  request-property-removed
- ●
  removed the request property connection/state/val/generic_id
  request-property-removed
- ●
  removed the request property connection/state/val/generic_secret
  request-property-removed
- ●
  removed the request property connection/state/val/generic_token
  request-property-removed
- ●
  removed the request property connection/state/val/user_agent
  request-property-removed
- ○
  added the new optional request property connection/state/val/COMPANYDOMAIN
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/account_id
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/account_url
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/api_url
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/base_url
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/borneo_dashboard_url
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/dc
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/domain
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/extension
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/form_api_base_url
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/instanceEndpoint
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/instanceName
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/proxy_password
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/proxy_username
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/region
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/server_location
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/shop
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/site_name
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/subdomain
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/version
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/your-domain
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/your_server
  new-optional-request-property
Jun 9, 20262f373d80a589225See the full diff
- ●
  removed the request property connection/state/val/COMPANYDOMAIN
  request-property-removed
- ●
  removed the request property connection/state/val/account_id
  request-property-removed
- ●
  removed the request property connection/state/val/account_url
  request-property-removed
- ●
  removed the request property connection/state/val/api_url
  request-property-removed
- ●
  removed the request property connection/state/val/base_url
  request-property-removed
- ●
  removed the request property connection/state/val/borneo_dashboard_url
  request-property-removed
- ●
  removed the request property connection/state/val/dc
  request-property-removed
- ●
  removed the request property connection/state/val/domain
  request-property-removed
- ●
  removed the request property connection/state/val/extension
  request-property-removed
- ●
  removed the request property connection/state/val/form_api_base_url
  request-property-removed
- ●
  removed the request property connection/state/val/instanceEndpoint
  request-property-removed
- ●
  removed the request property connection/state/val/instanceName
  request-property-removed
- ●
  removed the request property connection/state/val/proxy_password
  request-property-removed
- ●
  removed the request property connection/state/val/proxy_username
  request-property-removed
- ●
  removed the request property connection/state/val/region
  request-property-removed
- ●
  removed the request property connection/state/val/server_location
  request-property-removed
- ●
  removed the request property connection/state/val/shop
  request-property-removed
- ●
  removed the request property connection/state/val/site_name
  request-property-removed
- ●
  removed the request property connection/state/val/subdomain
  request-property-removed
- ●
  removed the request property connection/state/val/version
  request-property-removed
- ●
  removed the request property connection/state/val/your-domain
  request-property-removed
- ●
  removed the request property connection/state/val/your_server
  request-property-removed
- ○
  added the new optional request property connection/state/val/api_key_prefix
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/generic_id
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/generic_secret
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/generic_token
  new-optional-request-property
- ○
  added the new optional request property connection/state/val/user_agent
  new-optional-request-property
May 21, 202693f4cec8119e1See the full diff
- ●
  removed the request property experimental/account_type
  request-property-removed
May 19, 2026aa07ab954e7c1See the full diff
- ○
  added the new optional request property experimental/account_type
  new-optional-request-property
May 12, 2026166dca8a495b11See the full diff
- ●
  removed the request property acl_config_for_shared
  request-property-removed
- ○
  added the new optional request property experimental
  new-optional-request-property
May 11, 202623348819b35e1See the full diff
- ○
  added the new optional request property acl_config_for_shared
  new-optional-request-property
May 5, 202652c71f747c651See the full diff
- ○
  endpoint added
  endpoint-added

Full history