An attachment represents a successfully uploaded file that may or may not be associated with an candidate.
Relationships:
Candidate to Attachment is 1-Many
Create an attachment
POSThttps://endorsed.ai/api/v1/attachments
Creates a new attachment through a file upload and returns the attachment's UUID id. Parameters are shown as a Body but are accepted as FormData for Content-Type of multipart/form-data and request body for Content-Type of application/json.
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"FORBIDDEN","issues": [ {"message":"Access to this resource is not authorized." } ] }}
{"is_error":true,"error": {"code":"NOT_FOUND","issues": [ {"message":"This resource entity does not exist." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
Updates or Upserts a new attachment through a file upload and returns the attachment's UUID id or remote id. Remote ids MUST be structured by remote.<id>.
Parameters are shown as a Body but are accepted as FormData for Content-Type of multipart/form-data and request body for Content-Type of application/json.
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"FORBIDDEN","issues": [ {"message":"Access to this resource is not authorized." } ] }}
{"is_error":true,"error": {"code":"NOT_FOUND","issues": [ {"message":"This resource entity does not exist." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Only supports multipart/form-data and application/json. Defaults to multipart/form-data if not set
candidate_id
string
The Candidate UUID from the /candidates entity resource. Field can be left optional for the rare case of attachments NOT directly associated with an candidate id; empty should ONLY be used in rare cases such as lookalike search.
remote_id*
string
The
id
of the attachment from the originating system
type*
string
Type of the attachment: Only currently supports about, resume, role_preferences, and work_experiences.
file
file
The file (binary format) to be uploaded. Required if Content-Type header is multipart/form-data; else should not be set.
public_file_url
string
The publicly accessible file url for Endorsed to download the file from. Required if Content-Type header is application/json; else should not be set.
file_name
string
Name of the file
id*
string
UUID id of the Attachment
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
id*
string
UUID id or Remote Id of the Attachment. Remote ids MUST be structured by remote.<id>.
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Only supports multipart/form-data and application/json. Defaults to multipart/form-data if not set
candidate_id
string
The Candidate UUID from the /candidates entity resource. Field can be left optional for the rare case of attachments NOT directly associated with an candidate id; empty should ONLY be used in rare cases such as lookalike search.
remote_id*
string
The
id
of the attachment from the originating system
type*
string
Type of the attachment: Only currently supports about, resume, role_preferences, and work_experiences.
file
file
The file (binary format) to be uploaded. Required if Content-Type header is multipart/form-data; else should not be set.
public_file_url
string
The publicly accessible file url for Endorsed to download the file from. Required if Content-Type header is application/json; else should not be set.
file_name
string
Name of the file
id*
string
UUID id of the Attachment
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>