Salesforce Docs Portal

POST /interaction/v1/async/events

Enter a batch of subscribers into a journey or release a batch of subscribers from a wait event asynchronously.

JSON Parameters

Name Type Description
eventDefinitionKey String Required. The key for the entry event. After you create and save the event, you can find this key in Journey Builder Event Administration. You can map event definition keys to the API Entry Event or to the Wait Until API Event. Up to 10 journeys can use the same event definition key to insert subscribers.
members Array Required. An array that contains information about the subscribers that the request targets. You can target 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.

Responses

Name Type Description
requestId String The unique identifier of the batch request. You can use this ID to check the status of the batch.
count Integer The number of member objects in the request.
notQueuedCount Integer 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.

Error Codes

<!-- Acrolinx note: the values in the Message column are verbatim responses from the API. Don't let Acrolinx add contractions. -->
Error Code Scenario Type Message
10000 Interaction Count Limit Exceeded Batch Error We couldn't 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 couldn't queue your request. Remove the eventDefinitionKey from journey activities that aren't an entry source, then try again.
10000 Request Size Exceeds Limit Batch Error We couldn't 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 couldn't process this contactKey.
110241 Retry Exhausted Contact Error Something went wrong. We couldn't process this contact event.

Usage

This example request inserts a single contact into a journey.

{
  "eventDefinitionKey": "2FA_order_accounts",
  "members": [
    {
      "contactKey": "recipient1",
      "data": {
        "RequestAttribute_1": "value_1",
        "RequestAttribute_2": "value_2"
      }
    }
  ]
}

You can process up to 100 contacts at a time by adding contacts to the members array. This sample request processes two contacts.

{
  "eventDefinitionKey": "2FA_order_accounts",
  "members": [
    {
      "contactKey": "recipient1",
      "data": {
        "RequestAttribute_1": "value_1",
        "RequestAttribute_2": "value_2"
      }
    },
    {
      "contactKey": "recipient2",
      "data": {
        "RequestAttribute_1": "value_3",
        "RequestAttribute_2": "value_4"
      }
    }
  ]
}

When the API successfully processes contact, the response includes the contact key and an instance ID.

This example response shows the successful insertion of a contact and one that couldn’t be inserted.

<!-- The IDs in this example are randomly generated and don’t constitute a security risk. --> 
{
  "requestId": "67a843c9-c72d-4c74-8fe3-d05c0f39df34",
  "count": 2,
  "notQueuedCount": 1,
  "members": [
    {
      "contactKey": "5b78e18e-9249-4392-a18f-da46b7198015",
      "eventInstanceId": "56277a0a-2781-4730-bdfa-7e2f91e33b9d"
    },
    {
      "contactKey": "acc4935f-327a-4d51-bd39-f42071009c54",
      "eventInstanceId": "0b06685d-ada0-474b-86f9-2630a75537eb",
      "errorcode": "100002",
      "message": "Something's not right. We couldn't process your request."
    }
  ]
}