Skip to content

Move Stage Applications

Endpoint

http
POST /unified/ats/applications/move-stage
Integrations supported
  • Ashby
  • BambooHR
  • Greenhouse
  • Lever
  • Recruiterflow
  • SmartRecruiters
  • Workable

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

application_id
string
The ID of the application to move.
Required in
  • Ashby
  • BambooHR
  • Greenhouse
  • Recruiterflow
  • SmartRecruiters
  • Workable
stage_id
string
The ID of the stage to move the candidate to.
All possible enum values:
  • LEAD
  • NEW
  • IN_REVIEW
  • INTERVIEW
  • OFFERRED
  • HIRED
  • REJECTED
  • WITHDRAWN
  • TRANSFERRED
Enum support by integration
  • SmartRecruiters
    • LEAD
    • NEW
    • IN_REVIEW
    • INTERVIEW
    • OFFERRED
    • HIRED
    • REJECTED
    • WITHDRAWN
    • TRANSFERRED
Required in
  • Ashby
  • BambooHR
  • Greenhouse
  • Lever
  • Recruiterflow
  • SmartRecruiters
  • Workable
user_id
string
The ID of the user moving the candidate.
Required in
  • Recruiterflow
  • Workable
Supported in
  • Greenhouse
  • Lever
candidate_id
string
The ID of the candidate to move.
Required in
  • Lever
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
The application's unique identifier
Supported in
  • Ashby
candidate
object
The application's candidate
Supported in
  • Ashby
id
string
Unique identifier of the candidate
job
object
The application's job
Supported in
  • Ashby
id
string
Unique identifier of the job
applied_at
string · date-time
The date and time of the application's creation
Supported in
  • Ashby
rejected_at
string · date-time
The date and time of the application's rejection
source
object
The application's source
Supported in
  • Ashby
id
string
The application's source's unique identifier
name
string
The application's source's name
credited_to
object
The application's credited_to
Supported in
  • Ashby
id
string
Unique identifier of the user
first_name
string
First name of the user
last_name
string
Last name of the user
emails
object[]
email
string
Email of the user
type
string
Type of the email
is_primary
boolean
Whether the email is primary
current_stage
object
The application's current_stage
Supported in
  • Ashby
id
string
The application's current_stage's unique identifier
name
string
The application's current_stage's name
job
object
The application's current_stage's job
id
string
Unique identifier of the job
created_at
string · date-time
The date and time of the application's current_stage's creation
updated_at
string · date-time
The date and time of the application's current_stage's last update
reject_reason
string
The application's reject_reason
Supported in
  • Ashby
attachments
object[]
The application's attachments
id
string
REQUIRED · The attachment's unique identifier
file_name
string
The attachment's file_name
file_url
string
The attachment's file_url
candidate
object
The attachment's candidate
id
string
Unique identifier of the candidate
application
object
The attachment's application
id
string
Unique identifier of the application
job
object
The attachment's job
id
string
Unique identifier of the job
attachment_type
string
The attachment's type
created_at
string · date-time
The date and time of the attachment's creation
updated_at
string · date-time
The date and time of the attachment's last update
created_at
string · date-time
The date and time of the application's creation
Supported in
  • Ashby
updated_at
string · date-time
The date and time of the application's last update
Supported in
  • Ashby
remote_data
object
Raw data returned from the remote API call.