Subscribers
Update subscriber
Used to update the subscriber entity with new information
PUT
/
v1
/
subscribers
/
{subscriberId}
Authorization
Path
Body
curl --request PUT \
--url https://api.novu.co/v1/subscribers/{subscriberId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json'
{
"data": {
"__v": "number",
"_environmentId": "string",
"_id": "string",
"_organizationId": "string",
"avatar": "string",
"channels": [
{
"_integrationId": "string",
"credentials": {
"channel": "string",
"deviceTokens": [
"string"
],
"webhookUrl": "string"
},
"integrationIdentifier": "string",
"providerId": "slack"
}
],
"createdAt": "string",
"deleted": "boolean",
"email": "string",
"firstName": "string",
"isOnline": "boolean",
"lastName": "string",
"lastOnlineAt": "string",
"locale": "string",
"phone": "string",
"subscriberId": "string",
"updatedAt": "string"
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Authorizations
Authorizationheaderrequired
string
Path Parameters
subscriberIdrequired
string
Body
application/json
avatar
string
data
object
email
string
firstName
string
lastName
string
locale
string
phone
string
Response
200 - application/json
data
object
Was this page helpful?
curl --request PUT \
--url https://api.novu.co/v1/subscribers/{subscriberId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json'
{
"data": {
"__v": "number",
"_environmentId": "string",
"_id": "string",
"_organizationId": "string",
"avatar": "string",
"channels": [
{
"_integrationId": "string",
"credentials": {
"channel": "string",
"deviceTokens": [
"string"
],
"webhookUrl": "string"
},
"integrationIdentifier": "string",
"providerId": "slack"
}
],
"createdAt": "string",
"deleted": "boolean",
"email": "string",
"firstName": "string",
"isOnline": "boolean",
"lastName": "string",
"lastOnlineAt": "string",
"locale": "string",
"phone": "string",
"subscriberId": "string",
"updatedAt": "string"
}
}