PEperiskope
contacts

Update Contact

This endpoint updates properties of a contact

patch/contacts/{contact_id}

Request

  • Base URL
    https://api.periskope.app/v1
  • URL
    https://api.periskope.app/v1/contacts/{contact_id}
  • Auth
    HTTP bearer

Request body

contact_namestring

Update the contact name. Note that this name will only be updated on Periskope (not on the phone)

is_internalboolean

Mark the contact as internal. Messages from internal contacts are not flagged

labelsstring
  • A comma-separated list of labels to be assigned to the contacts. All labels are case-insensitive.
  • If any label currently does not exist, it will be created

Example request

{
  "contact_name": "BK Local1",
  "labels": "label1,label2"
}

Response

200 OK

object required

The response is a contact object. Refer to the contact object here

Changes

No recorded changes to this operation across all 2 revisions of this API.