Custom Fields

Create a custom_field

Changed on Nov 3, 2026

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

post/v1/custom_fields

Request

Base URL
https://api.slant.app
URL
https://api.slant.app/v1/custom_fields
Auth
HTTP bearer

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

Unique field key. Starts with a lowercase letter and contains lowercase letters, numbers, and underscores. Generated from display_name when omitted.

display_namestring required

Human-readable field name

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

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"
    ],
    "select_option_colors": {
      "Option 1": "blue",
      "Option 2": "green"
    }
  }
}

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

The entity type this field applies to

The field data type

company_idstring

The company ID

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"
    ]
  }
}

Changes

Nov 3, 2026173c41bf6be9 Revision changes
- breaking
  removed the enum value cross_reference of the request property
- warning
  removed the request property /
- warning
  added the new Business enum value to the response property for the response status
- warning
  added the new FinancialAccount enum value to the response property for the response status
- warning
  added the new InsurancePolicy enum value to the response property for the response status
- warning
  added the new Trust enum value to the response property for the response status
- warning
  added the new rich_text enum value to the response property for the response status
- warning
  added the new url enum value to the response property for the response status
- warning
  added the new user_reference enum value to the response property for the response status
- info
  added the new optional request property /
- info
  the request property became optional
- info
  added the new Business enum value to the request property
- info
  added the new FinancialAccount enum value to the request property
- info
  added the new InsurancePolicy enum value to the request property
- info
  added the new Trust enum value to the request property
- info
  added the new rich_text enum value to the request property
- info
  added the new url enum value to the request property
- info
  added the media type application/json for the response with the status
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status
- info
  removed the invalid_json enum value from the response property for the response status
- info
  response property detail list-of-types was narrowed by removing types array from media type application/json of response 400

Operation history