Create Engagement

post

{protocol}://{server}{basePath}/accounts/{accountId}/engagements

Creates a new Engagement or Customer Journey's touchpoint in a Customer's Journey .
Note: Engagements created this way WILL NOT be routed to an Agent or not affect AXP's Digital workflow and exist solely within a Customer Journey for historical purposes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

Create a new Engagement in a Customer's Journey

Unique Customer ids used during an Engagement.

identifiers

object

required

Unique identifiers for identifying the customer during an Engagement such as phoneNumbers or emailAddresses.

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique 36 character internal id that represents the engagement.

startDate

date-time

required

The start datetime of the Engagement in ISO 8601 format, for example 2018-11-13T20:20:39+00:00

conversations

array of strings

length between 0 and 10

The conversation (or purpose) of the Engagement.

conversations

data

object

Optional, generic key-value pair data stored with the Engagement. The maximum length of a key is 64 characters and the maximum length of a value is 1024 characters.

This is useful for storing custom information against an Engagement, Customer Journey itself does not take any action beyond basic validation on this data.

If the key already exists the value will be replaced by the new value provided.

Responses

202

Accepted