Contacts

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.

Required scope: contact:write

post/v1/contacts

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/contacts
  • Auth
    HTTP bearer

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

Changes

    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status