Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Probation Letters

Create probation completion letter

Create a new probation completion letter request.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employment documents (employment_documents)-Manage probation documents (probation_document:write)
post/v1/probation-completion-letter

Request body

employment_idstring required

The employment ID.

Example request

{
  "employment_id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7"
}

Response

Success

Example response

{
  "data": {
    "probation_completion_letter": {
      "employment_id": "c7ee6462-a9cf-4a69-9806-5906b975f616",
      "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
      "letter": {
        "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
        "inserted_at": "2021-01-01T00:00:00Z",
        "name": "2024-05-29_Hero8_ProbationConfirmationLetter.pdf",
        "sub_type": "probation_completion_letter",
        "type": "contract"
      },
      "status": "submitted",
      "submitted_at": "2021-07-15T18:18:17Z",
      "zendesk_ticket_url": "https://zendesk.com/tickets/123"
    }
  }
}