GET /experience/experiences/{experienceId}/assignability

Check if target can be assigned to Experience

Validates whether a specific Experience is available to the user with a given target (e.g., phone number). Use this endpoint before attempting to create an Experience Connection.

Handle 429. This endpoint is rate limited to 100 requests per second per credential. A 429 is not listed below but does occur — back off rather than retrying immediately.

Authentication

OAuth 2.0. Required scope(s): experience-assignability:check.

Request

Path parameters

Name Type Required Description
experienceId string yes ID of the Experience

Query parameters

Name Type Required Description
targetType TargetType yes Filter by target type
targetValue TargetValue yes Filter by target value. Format depends on targetType: - PHONE_NUMBER: E.164 format (e.g., +14155551234) - USER: UUID format (e.g., c07881d7-200f-424e-b760-f24838f31eef) - ACCOUNT: UUID format (e.g., c07881d7-200f-424e-b760-f24838f31eef)

Headers

None.

Responses

200 — Assignability checked successfully

Content-Type: application/json

Field Type Required Description
assignable boolean yes Whether a specific Experience is available to the user with a given target (e.g., phone number). Return false if the given target cannot be found.
experienceId string yes ID of the Experience being checked
targetType TargetType yes Type of the target identifier being checked
targetValue TargetValue yes Value of the target identifier being checked. Format reflects the corresponding targetType. See TargetValue schema for per-type format rules and patterns.

Example:

{
  "experienceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "targetType": "PHONE_NUMBER",
  "targetValue": "+14155551234",
  "assignable": true
}

400 — Bad Request. Possible causes: - targetType is missing or not a valid enum value - targetValue is missing - targetValue format does not match the expected format for the given targetType: - PHONE_NUMBER requires E.164 format (e.g., +14155551234) - USER requires UUID format (e.g., c07881d7-200f-424e-b760-f24838f31eef) - ACCOUNT requires UUID format (e.g., c07881d7-200f-424e-b760-f24838f31eef)

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Bad Request",
  "status": 400,
  "detail": "targetType must be one of PHONE_NUMBER, USER, ACCOUNT",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

401 — Unauthorized - Missing or expired access token. Obtain a new token and retry.

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Access token is missing or has expired",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

403 — Forbidden - Experience exists, the authenticated user has authorization to read but no authorization to check assignability for the Experience

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Forbidden",
  "status": 403,
  "detail": "The authenticated user does not have authorization to check assignability for this Experience",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

404 — Not Found - Experience does not exist or the authenticated user does not have authorization to access the Experience

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Resource Not Found",
  "status": 404,
  "detail": "The requested Experience does not exist",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

Errors

This operation may return:

  • 400 — Bad Request — missing or invalid query parameters
  • 401 — Unauthorized - Missing or expired access token. Obtain a new token and retry.
  • 403 — Forbidden - Experience exists, the authenticated user has authorization to read but no authorization to check assignability for the Experience
  • 404 — Not Found - Experience does not exist or the authenticated user does not have authorization to access the Experience

See Errors reference for the full catalogue.