Skip to main content
POST
Bulk Customers

Authorizations

Authorization
string
header
required

Your API key. Create one under Setup → Developer API Keys and select the permissions this endpoint needs.

Scopes

contacts:write

Body

application/json
ids
integer[]
required

The customer IDs, up to 500.

Required array length: 1 - 500 elements

Must reference an existing contacts record.

action
enum<string>
required

What to do. See the table above.

Available options:
delete,
change_status,
change_type,
activate,
deactivate
contact_status_id
integer | null

Required when action is change_status.

type
enum<string> | null

Required when action is change_type: lead, customer or guest.

Available options:
guest,
lead,
customer

Response

200 OK

data
object