POST /interaction/v1/interactions/contactexit/status

Returns the status of a request to remove a contact from a journey or from one or more versions of a journey.

JSON Parameters

NameTypeDescription
ContactKeystringRequiredID that uniquely identifies a subscriber or contact. Include a single contact or an array of up to 50 contacts.
DefinitionKeystringRequiredCustomer Key that uniquely identifies the journey. This key is the same for all versions of the journey.
VersionsarrayOne or more versions of a journey from which to remove a contact.

Responses

StatusNameTypeDescription
200  ****
 contactKeystringContact that needs to be removed from a journey
 definitionKeystringDefinition key of the journey
 statusarrayArray of statuses of the contact in a given journey
 status.versionstringVersion number of the journey
 status.messagestringStatus of the request to remove a contact from a specific version of the journey
 status.definitionInstanceIdstringUnique Id representing each instance of a contact in a journey

Example Request

Response: No Errors

Response: Processing Pending for Contact Request for Exit

Response: Successful Completion of Exit by Contact

Response: Invalid contactKey

Response: Runtime Error

Response: Empty or Incorrect Authorization Token