Post /interaction/v1/interactions/contactexit/status

Overview

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

JSON Parameters

Name	Type		Description
ContactKey	string	`Required`	ID that uniquely identifies a subscriber or contact. Include a single contact or an array of up to 50 contacts.
DefinitionKey	string	`Required`	Customer Key that uniquely identifies the journey. This key is the same for all versions of the journey.
Versions	array		One or more versions of a journey from which to remove a contact.

Responses

Status	Name	Type	Description
200			****
	contactKey	string	Contact that needs to be removed from a journey
	definitionKey	string	Definition key of the journey
	status	array	Array of statuses of the contact in a given journey
	status.version	string	Version number of the journey
	status.message	string	Status of the request to remove a contact from a specific version of the journey
	status.definitionInstanceId	string	Unique Id representing each instance of a contact in a journey

Usage

Example Request

1Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
2POST /interaction/v1/interactions/contactexit/status
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN
5
6[
7	{
8		"ContactKey": "CONTACTKEY 1",
9		"DefinitionKey": "DEFINITIONKEY"
10	},
11	{
12		"ContactKey": "CONTACTKEY 2",
13		"DefinitionKey": "INVALID DEFINITIONKEY",
14		"Versions" :[1,2]
15	}
16]

Example Response

1HTTP/1.1 200 Accepted
2[
3    {
4        "contactKey": "CONTACTKEY 1",
5        "definitionKey": "DEFINITIONKEY",
6        "status": [
7            {
8                "version": 1,
9                "message": "Exit process Completed.",
10                "definitionInstanceId": "423698a6-a517-4bf9-8ecc-3517905aa489"
11            },
12            {
13                "version": 2,
14                "message": "Exit request received for processing"
15            }
16        ]
17    },
18    {
19        "contactKey": "CONTACTKEY 2",
20        "definitionKey": "DEFINITIONKEY",
21        "status": [
22            {
23                "version": 1,
24                "message": "Exit Request is being Processed.",
25                "definitionInstanceId": "68e1544e-9bdc-4e3f-9cb0-e6d0bfceefc0"
26            },
27            {
28                "version": 2,
29                "message": "Exit request received for processing"
30            }
31        ]
32    }
33]

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!