Skip to main content
PATCH
Modify a recipient

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Body

application/json
metadata
object

Recipient metadata. For Singapore (CIRCLE_SG) customers creating a self-hosted (ownership.custody.type = self_hosted) entry, email is required (validation error 2038).

Response

Successfully updated the address book recipient.

data
object

Recipient returned after a metadata update. The payload omits identity and ownership for all Circle entities.