Skip to main content
POST
/
v1
/
subscribers
/
bulk
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();

$bulkSubscriberCreateDto = new Components\BulkSubscriberCreateDto(
    subscribers: [
        new Components\CreateSubscriberRequestDto(
            subscriberId: '<id>',
        ),
    ],
);

$response = $sdk->subscribers->createBulk(
    bulkSubscriberCreateDto: $bulkSubscriberCreateDto
);

if ($response->bulkCreateSubscriberResponseDto !== null) {
    // handle response
}
{
  "updated": [
    {
      "subscriberId": "<string>"
    }
  ],
  "created": [
    {
      "subscriberId": "<string>"
    }
  ],
  "failed": [
    {
      "message": "<string>",
      "subscriberId": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
idempotency-key
string

A header for idempotency purposes

Body

application/json
​
subscribers
object[]
required

An array of subscribers to be created in bulk.

Response

Created

​
updated
object[]
required

An array of subscribers that were successfully updated.

​
created
object[]
required

An array of subscribers that were successfully created.

​
failed
object[]
required

An array of failed operations with error messages and optional subscriber IDs.