The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

POST /interaction/v1/async/events

Create an entry event that asynchronously inserts a batch of subscribers into a journey.

Up to 10 journeys can use the same Event Definition Key to insert subscribers.

Event Definition Keys can be mapped only to API Event journey entry sources. You can't use keys that are mapped to Wait Until API Event flow control activities.

NameTypeDescription
eventDefinitionKeystringRequired. The key for the entry event. After you create and save the event, you can find the eventDefinitionKey in Journey Builder Event Administration.
membersarrayRequired. 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.contactKeystringRequired. The unique ID of a subscriber or a contact. You can include the same contactKey multiple times in the same request.
members.dataobjectAn object that contains metadata for each contact, such as personalization attributes.
NameTypeDescription
requestIdstringThe unique identifier of the batch request. You can use this ID to check the status of the batch.
countnumberThe number of member objects in the request.
notQueuedCountnumberThe number of member objects that couldn’t be queued.
membersarrayAn array of contact objects. The API returns the list members in the same order that it received them.
members.contactKeystringThe unique ID of a subscriber or a contact. The response can include the same contactKey multiple times in the same request.
members.eventInstanceIdstringThe unique identifier for the batch member. You can use this ID to check the status of an individual contact.
members.errorcodestringAn error code. The response only includes this property if there was an error in processing an event instance.
members.messagestringAn error message associated with the error code. The response only includes this property if there was an error in processing an event instance.
Error CodeScenarioTypeMessage
10000Interaction Count Limit ExceededBatch ErrorWe could not queue your request. The eventDefinitionKey is shared by too many journeys. Create a new eventDefinitionKey, then try again.
10000Entry Event ViolationBatch ErrorWe could not queue your request. Remove the eventDefinitionKey from journey activities that are not an entry source, then try again.
10000Request Size Exceeds LimitBatch ErrorWe could not queue your request. Request payload size exceeds the data limit. Reduce the payload size and try again.
110210GDPRContact ErrorThe contactKey is inactive, restricted, or suppressed. We could not process this contactKey.
110241Retry ExhaustedContact ErrorSomething 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.