Recipients

Update a contact of a recipient

Changes the address, the primary flag or the label of one contact. is_primary and label keep their stored value when omitted; value does NOT — always send it. Omitting value is read as "no address", which answers 422 for every type that needs one and clears the address for the externally-bound types (slack, telegram_bot_chat_id, msteams). The contact type cannot be changed here — switching channel means deleting this contact and adding another. Unlike create, the value is NOT re-normalised to E.164: send phone numbers already in E.164. Changing the value of an internal_sip contact re-allocates the extension and the contact is recreated, so the returned uuid differs from the one in the path — re-read it from the response. PATCH is accepted on the same path with identical semantics.

put/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, as returned by GET /recipients/{recipient}.

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.