Skip to main content
POST
Create Custom Field

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Body

type
string
required
Allowed value: "text"
label
string
required
name
string

Response

The created custom field.

The created custom field.

type
string
required
Allowed value: "text"
id
string
required
label
string
required
name
string | null
required
key
string | null
required

The upstream's own identifier for the field, exactly as the upstream spells it, and the key its values have in a person's customFields object. null when the connector's people still carry custom fields as custom<Name> properties.

originalIds
object
required
original
object
required