Skip to main content

PUT /preferences/:recipient_id

URL: https://api.courier.com/preferences/:recipient_id

Method: PUT

PATH PARAMS

recipient_idstringrequired
A unique identifier representing the recipient associated with the requested profile.

BODY PARAMS

notificationsrecord
json object that contains notification ids with the respective preferences
categoriesrecord
json object that contains category ids with the respective preferences
RESPONSES:

status: 200 OK

statusstring

status: 400 Bad Request

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.
Request Example
curl --request PUT \
--url https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6 \
--header 'Accept: application/json'
Responses Example
{
"status": "SUCCESS"
}
{
"message": "Error Message",
"type": "invalid_request_error"
}
Was this helpful?