v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-012366102.8 KB

Custom Fields

Create Custom Field

Creates a new custom field that can be used in user journeys or forms.

post/api/v2/custom_fields

Request body

transition_type'pre_offer' | 'offer' | 'post_offer' | 'onboarding' | 'offboarding' required

namestring required

keystring required

data_typestring required

mandatoryboolean required

mappingstring

validation_rulestring

regexp_patternstring

Required if validation_rule is regexp

allowed_valuesstring[] required

Required if validation_rule is list

list_of_values_map_idstring required

Required if validation_rule is list_of_values_map

created_atstring required

deactivatedboolean

rule_settableboolean

Used in Assignment Rules

placeholderableboolean

Used in placeholders

allowed_rule_set_typesstring[] required

allowed_placeholder_typestring[] required

workday_organization_typestring

Required if validation_rule is workday_organization

Example request

{
  "transition_type": "pre_offer",
  "name": "Start date",
  "key": "1234",
  "data_type": "Datetime",
  "mapping": "salutation, nickname, title, university, current_location, employee_id, profile_photo_url, division, hire_type, company_code, relocation_type, job_profile_id",
  "validation_rule": "regexp, list_of_values_map, list, previous_date_time, future_date_time, workday_job_profile, workday_organization",
  "regexp_pattern": "^[a-zA-Z0-9]+$",
  "allowed_values": [
    "a",
    "b",
    "c"
  ],
  "list_of_values_map_id": "LegalEntityLOV - refer to References API for more details",
  "created_at": "2025-01-01",
  "allowed_rule_set_types": [
    "journey",
    "module",
    "child_module",
    "task",
    "communication",
    "report"
  ],
  "allowed_placeholder_type": [
    "journey",
    "communication",
    "html_editor_task"
  ],
  "workday_organization_type": "Supervisory, Pay_Group, Cost_Center, Company, Cost_Center_Hierarchy, Location_Hierarchy, External_Payroll_Company, Company_Hierarchy"
}

Response

The request has succeeded and a new resource has been created as a result.

idstring uuid required