PUT
/
v1
/
subscribers
/
{subscriberId}
/
credentials
curl --request PUT \
  --url https://api.novu.co/v1/subscribers/{subscriberId}/credentials \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "integrationIdentifier": "<string>",
  "credentials": {
    "webhookUrl": "<string>",
    "channel": "<string>",
    "deviceTokens": [
      "<string>"
    ],
    "alertUid": "<string>",
    "title": "<string>",
    "imageUrl": "<string>",
    "state": "<string>",
    "externalUrl": "<string>"
  }
}'
{
  "data": {
    "_id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "avatar": "<string>",
    "locale": "<string>",
    "subscriberId": "<string>",
    "channels": [
      {
        "integrationIdentifier": "<string>",
        "credentials": {
          "webhookUrl": "<string>",
          "channel": "<string>",
          "deviceTokens": [
            "<string>"
          ],
          "alertUid": "<string>",
          "title": "<string>",
          "imageUrl": "<string>",
          "state": "<string>",
          "externalUrl": "<string>"
        },
        "_integrationId": "<string>"
      }
    ],
    "isOnline": true,
    "lastOnlineAt": "<string>",
    "_organizationId": "<string>",
    "_environmentId": "<string>",
    "deleted": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "__v": 123
  }
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization
string
headerrequired

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

Path Parameters

subscriberId
string
required

Body

application/json
providerId
enum<number>
required

The provider identifier for the credentials

integrationIdentifier
string

The integration identifier

credentials
object
required

Credentials payload for the specified provider

Response

200 - application/json
data
object

Was this page helpful?

Delete subscriberDelete subscriber credentials by providerId