Skip to main content
POST
cURL

Creating Customers

This endpoint allows you to create customers.

Request Body

The request body should contain a customers array with the customer information you want to create. Each customer object in the array should include the following fields: You can use priority to control how the customers are picked during campaign runs. It is calculated in ascending order. Lower the value, higher the priority. 0 is the highest priority. In addition to the customers array, the request body can include the following top-level parameters:

Response Structure

The response includes the job ID. You can use this job ID to check the status of the job.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key
string
required
Minimum string length: 1
x-workspace-slug
string
required
x-workspace-id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
customers
object[]
required
strategy
enum<string>
default:insert
Available options:
upsert,
insert
partial
boolean
default:false

Response

Successful response

jobId
string