PEperiskope
contacts

Create Contact

This endpoint creates a new contact.

post/contacts/create

Request

  • Base URL
    https://api.periskope.app/v1
  • URL
    https://api.periskope.app/v1/contacts/create
  • Auth
    HTTP bearer

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

contact_namestring required
  • Name of the new contact
contact_idstring required
  • The unique identifier of the contact Must be formatted as country_code + number (e.g., 919537851844).
  • Do not include special characters
labelsstring
  • A comma-separated list of labels to be assigned to the chats. All labels are case-insensitive.
  • If any label currently does not exist, it will be created
is_internalboolean
  • Indicates if the member is an internal user of the organization.

Example request

{
  "contact_name": "Test New 1040",
  "contact_id": "919537851844",
  "labels": "Test, Demo",
  "is_internal": true
}

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.