Subscribers

Create a subscriber

Create a subscriber with the subscriber attributes. subscriberId is a required field, rest other fields are optional, if the subscriber already exists, it will be updated

post/v2/subscribers

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v2/subscribers
  • Auth: API key in header Authorization

Query parameters

failIfExistsboolean

If true, the request will fail if a subscriber with the same subscriberId already exists

Request body

firstNamestring nullable

First name of the subscriber

lastNamestring nullable

Last name of the subscriber

emailstring nullable

Email address of the subscriber

phonestring nullable

Phone number of the subscriber

avatarstring nullable

Avatar URL or identifier

localestring nullable

Locale of the subscriber

timezonestring nullable

Timezone of the subscriber

dataobject nullable

Additional custom data associated with the subscriber

subscriberIdstring required

Unique identifier of the subscriber

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "avatar": "https://example.com/avatar.jpg",
  "locale": "en-US",
  "timezone": "America/New_York"
}

Response

Created

Example response

{
  "data": {
    "channels": [
      {
        "credentials": {
          "webhookUrl": "https://example.com/webhook",
          "channel": "general",
          "deviceTokens": [
            "token1",
            "token2",
            "token3"
          ],
          "alertUid": "12345-abcde",
          "title": "Critical Alert",
          "imageUrl": "https://example.com/image.png",
          "state": "resolved",
          "externalUrl": "https://example.com/details"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.