BIbindbee
Custom Fields

Create Custom Field Mapping

Changed on

Create a custom field mapping. Provide exactly one of integration_slug (organization scope) or connector_token (connector scope).

post/api/v1/custom-fields/mapping

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

custom_field_idstring uuid required

ID of the custom field to be mapped.

integration_slugstring nullable

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

connector_tokenstring nullable

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

json_pathstring required

JMESPath expression to extract the value from the upstream payload.

Example request

{
  "custom_field_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
  "integration_slug": "workday",
  "connector_token": "i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"
}

Response

Successful Response

idstring uuid required
statusstring required

Changes

  • 572789b789f4Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 41d9f91ee63fRevision changes
    • info

      removed the pattern \S.*\S from the request property