SurveyTale API Docs

Uploads contacts in bulk. This endpoint expects the bulk request shape: `contacts` must be an array, and each contact item must contain an `attributes` array of `{ attributeKey, value }` objects. Unlike `POST /management/contacts`, this endpoint does not accept a top-level `attributes` object. Each contact must include an `email` attribute in its `attributes` array, and that email must be valid.

Authorization

apiKeyAuth

x-api-key<token>

Use your SurveyTale x-api-key to authenticate.

In: header

Request Body

application/json

The contacts to upload. Use the full nested bulk body shown in the example or cURL snippet: { workspaceId, contacts: [{ attributes: [{ attributeKey: { key, name }, value }] }] }. Each contact must include an email attribute inside its attributes array.

TypeScript Definitions

Use the request body type in TypeScript.

workspaceId*string

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

Formatcuid2

contacts*array<>

Itemsitems <= 250

Response Body

`application/json`

curl -X PUT "https://example.com/management/contacts/bulk" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "cm01h2xce9q8p3w4x5y6z7a8b9c0",    "contacts": [      {        "attributes": [          {            "attributeKey": {              "key": "email",              "name": "Email Address"            },            "value": "john.doe@example.com"          },          {            "attributeKey": {              "key": "firstName",              "name": "First Name"            },            "value": "John"          },          {            "attributeKey": {              "key": "lastName",              "name": "Last Name"            },            "value": "Doe"          }        ]      },      {        "attributes": [          {            "attributeKey": {              "key": "email",              "name": "Email Address"            },            "value": "jane.smith@example.com"          },          {            "attributeKey": {              "key": "firstName",              "name": "First Name"            },            "value": "Jane"          },          {            "attributeKey": {              "key": "lastName",              "name": "Last Name"            },            "value": "Smith"          }        ]      }    ]  }'

{
  "data": {
    "status": "string",
    "message": "string"
  }
}

{
  "data": {
    "status": "string",
    "message": "string",
    "skippedContacts": [
      {
        "index": 0,
        "userId": "string"
      }
    ]
  }
}

Upload Bulk Contacts

Authorization

Request Body

Response Body

200application/json

207application/json

`application/json`

`application/json`