Skip to main content
POST
Create Custom Field Mapping

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
custom_field_id
string<uuid>
required

ID of the custom field to be mapped.

Example:

"018e586b-7d0b-7bc9-be65-a8fdbc82d734"

json_path
string
required

JMESPath expression to extract the value from the upstream payload.

Maximum string length: 1024
Pattern: \S.*\S
integration_slug
string | null

Integration slug — set this for an organization-scoped mapping (applies to all connectors of this integration in the org). Mutually exclusive with connector_token.

Example:

"workday"

connector_token
string | null

Connector token — set this for a connector-scoped mapping (applies to a single connector instance). Mutually exclusive with integration_slug.

Example:

"i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"

Response

Successful Response

The response is of type Response Create Custom Field Mapping Api V1 Custom Fields Mapping Post · object.