v1

latestOpenAPI 3.0.22026-07-261040577.4 KB
Contacts

Create contact

Create a new contact in your workspace's contacts database. Provide a name and email, and optionally attach custom field data (e.g. a Salesforce ID or company name).

Contacts can later be linked to data entries and highlights within Dovetail to track which research insights came from which participants.

Returns the newly created contact object.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

post/v1/contacts

Request body

namestring required

The contact’s name.

emailstring email required

The contact’s email.

Example request

{
  "name": "John Smith",
  "email": "john@dovetail.com",
  "fields": [
    {
      "label": "salesforce_id",
      "value": "003XX000004TmiQQAS"
    }
  ]
}

Response

201