PUT /experience-connections/{experienceConnectionId}

Update the state of an Experience Connection

Updates the connection to the requested state

Spec gap. The Alianza Enterprise API standard expects PUT to replace the full entity representation. The spec description no longer explicitly states this. Confirm with Alianza whether partial updates are accepted, and send the complete ExperienceConnection body to be safe.

Gap ID 4163c03d6a8b

Authentication

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

Request

Path parameters

Name Type Required Description
experienceConnectionId string yes ID of the Experience Connection

Query parameters

None.

Headers

None.

Body

Required: yes

Content-Type: application/json

Schema: ExperienceConnection

No example in spec.

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

Gap ID ff2cd367f736

Responses

200 — Experience Connection updated successfully

Content-Type: application/json

Schema: ExperienceConnection

Example:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "accountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "experienceId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "state": "ACTIVE"
}

400 — Bad Request - Request is malformed

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Request is malformed",
  "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 Connection exists, the authenticated user has authorization to read but no authorization to update it

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

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

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

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Resource Not Found",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

409 — Conflict - The Experience Connection is already in the requested state

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Conflict",
  "status": 409,
  "detail": "The Experience Connection is not in a state that allows this operation",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

422 — Unprocessable Entity - Invalid data (missing required fields, invalid values)

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

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

Errors

This operation may return:

  • 400 — Bad Request - Request is malformed
  • 401 — Unauthorized - Missing or expired access token. Obtain a new token and retry.
  • 403 — Forbidden - Experience Connection exists, the authenticated user has authorization to read but no authorization to update it
  • 404 — Not Found - Experience Connection does not exist or the authenticated user does not have authorization to access it
  • 409 — Conflict - The Experience Connection is already in the requested state
  • 422 — Unprocessable Entity - Invalid data (missing required fields, invalid values)

See Errors reference for the full catalogue.