Skip to main content
POST
/
ats
/
applications
/
{application_id}
/
attachments
Ruby
require 'kombo'

Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
      integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
      security: Models::Shared::Security.new(
        api_key: '<YOUR_BEARER_TOKEN_HERE>',
      ),
    )

res = s.ats.add_application_attachment(application_id: 'GRKdd9dibYKKCrmGRSMJf3wu', body: Models::Shared::PostAtsApplicationsApplicationIdAttachmentsRequestBody.new(
  attachment: Models::Shared::PostAtsApplicationsApplicationIdAttachmentsRequestBodyAttachment.new(
    name: 'Frank Doe CV.txt',
    content_type: 'text/plain',
    data: 'SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=',
    type: Models::Shared::PostAtsApplicationsApplicationIdAttachmentsRequestBodyType::CV,
  ),
))

unless res.post_ats_applications_application_id_attachments_positive_response.nil?
  # handle response
end
{
  "status": "success",
  "data": {},
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}
If adding an attachment to an application is not supported by the integration, the attachment will be added to the candidate instead.
This endpoint requires the permission Add attachments to be enabled in your scope config.

​
Example Request Body

{
  "application_id": "GRKdd9dibYKKCrmGRSMJf3wu",
  "attachment": {
    "name": "Frank Doe CV.txt",
    "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
    "type": "CV",
    "content_type": "text/plain"
  },
  "remote_fields": {}
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
application_id
string
required

POST /ats/applications/:application_id/attachments Parameter

Body

application/json

POST /ats/applications/:application_id/attachments Request body

​
attachment
object
required
​
remote_fields
object

Additional fields that we will pass through to specific ATS systems.

Response

POST /ats/applications/:application_id/attachments Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{}
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.