Update Subscriber
Path parameters
idstringRequired
The Subscriber ID.
Body
recipientsall ofOptional
notestring | nullableOptional
Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
put
PUT /public/v1/notifications/subscribers/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 177
{
"recipients": {
"users": [
{
"id": "text",
"icon": "text",
"name": "text"
}
],
"userGroups": [
{
"id": "text",
"name": "text",
"description": "text",
"logo": "text",
"isDefault": true
}
]
},
"note": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2025-06-22T05:40:47.714Z",
"by": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
},
"updated": {
"at": "2025-06-22T05:40:47.714Z",
"by": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
},
"activated": {
"at": "2025-06-22T05:40:47.714Z",
"by": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
},
"disabled": {
"at": "2025-06-22T05:40:47.714Z",
"by": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
},
"deleted": {
"at": "2025-06-22T05:40:47.714Z",
"by": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"status": "text",
"note": "text",
"recipients": {
"users": [
{
"id": "text",
"audit": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-06-22T05:40:47.714Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
}
],
"userGroups": [
{
"id": "text",
"audit": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"account": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"modules": [
{
"id": "text",
"description": "text",
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
],
"obsolete": true,
"eligibility": {
"multi": true,
"single": true
}
}
}
],
"logo": "text",
"isDefault": true,
"users": [
{
"id": "text",
"icon": "text",
"name": "text"
}
],
"buyers": [
{
"id": "text",
"icon": "text",
"name": "text"
}
]
}
]
},
"account": {
"id": "text",
"audit": {
"created": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"updated": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "text",
"status": "text",
"serviceLevel": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"name": "text",
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
}
},
"category": {
"id": "text",
"audit": {
"created": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"updated": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"published": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"unpublished": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"deleted": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"description": "text",
"optOutAllowed": true,
"shortDescription": "text",
"status": "text",
"name": "text",
"note": "text",
"deleteAllowed": true,
"icon": "text",
"statistics": {
"month": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"sent": 1,
"total": 1
},
"today": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"sent": 1,
"total": 1
},
"week": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"sent": 1,
"total": 1
}
},
"lastUsed": "2025-06-22T05:40:47.714Z"
}
}Last updated
Was this helpful?