Contacts

Update a contact

Requires contacts:m.

patch/v1/contacts/{id}

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/contacts/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Request body

phone_numberstring nullable

E.164, or null to clear (refused with 409 CONTACT_IN_USE while the contact is in a group or list, and with 422 when the contact would be left with neither identifier).

emailstring email nullable
namestring nullable
notesstring nullable

Response

The updated contact.

idstring required
phone_numberstring nullable required

E.164; null for an email-only contact. Only contacts with a phone can join groups and lists.

emailstring nullable required

Lower-cased; null for a phone-only contact. At least one of phone_number and email is set.

namestring nullable required
notesstring nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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