Recipients

Update a contact of a recipient (PATCH alias)

Identical to PUT on the same path — including the fact that value must be sent even when it is not what you are changing. The verb is the misleading part here: omitting value from a PATCH is not "leave the address alone" but "no address", which is a 422 for most contact types and an erased address for the externally-bound ones. Read the PUT description before using this.

patch/api/v1/recipients/{recipient}/contacts/{contact}

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/recipients/{recipient}/contacts/{contact}
  • Auth: API key in header X-API-Key

Path parameters

recipientstring uuid required

Recipient UUID.

contactstring uuid required

Contact UUID.

Request body

valuestring

The new address. Effectively required: an absent value is read as an empty one, which only the externally-bound types accept. Same emptiness rules as on create.

is_primaryboolean

Omit to leave the primary flag as it is. Sending true clears the flag on every other contact of the recipient.

labelstring nullable

Short human note. Omit to keep the stored one; send an empty string to drop it. Sending a label replaces the whole stored metadata object of the contact.

Response

Updated contact.

Example response

{
  "data": {
    "contact_type": "telegram"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.