Skip to main content
PATCH
/
recipients
/
{id}
cURL
curl --request PATCH \
  --url https://sandbox.onconsul.com/v1/recipients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "email": "jsmith@example.com",
  "id": "<string>",
  "on_platform": true,
  "nickname": "<string>"
}
Update a recipient’s nickname. The nickname is a display label visible only to your app.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
nickname
string
Maximum string length: 255

Response

OK

​
created_at
string<date-time>
required
​
display_name
string
required
​
email
string<email>
required
​
id
string
required
​
on_platform
boolean
required
​
nickname
string