Skip to main content
POST
/
api
/
objects
/
{objectType}
/
batch
Batch create or update objects
curl --request POST \
  --url https://app.useitem.io/api/objects/{objectType}/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "objects": [
    {
      "name": "Alex Johnson",
      "match_by": "email",
      "match_value": "alex@acme.com",
      "fields": {
        "email": "alex@acme.com",
        "role": "Senior Engineer",
        "custom_score": 95
      }
    },
    {
      "name": "Acme Corp",
      "match_by": "id",
      "match_value": 456,
      "fields": {
        "website_url": "https://acme.com",
        "industry": "Technology"
      }
    },
    {
      "name": "New Contact",
      "fields": {
        "email": "new@example.com",
        "role": "Designer"
      }
    }
  ]
}
'
{
  "results": [
    {
      "id": 123,
      "status": "updated"
    },
    {
      "id": 456,
      "status": "updated"
    },
    {
      "id": 789,
      "status": "created"
    }
  ],
  "summary": {
    "total": 3,
    "created": 1,
    "updated": 2,
    "failed": 0
  }
}

Authorizations

​
x-api-key
string
header
required

Your organization's API key (starts with sk_live_)

Path Parameters

​
objectType
string
required

The object type slug. Use contacts for People, companies for Companies, or the slug of a Custom Object (e.g., deals, tickets).

Singular forms (contact, company) are also accepted.

Body

application/json
​
objects
object[]
required

Response

Batch processed

​
results
object[]
​
summary
object