API documentation | API docs for agents | OpenAPI 3.1

teams

ark.set_customer_team_visibility

Replaces the customer team mappings the connected actor can manage while preserving existing mappings outside the actor team scope.

Availability: Core preview
Scopes: customers:write
ARK permissions: canEditCustomer
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

customerIdpathstringrequired: Visible ARK customer ID.; format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

teamIdsarray<string>required

Visible ARK team IDs to set for the customer. Existing customer mappings outside the connection team scope are preserved and returned.

min items: 1; max items: 100

Example request

Shell

curl -X PUT 'https://arktms.com/api/v1/customers/<customerId>/teams' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "teamIds": [
    "<teamIds>"
  ]
}'

Success response

Customer team visibility result

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.customerIdstringrequired

format: uuid

data.teamIdsarray<string>required

Final customer team visibility IDs after preserving hidden mappings.

data.preservedTeamIdsarray<string>required

Existing customer team mappings outside the connection team scope that were preserved.

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry