Experience Status API

Prev Next
Get
/experience-status/1.0/client/{client_id}/customer/{ccid}/trigger_status

This API retrieves a real-time engagement snapshot for display purposes only. The snapshot is an aggregrate view at the time of the request, so returned values may vary depending on the timing of the request.

Header parameters
xx-relay-api-key
stringRequired

Contains the API key needed.

Path parameters
client_id
stringRequired

Client ID

Minimum1
ccid
stringRequired

Uniquely identifies a Customer or Patient.

Max length100
ExampleBAK-11984-007
Query parameters
trigger_id
string

Optional filtering of returned triggers. Specify multiple times to target more than one trigger_id.

Responses
200

OK

Expand All
object

Schema for the experience status API response payload

ccid
string

Customer or campaign identifier

client_id
string

Client identifier

experiences
Array of object

List of experiences associated with this customer/client

object
experience_id
string

Unique identifier for the experience

Examplee5c2d531-7fee-420d-9eac-f8fbbd1bf9ee
experience_name
string

Name of the experience

ExampleWelcome Message
triggers
Array of object

List of triggers associated with this experience

object
trigger_id
string

Trigger ID

Example08ef57a9-f22b-4f43-aebe-8db8b26daac7
trigger_name
string

Name of the trigger

ExampleWelcome Account Holder
lb_source
string

Launched-by source identifier

Examplecompany-system
lb_name
string

Launched-by name identifying a specific entity from lb_source

message_send_status
object (TriggerStatusInfo)
status_name
string

Name of the status

Exampledelivered
error_message
string

Error message if applicable, null otherwise

Example
status_time
string (date-time)

Timestamp when this status was recorded

Example2025-08-26T17:37:55.514Z
sms_send_status
object (TriggerStatusInfo)
status_name
string

Name of the status

Exampledelivered
error_message
string

Error message if applicable, null otherwise

Example
status_time
string (date-time)

Timestamp when this status was recorded

Example2025-08-26T17:37:55.514Z
opened_status
object (TriggerStatusInfo)
status_name
string

Name of the status

Exampledelivered
error_message
string

Error message if applicable, null otherwise

Example
status_time
string (date-time)

Timestamp when this status was recorded

Example2025-08-26T17:37:55.514Z
engagement_status
object (TriggerStatusInfo)
status_name
string

Name of the status

Exampledelivered
error_message
string

Error message if applicable, null otherwise

Example
status_time
string (date-time)

Timestamp when this status was recorded

Example2025-08-26T17:37:55.514Z
400

Invalid request

401

Unauthorized

403

Forbidden

404

Not Found - The requested resource was not found. Please verify the route parameter.

409

Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.

500

An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.}