Send property values in the correct format

Use the property’s type and format to construct record values. Before sending data, inspect the target object’s schema and its supported value shapes. A label shown in the UI is not necessarily the internal value an API accepts.

How to submit values by property type and format

When you submit values, the backend validates by property type and uses property format for parsing/formatting behavior. The key is always the property name of the property, and the value shape must match the type.

Common type rules from backend validation:

• string: send a string
• number: send a numeric value (for example 120000 or "120000")
• date: send unix timestamp milliseconds in UTC (preferred). ISO date/date-time inputs are also accepted by date parsing and normalized
• checkbox: send true/false (or string "true"/"false")
• single-select: send one option name exactly as configured
• multi-select: send option names as one semicolon-separated string or as an array of the names
• tag: send tags as one semicolon-separated string or as an array of the names
• range: send "min;max" (both numeric)
• structure: send a valid JSON string (not a raw nested JSON object)
• file: send a file key string (needs to be under your company files path)
• linked-property: do not send a value (backend rejects manual values since they’re read only and managed on the related records)

Example payload covering multiple types:

{
  "properties": {
    "firstname": "Jane Doe",
    "salary": 4200,
    "start_date": 1742851200000,
    "available_remote": true,
    "application_status": "in_progress",
    "skills": "java;spring;neo4j",
    "labels": "high_priority;backend",
    "salary_range": "3500;5000",
    "profile_data": "{\"github\":\"janedoe\",\"years_experience\":6}",
    "resume_file": "COMPANY_UUID/files/candidates/jane-doe-cv.pdf"
  }
}

Type vs format (important distinction)

• Type controls what value shape is valid.
• Format controls how that value is interpreted or displayed.

Example: a string property may accept multiple string input styles, but the normalized stored value is still validated as a string type value.

Submission checklist before calling create/update

• Confirm property name keys match the object schema exactly.
• Confirm select values exist in property options.
• For multi-select, tag, and range, use semicolon delimiters or arrays with names of the options.
• For structure, serialize to a JSON string first.
• Do not send values for linked-property fields.

The write request and its response are explained in create and update records. Read the response and handle validation errors before retrying an integration.