POST /api/v2/contacts

Creates a new contact. Added on Mar 2, 2020 for API v2.

Rate limit: 100 per minute.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
job_title String No

[single-line only]

The contact's job title.

last_name String Yes

[single-line only]

The contact's last name.

phones[] Array No

The contact's phone numbers.

The phone number must be in e164 format. The first number in the list is the contact's primary phone.

company_name String No

[single-line only]

The contact's company name.

first_name String Yes

[single-line only]

The contact's first name.

extension String No

The contact's extension number.

emails[] Array No

The contact's emails.

The first email in the list is the contact's primary email.

trunk_group String No

[Deprecated]

owner_id String No

The id of the user who will own this contact.

If provided, a local contact will be created for this user. Otherwise, the contact will be created as a shared contact in your company.

urls[] Array No

A list of websites associated with or belonging to this contact.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.