BIbindbee
Custom Fields

Update Custom Field Mapping

Changed on

Update a custom field mapping (json_path only).

patch/api/v1/custom-fields/mapping/{custom_field_mapping_id}

Request

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

Path parameters

custom_field_mapping_idstring uuid required

Request body

json_pathstring required

JMESPath expression to extract the value from the upstream payload.

Response

Successful Response

idstring uuid required

Unique identifier of the mapping.

custom_field_idstring uuid required

ID of the custom field this mapping belongs to.

integration_slugstring nullable

Integration slug. Set when the mapping is organization-scoped; null otherwise.

connector_tokenstring nullable

Connector token. Set when the mapping is connector-scoped; null otherwise.

json_pathstring required

JMESPath expression used to extract the value from the upstream payload.

created_atstring date-time required
updated_atstring date-time nullable

Example response

{
  "id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
  "custom_field_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
  "integration_slug": "workday",
  "connector_token": "i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T",
  "json_path": "data.employee.guardian_mobile"
}

Changes

  • 41d9f91ee63fRevision changes
    • info

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

  • eb3486b88e55Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status