Automations · Contacts

Bulk create contacts

Creates contacts in bulk.

POSThttps://api.pozy.ai/v1/contacts/bulk
bulkCreateContacts

Guide: Contacts

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the contacts resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • profileIdstringrequired
  • accountIdstring
  • platformstring
  • contactsarray of objectrequired

    Up to 1000 items.

    • namestringrequired
    • platformIdentifierstring
    • displayIdentifierstring
    • emailstring
    • companystring
    • tagsarray of string

Example

curl -X POST "https://api.pozy.ai/v1/contacts/bulk" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "profileId": "6a0b6573846efc28aaa9a3ff",
  "contacts": [
    {
      "name": "Acme"
    }
  ]
}'

Response

200 on success

  • successboolean
  • createdinteger
  • skippedinteger
  • errorsarray of string
  • totalinteger
200 response
{
  "success": true,
  "created": 1,
  "skipped": 1,
  "errors": [
    "string"
  ],
  "total": 42
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Contacts