Subscribers

Trigger multiple events for subscriber

Changed on

Triggers multiple events for a subscriber. Creates the subscriber if they don't exist and applies the workspace default lists setting. Creates event definitions if they don't exist. Events are processed independently, so an error response may still include events that were already triggered. When the workspace has double opt-in enabled, a brand-new subscriber is created pending confirmation, a single confirmation email is queued for the request, and matching sequences wait at their trigger until the subscriber confirms.

post/subscribers/events/bulk

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/subscribers/events/bulk
  • Auth
    HTTP bearer

Request body

emailstring email

Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.

externalIdstring

Customer-owned app/customer/user ID

firstNamestring

First name to set if creating the subscriber.

lastNamestring

Last name to set if creating the subscriber.

customAttributesobject

Example request

{
  "email": "user@example.com",
  "externalId": "user_123",
  "firstName": "John",
  "lastName": "Doe",
  "events": [
    {
      "name": "page.viewed",
      "properties": {
        "page": "/pricing"
      },
      "occurredAt": "2024-11-02T10:00:00Z",
      "eventId": "inv_9182"
    }
  ]
}

Response

Events triggered successfully

successboolean

Example response

{
  "success": true,
  "events": [
    {
      "duplicate": true
    }
  ]
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status