Bulk create subscribers

Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API. The bulk API is limited to 500 subscribers per request.

POST/v1/subscribers/bulk

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

In: header

Request Body

application/jsonRequired

subscribersRequiredarray<object>

An array of subscribers to be created in bulk.

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X POST "https://api.novu.co/v1/subscribers/bulk" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "subscribers": [
      {
        "subscriberId": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "avatar": "string",
        "timezone": "string",
        "locale": "string",
        "data": {}
      }
    ]
  }'

Created

{
  "updated": [
    {
      "subscriberId": "string"
    }
  ],
  "created": [
    {
      "subscriberId": "string"
    }
  ],
  "failed": [
    {
      "message": "string",
      "subscriberId": "string"
    }
  ]
}

Authorization

Request Body

Header Parameters

Response

TypeScript