Recipients

Add a contact to a recipient

Attaches one delivery address to a recipient. A recipient may hold at most one contact per type, so a repeated call answers 409 instead of creating a second row — a retry after a timeout never produces a duplicate, and the fix for a real conflict is to update the existing contact. Phone numbers are normalised to E.164 and enriched with a voice-cost zone on save, so the stored value can differ from the one sent. internal_sip goes through extension allocation rather than a plain insert: pass an existing free extension number, or "create_new" to have one allocated.

post/api/v1/recipients/{recipient}/contacts

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
  • Auth: API key in header X-API-Key

Path parameters

recipientstring uuid required

Recipient UUID.

Request body

contact_typestring required

Contact type slug: telegram, phone, email, internal_sip, slack, msteams, … A recipient may hold at most one contact per type.

contact_type_idinteger

Numeric contact type id, as used by the dashboard. Prefer contact_type — the numeric id is not exposed to API clients.

valuestring

The address itself: a Telegram handle, a phone number (normalised to E.164 on save), an email. May be empty only for externally bound types (slack, telegram_bot_chat_id, msteams). For internal_sip pass an existing free extension number, or "create_new" to have one allocated.

is_primaryboolean

Makes this the primary contact and clears the flag on every other contact of the recipient. Defaults to false.

labelstring nullable

Short human note shown next to the contact.

Example request

{
  "contact_type": "telegram"
}

Response

Contact created.

Example response

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

Changes

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