Sandbox

Approve job title review

Approves the job title review an employment is in, without the intervention of a Remote admin, so the integration can be tested against the decision it will see in production.

The employment returns to the status it held before it entered review, and an employment.job_title_review.approved webhook event is emitted.

Responds with 422 when the employment is not in a job title review.

This endpoint is only available in Sandbox, otherwise it will respond with a 404.

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.
post/v1/sandbox/employments/{employment_id}/job-title-review/approve

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/sandbox/employments/{employment_id}/job-title-review/approve
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or HTTP bearer

Path parameters

employment_idstring required

Employment ID

Request body

notesstring

The reviewer's notes, recorded on the employment as a Remote admin's would be.

Example request

{
  "notes": "Checked the role against the local restrictions."
}

Response

Success

Example response

{
  "data": {
    "job_title_review": {
      "employment_status": "created"
    }
  }
}

Changes

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