Sign in

v3

OpenAPI 3.1.02026-07-311255771.3 MB
General

Put custom field mappings

Updates the mapping of a given custom field. If the custom field is already mapped, it will be updated.

put/integrations/{integration_id}/custom-fields/{custom_field_id}

Path parameters

integration_idstring required

The unique ID of the integration where the custom field mapping should be updated

The unique ID of the integration where the custom field mapping should be updated

custom_field_idstring required

The unique ID of the custom field that should be updated

The unique ID of the custom field that should be updated

Request body

integration_field_idstring nullable required

The integration field's unique ID which the custom field should be mapped to. Null to remove a mapping.

Response

PUT /integrations/:integration_id/custom-fields/:custom_field_id Positive response

status'success' required

Example response

{
  "data": {
    "id": "EU3Bwa4iDfGspEELW71WDvvu",
    "key": "tshirt_size",
    "integration_field": {
      "id": "3n6geaAmKL5tFonXVAtsMDmr",
      "key": "custom.tshirt_size",
      "type": "CUSTOM",
      "label": "T-Shirt Size"
    },
    "model": "hris_employees",
    "label": "T-Shirt Size",
    "description": "Map this to the employee's tshirt size"
  }
}