POST /experience-assignments

Assign an Experience

Assign an Experience to a target (e.g. phone number) by creating an assignment

Authentication

OAuth 2.0. Required scope(s): experience-assignments:manage.

Request

Path parameters

None.

Query parameters

None.

Headers

None.

Body

Required: yes

Content-Type: application/json

Schema: ExperienceAssignment

No example in spec.

Spec gap. No request body example is provided for createExperienceAssignment. The field-level table below is authoritative. Code samples on this page were generated from the schema; verify against your environment before relying on them.

Gap ID 03a0dea8bf54

Responses

201 — Experience assigned successfully

Content-Type: application/json

Schema: ExperienceAssignment

Example:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "experienceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "accountId": "d4e5f6a7-b8c9-0123-def0-234567890123",
  "targetType": "PHONE_NUMBER",
  "targetValue": "+14155551234",
  "updatedAt": "2026-05-01T12:00:00Z"
}

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"
}

409 — Conflict - The target is already assigned to this Experience

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Conflict",
  "status": 409,
  "detail": "The target is already assigned to this Experience",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

422 — Unprocessable Entity. Possible causes: - Missing required fields or invalid values - 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) - targetType is USER but the specified user-id in targetValue does not exist in the unified user cache

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "experienceId is required",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

Errors

This operation may return:

  • 401 — Unauthorized - Missing or expired access token. Obtain a new token and retry.
  • 409 — Conflict - The target is already assigned to this Experience
  • 422 — Unprocessable Entity. Possible causes: - Missing required fields or invalid values - 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) - targetType is USER but the specified user-id in targetValue does not exist in the unified user cache

See Errors reference for the full catalogue.