Kombo · Schema
PostAtsCandidatesCandidateIdTagsRequestBody
ATSEmbedded iPaaSHRISLMSPayrollUnified API
Properties
| Name | Type | Description |
|---|---|---|
| tag | object | |
| remote_fields | object | Additional fields that we will pass through to specific ATS systems. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PostAtsCandidatesCandidateIdTagsRequestBody",
"title": "PostAtsCandidatesCandidateIdTagsRequestBody",
"type": "object",
"properties": {
"tag": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "The name of the tag you would like to add. We will automatically find the matching ID of the tag in the system."
}
},
"required": [
"name"
]
},
"remote_fields": {
"type": "object",
"properties": {
"greenhouse": {
"type": "object",
"properties": {
"post_headers": {
"type": "object",
"properties": {
"On-Behalf-Of": {
"type": [
"string",
"null"
],
"description": "ID of the the user that will show up as having performed the action in Greenhouse. We already pass a value by default, but you can use this to override it."
}
},
"description": "Headers we will pass with `POST` requests to Greenhouse."
}
},
"description": "Fields specific to Greenhouse."
},
"workable": {
"type": "object",
"properties": {
"on_behalf_of_user_remote_id": {
"type": "string",
"description": "The remote ID of the user that will be displayed in the UI as the one that performed the action."
}
},
"description": "Workable specific remote fields for ATS actions."
}
},
"description": "Additional fields that we will pass through to specific ATS systems."
}
},
"required": [
"tag"
]
}