Rolefy

API reference / Jobs

Simulate an application (sandbox only)

POST/v1/jobs/{id}/simulate-application

Needs a bearer access token with the jobs.write scope. How authentication works

Creates a test application on one of your sandbox jobs and fires the matching application.created webhook, so you can build and test your application import without a real candidate. Live credentials get a 403.

Path parameters

  • idstring · uuidpathrequired

    The sandbox job's id.

Responses

  • 201Test application created
    Response fields
    • dataApplicationSummary
      • idstring · uuid
      • job_idstring · uuid
      • external_job_idstringnullable
      • statusstring

        Allowed values:submittedreviewingshortlistedinterviewofferedhiredrejected

      • created_atstring · date-time
  • 403Not a sandbox application (invalid_scope)
    Example response
    {
  "error": {
    "code": "invalid_scope",
    "message": "Not a sandbox application (`invalid_scope`)."
  }
}
  • 404Not found (not_found)
    Example response
    {
  "error": {
    "code": "not_found",
    "message": "Not found (`not_found`)."
  }
}