Notifly
API ReferenceSubscribers

Upsert provider credentials

Upsert credentials for a provider such as **slack** and **FCM**. **providerId** is required field. This API creates **deviceTokens** or appends to the existing ones.

PATCH
/v1/subscribers/{subscriberId}/credentials

Upsert credentials for a provider such as slack and FCM. providerId is required field. This API creates deviceTokens or appends to the existing ones.

Authorization

secretKey
Authorization<token>

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

In: header

Path Parameters

subscriberId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/subscribers/string/credentials" \  -H "Content-Type: application/json" \  -d '{    "providerId": "slack",    "credentials": {}  }'
{  "data": {    "_id": "string",    "firstName": "string",    "lastName": "string",    "email": "string",    "phone": "string",    "avatar": "string",    "locale": "string",    "channels": [      {        "providerId": "slack",        "integrationIdentifier": "string",        "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"        },        "_integrationId": "string"      }    ],    "topics": [      "string"    ],    "isOnline": true,    "lastOnlineAt": "string",    "__v": 0,    "data": {},    "timezone": "string",    "subscriberId": "string",    "_organizationId": "string",    "_environmentId": "string",    "deleted": true,    "createdAt": "string",    "updatedAt": "string"  }}

Bulk create subscribers POST

Using this endpoint multiple subscribers can be created at once. The bulk API is limited to 500 subscribers per request.

Update provider credentials PUT

Update credentials for a provider such as **slack** and **FCM**. **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.