Skip to navigation
API ReferenceRecipients

Update a recipient

View as Markdown
Update a recipient.

Authentication

x-api-keystring

Account API key used to authenticate server-side requests. Use the credentials issued for the same environment as the API base URL.

Path parameters

idstringRequired
Unique identifier of the resource.

Request

This endpoint expects an object.
namestringOptional<=120 characters
emailstring or nullOptionalformat: "email"<=180 characters

Send null to clear it.

phonestring or nullOptional<=32 characters

Send null to clear it.

Response

Recipient updated successfully.
messagestring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error