Invite an applicant awaiting your decision

POST
/submissions/{submissionId}/invite

Invites an applicant sitting in your applicant-review queue, which materializes their tasks and notifies them. The submission becomes screen_passed. Returns 409 if the applicant is not awaiting your decision, which includes one you have already decided on.

Authorization

apiKey
Authorization<token>

API key as Bearer token: Authorization: Bearer

In: header

Path Parameters

submissionId*string

ID of an applicant awaiting your invite decision: the id on their applicant row.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://terac.com/api/external/v2/submissions/string/invite" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "status": "screen_passed",
  "dashboard_url": "string"
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required. Include Authorization: Bearer <key> header."
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This account is not permitted to use the API."
  }
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 61 seconds."
  }
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Get submission details GET

Returns one submission with its status, screening answers and per-task progress. An applicant still in the screener, or waiting on your invite decision, returns 404 here; the latter are listed in `GET /opportunities/{opportunityId}/applicants`.

Decline an applicant awaiting your decision POST

Declines an applicant sitting in your applicant-review queue. The submission becomes `screened_out` and they are not invited. Returns 409 if the applicant is not awaiting your decision, which includes one you have already decided on.