Create an entry event that asynchronously inserts one or more contacts into a journey.
|eventDefinitionKey||string||Required||Find the EventDefinitionKey in Journey Builder Event Administration after the event is created and saved. The EventDefinitionKey is present for standard and custom events.|
|members||array||Required||An array that contains information about the contacts that you’re inserting into the journey. You can insert up to 100 contacts into a journey in a single request.|
|members.contactKey||string||Required||The unique ID of a subscriber or a contact. You can include the same contactKey multiple times in the same request.|
|members.data||object||An object that contains metadata for each contact, such as personalization attributes.|
|requestId||string||The unique identifier of the batch request. You can use this ID to check the status of the batch.|
|count||number||The number of member objects in the request.|
|notQueuedCount||number||The number of member objects that couldn’t be queued.|
|members||array||An array of contact objects. The API returns the list members in the same order that it received them.|
|members.contactKey||string||The unique ID of a subscriber or a contact. The response can include the same contactKey multiple times in the same request.|
|members.eventInstanceId||string||The unique identifier for the batch member. You can use this ID to check the status of an individual contact.|
|members.errorcode||string||An error code. The response only includes this property if there was an error in processing an event instance.|
|members.message||string||An error message associated with the error code. The response only includes this property if there was an error in processing an event instance.|
|10000||Interaction Count Limit Exceeded||Batch Error||We could not queue your request. The eventDefinitionKey is shared by too many journeys. Create a new eventDefinitionKey, then try again.|
|10000||Entry Event Violation||Batch Error||We could not queue your request. Remove the eventDefinitionKey from journey activities that are not an entry source, then try again.|
|10000||Request Size Exceeds Limit||Batch Error||We could not queue your request. Request payload size exceeds the data limit. Reduce the payload size and try again.|
|110210||GDPR||Contact Error||The contactKey is inactive, restricted, or suppressed. We could not process this contactKey.|
|110241||Retry Exhausted||Contact Error||Something went wrong. We could not process this contact event.|
This example request inserts a single contact into a journey.
You can insert up to 100 contacts into a journey at the same time by adding contacts to the
members array. This example request shows how to insert two contacts into a journey.
When the API successfully inserts a contact into the journey, the response includes the contact key and the instance ID for the contact insertion event. If the API can’t insert a contact into the journey, it returns an error. This example response shows the successful insertion of a contact and one that couldn’t be inserted.