Custom fields

Extra fields of leads, contacts and listings: types, choices, required, per-role visibility.

GET/v1/custom-fields

Custom field definitions

Every definition of an entity in order, switched-off ones included, with the roles to pick from.

Access: Signed-in members only (web or Android session) — not for API keys.

Parameters

entityqueryrequired: CustomFieldEntity

Response · 200

datarequired: array of CustomFieldAdmin
metarequired: object
meta.rolesrequired: array of object
meta.roles[].idrequired: Id
Opaque record id.
meta.roles[].namerequired: string
meta.reserved_keysrequired: array of string
Keys the built-in fields use.
meta.can_editrequired: boolean

Request

curl -X GET 'https://api.propzolo.com/v1/custom-fields' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "entity": "string",
      "key": "string",
      "label": "string",
      "type": "string",
      "choices": [
        {
          "value": "string",
          "label": "string"
        }
      ],
      "is_required": true,
      "section": "string",
      "help_text": "string",
      "sort_order": 0,
      "visible_to": [
        "string"
      ],
      "editable_by": [
        "string"
      ],
      "is_active": true,
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "roles": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "reserved_keys": [
      "string"
    ],
    "can_edit": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/custom-fields

Add a custom field

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Request body

entityrequired: CustomFieldEntity
labelrequired: string
key: string or null
Stable key; derived from the label when absent.
typerequired: CustomFieldKind
choices: array of CustomFieldChoice
is_required: boolean
section: string or null
help_text: string or null
visible_to: array of Id
Opaque record id.
editable_by: array of Id
Opaque record id.

Response · 201

datarequired: CustomFieldAdmin
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/custom-fields' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entity":"lead","label":"string","key":"string","type":"text","choices":[{"value":"string","label":"string"}],"is_required":true,"section":"string","help_text":"string","visible_to":["cmusrceel0000q7kaafxqi1om"],"editable_by":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "entity": "string",
    "key": "string",
    "label": "string",
    "type": "string",
    "choices": [
      {
        "value": "string",
        "label": "string"
      }
    ],
    "is_required": true,
    "section": "string",
    "help_text": "string",
    "sort_order": 0,
    "visible_to": [
      "string"
    ],
    "editable_by": [
      "string"
    ],
    "is_active": true,
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/custom-fields/reorder

Reorder custom fields

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Request body

entityrequired: CustomFieldEntity
idsrequired: array of Id
Opaque record id.

Response · 200

datarequired: array of CustomFieldAdmin
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/custom-fields/reorder' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entity":"lead","ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "entity": "string",
      "key": "string",
      "label": "string",
      "type": "string",
      "choices": [
        {
          "value": "string",
          "label": "string"
        }
      ],
      "is_required": true,
      "section": "string",
      "help_text": "string",
      "sort_order": 0,
      "visible_to": [
        "string"
      ],
      "editable_by": [
        "string"
      ],
      "is_active": true,
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/custom-fields/{id}

Change a custom field

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Parameters

idpathrequired: Id
Opaque record id.

Request body

label: string
choices: array of CustomFieldChoice
is_required: boolean
section: string or null
help_text: string or null
visible_to: array of Id
Opaque record id.
editable_by: array of Id
Opaque record id.
is_active: boolean

Response · 200

datarequired: CustomFieldAdmin
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/custom-fields/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"label":"string","choices":[{"value":"string","label":"string"}],"is_required":true,"section":"string","help_text":"string","visible_to":["cmusrceel0000q7kaafxqi1om"],"editable_by":["cmusrceel0000q7kaafxqi1om"],"is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "entity": "string",
    "key": "string",
    "label": "string",
    "type": "string",
    "choices": [
      {
        "value": "string",
        "label": "string"
      }
    ],
    "is_required": true,
    "section": "string",
    "help_text": "string",
    "sort_order": 0,
    "visible_to": [
      "string"
    ],
    "editable_by": [
      "string"
    ],
    "is_active": true,
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/custom-fields/{id}

Delete a custom field

Only a field no record has a value for (409 otherwise — switch it off instead).

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/custom-fields/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "entity": "string", "key": "string", "label": "string", "type": "string", "choices": [ { "value": "string", "label": "string" } ], "is_required": true, "section": "string", "help_text": "string", "sort_order": 0, "visible_to": [ "string" ], "editable_by": [ "string" ], "is_active": true, "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": { "roles": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "reserved_keys": [ "string" ], "can_edit": true } }

curl -X POST 'https://api.propzolo.com/v1/custom-fields' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"entity":"lead","label":"string","key":"string","type":"text","choices":[{"value":"string","label":"string"}],"is_required":true,"section":"string","help_text":"string","visible_to":["cmusrceel0000q7kaafxqi1om"],"editable_by":["cmusrceel0000q7kaafxqi1om"]}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "entity": "string", "key": "string", "label": "string", "type": "string", "choices": [ { "value": "string", "label": "string" } ], "is_required": true, "section": "string", "help_text": "string", "sort_order": 0, "visible_to": [ "string" ], "editable_by": [ "string" ], "is_active": true, "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/custom-fields/reorder' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"entity":"lead","ids":["cmusrceel0000q7kaafxqi1om"]}'

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "entity": "string", "key": "string", "label": "string", "type": "string", "choices": [ { "value": "string", "label": "string" } ], "is_required": true, "section": "string", "help_text": "string", "sort_order": 0, "visible_to": [ "string" ], "editable_by": [ "string" ], "is_active": true, "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/custom-fields/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"label":"string","choices":[{"value":"string","label":"string"}],"is_required":true,"section":"string","help_text":"string","visible_to":["cmusrceel0000q7kaafxqi1om"],"editable_by":["cmusrceel0000q7kaafxqi1om"],"is_active":true}'

DELETE/v1/custom-fields/{id}

Delete a custom field

Only a field no record has a value for (409 otherwise — switch it off instead).

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/custom-fields/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.