Sign in

v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
Custom Fields

Create a custom_field

Create a new custom field. book_id is accepted for backwards compatibility but ignored.

post/v1/custom_fields

Headers

Idempotency-Keystring

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Request body

book_idstring

Deprecated. Ignored.

field_keystring required

Unique field key (lowercase, letters, numbers, underscores only)

display_namestring required

Human-readable field name

entity_type'Household' | 'Person' | 'Contact' | 'Opportunity' required

Entity type this field applies to (Client and Prospect normalize to Household)

field_type'text' | 'number' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'cross_reference' required

Data type of the field

Example request

{
  "book_id": "abc123xyz",
  "field_key": "pageport_lead_source",
  "display_name": "Lead Source",
  "entity_type": "Household",
  "field_type": "text",
  "options": {
    "select_options": [
      "Option 1",
      "Option 2",
      "Option 3"
    ],
    "cross_reference_allowed_target_types": [
      "Household",
      "Contact"
    ]
  }
}

Response

custom_field created

idstring required

The custom field ID

field_keystring required

The unique field key

display_namestring required

The human-readable field name

entity_type'Household' | 'Person' | 'Contact' | 'Opportunity' required

The entity type this field applies to

field_type'text' | 'number' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'cross_reference' required

The field data type

Example response

{
  "id": "abc123xyz",
  "field_key": "pageport_lead_source",
  "display_name": "Lead Source",
  "entity_type": "Household",
  "field_type": "text",
  "options": {
    "select_options": [
      "Option 1",
      "Option 2"
    ],
    "cross_reference_allowed_target_types": [
      "Household",
      "Contact"
    ]
  }
}