SurveyTale API Docs

Creates a single contact in the database. This endpoint expects a top-level `attributes` object. For bulk uploads, use `PUT /management/contacts/bulk`, which expects `contacts[].attributes[]` instead. Each contact must have a valid email address in the attributes. All attribute keys must already exist in the environment. The email is used as the unique identifier along with the environment.

Authorization

apiKeyAuth

x-api-key<token>

Use your SurveyTale x-api-key to authenticate.

In: header

Request Body

application/json

The single contact to create. Must include a top-level attributes object with an email attribute, and all attribute keys must already exist in the environment.

TypeScript Definitions

Use the request body type in TypeScript.

workspaceId*string

Match^[0-9a-z]+$

Formatcuid2

attributes*

Response Body

`application/json`

curl -X POST "https://example.com/management/contacts" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "cm01h2xce9q8p3w4x5y6z7a8b9c0",    "attributes": {      "email": "john.doe@example.com",      "firstName": "John",      "lastName": "Doe",      "userId": "h2xce9q8p3w4x5y6z7a8b9c1"    }  }'

{
  "id": "ctc_01h2xce9q8p3w4x5y6z7a8b9c2",
  "createdAt": "2023-01-01T12:00:00.000Z",
  "workspaceId": "cm01h2xce9q8p3w4x5y6z7a8b9c0",
  "attributes": {
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "userId": "h2xce9q8p3w4x5y6z7a8b9c1"
  }
}

Create a contact

Authorization

Request Body

Response Body

201application/json

`application/json`