Add a contact

POST

/api/v1/contacts

curl --request POST \
  --url https://digize.com/api/v1/contacts \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "firstName": "Maya", "lastName": "Chen", "email": "maya@northloop.example", "phone": "+15125550142", "city": "Austin", "tags": [ "wholesale", "newsletter" ] }'

• Digize

Adds a contact. Needs a name, an email or a phone number, and a value for each required custom field. Fails with conflict when the duplicate rule in CRM settings matches someone already there; update that contact instead.

Needs the crm:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

firstName

string

<= 80 characters

lastName

string

<= 80 characters

email

Any of:

string

string

<= 254 characters

null

null

phone

Any of:

string

string

<= 40 characters

null

null

city

Any of:

string

string

<= 100 characters

null

null

companyId

Any of:

string

string

>= 1 characters <= 64 characters

null

null

ownerId

Any of:

string

string

>= 1 characters <= 64 characters

null

null

tags

Replaces the contact’s tags.

Array<string>

<= 50 items

custom

Values by field key; null clears one. Money is in minor units, dates like 2026-01-31.

object

key

additional properties

Any of:

unknown

Any of:

string

string

number

number

boolean

boolean

Array<string>

Array<string>

null

null

id

string

>= 1 characters <= 64 characters

Example

{
  "firstName": "Maya",
  "lastName": "Chen",
  "email": "maya@northloop.example",
  "phone": "+15125550142",
  "city": "Austin",
  "tags": [
    "wholesale",
    "newsletter"
  ]
}

Responses

200

Done

Media typeapplication/json

object

id

required

string

firstName

required

string

lastName

required

string

name

required

string

email

required

string | null

phone

required

In E.164, such as +15125550142.

string | null

city

required

string | null

companyId

required

string | null

companyName

required

string | null

ownerId

required

The member who looks after them, by user id.

string | null

source

required

string

Allowed values: checkout form booking import manual message

tags

required

Array<string>

stage

required

Lead: hasn’t ordered; customer: one or two orders; repeat: three or more.

string

Allowed values: lead customer repeat

orders

required

number

lifetimeValue

required

What they’ve paid, less refunds, in minor units.

number

lastOrderAt

required

Any of:

string

string format: date-time

null

null

lastActivityAt

required

string format: date-time

custom

required

Custom field values by field key.

object

key

additional properties

Any of:

string

string

number

number

boolean

boolean

Array<string>

Array<string>

createdAt

required

string format: date-time

Example

{
  "source": "checkout",
  "stage": "lead"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}