Companies

Set one custom field on companies in bulk

Write one value (`custom_field_id` and exactly one value key) to up to 100 companies (`company_ids`) or one page of a frozen selection. A selection page is `{ selection_id, offset, limit? }` from `POS

POST /v2/companies/batch-set-custom-field

Parameters

Header parameters

Idempotency-Key

string required

Required. UUID per logical operation, reused on every retry. See apps/rest-api/src/shared/idempotency.ts for the full contract. Missing → 400 BadRequest; same key + different body → 409 Conflict.

Request body

Content-Type: application/json

company_ids

array<string (uuid)>

selection_id

string

Opaque token from POST /v2/companies/selections.

offset

integer

Position in the selection; next_offset of the previous page.

limit

integer

Page size, at most 100.

custom_field_id

string (uuid) required

text_value

string

date_value

string | null

array_value

array<string>

member_user_id

string

number_value

number | null

boolean_value

boolean | null

linked_contact_ids

array<string (uuid)>

linked_company_ids

array<string (uuid)>

mode

string enum

Possible values: "replace", "prepend", "append"

separator

string

Example

{
  "custom_field_id": "00000000-0000-0000-0000-000000000000"
}

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.affected

integer required

data.ids

array<string>

data.failed

array<object>

data.failed[].id

string

data.failed[].error

object

data.failed[].error.code

string

data.failed[].error.message

string

data.next_offset

integer | null

Offset of the next page; null after the last one.

data.total

integer

Companies in the selection.

Example

{
  "data": {
    "affected": 0
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

Code samples

curl https://api.prod.getdex.com/v2/companies/batch-set-custom-field \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || python3 -c 'import uuid;print(uuid.uuid4())')" \
  --header 'Content-Type: application/json' \
  --data '{
  "custom_field_id": "00000000-0000-0000-0000-000000000000"
}'

fetch('https://api.prod.getdex.com/v2/companies/batch-set-custom-field', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    custom_field_id: '00000000-0000-0000-0000-000000000000'
  })
})

import uuid

requests.post(
    "https://api.prod.getdex.com/v2/companies/batch-set-custom-field",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "custom_field_id": "00000000-0000-0000-0000-000000000000"
    }
)

Delete companies in bulk

Permanently delete up to 100 companies (`company_ids`), or one page of a frozen selection, and their logos. A selection page is `{ selection_id, offset, limit? }` from `POST /v2/companies/selections`,

Merge companies

Merge up to 50 source companies (`source_ids`) into `target_id`: contacts, roles, tags, custom field values and links, views, favorites, org chart members and saved view filters move to the target, an