Probation Extensions

Create Probation Extension

Create a probation extension request.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employment documents (employment_documents)	-	Manage probation documents (probation_document:write)
Company-scoped access token (assertion)	Manage employment documents (employment_documents)	-	Manage probation documents (probation_document:write)
Customer API token	Manage employment documents (employment_documents)	-	Manage probation documents (probation_document:write)

post/v1/probation-extensions

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/probation-extensions
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: probation_document:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: probation_document:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Request body

additional_detailsstring

Any additional details that need to be considered for the probation extension.

date_of_discussion_with_employeestring date

The date when the discussion with the employee took place. Is required when was_employee_informed is true and should be in the past.

duration_of_extension_in_daysinteger required

The number of days to add to the existing probation end date.

employment_idstring required

The employment ID that is related to the probation extension request.

reason_for_extensionstring required

The reason for the probation extension.

was_employee_informedboolean required

Whether the employee was informed about the probation extension.

Example request

{
  "additional_details": "Employee is on leave.",
  "date_of_discussion_with_employee": "2021-09-01",
  "duration_of_extension_in_days": 30,
  "employment_id": "93t3j-employment_id-9suej43",
  "reason_for_extension": "Employee is on leave.",
  "supporting_document": {
    "content": "base64_encoded_content",
    "name": "supporting_document.pdf"
  },
  "was_employee_informed": true
}

Response

Success

Example response

{
  "data": {
    "probation_extension": {
      "employment_id": "93t3j-employment_id-9suej43",
      "id": "93t3j-sfies9_id-9suej43",
      "requested_by": "93t3j-requested_by_id-9suej43",
      "status": "submitted",
      "submitted_at": "2021-09-01T00:00:00Z",
      "zendesk_ticket_url": "https://zendesk.com/tickets/123"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.