Put dismissed or cancelled auto-invite candidates back
Undoes a dismissal or a cancel: items that the same API key owner dismissed or cancelled in the last 10 minutes come back. A dismissed item goes back to queued. A cancelled invite goes back to held, due at its previous inviteAt when that is still ahead and otherwise after a fresh wait (inside the 09:00 to 18:00 send window of the organisation's time zone); it is restored only while the rule is on in invite mode, the candidate has no interview and nobody decided on them. Nothing is sent to the candidate by this call. Restoring an item that is already queued or held changes nothing. An item that was invited, did not match, was dismissed or cancelled by someone else, was decided longer ago, or is no longer eligible is auto_invite_not_restorable, and then nothing is restored.
Required scope: auto_invite:write.
Errors
- 400:
invalid_content_type,invalid_idempotency_key,invalid_json,request_body_too_large,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
auto_invite_evaluation_not_found,job_not_found - 409:
auto_invite_not_restorable,idempotency_key_reused,idempotency_request_in_progress - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>id*stringThe job's ID.
1 <= length <= 200Idempotency-Key?stringMakes retries safe. Repeating a request with the same key and body within 24 hours returns the original response with Idempotent-Replayed: true. The same key with a different body, or from a different API key, returns idempotency_key_reused.
1 <= length <= 255application/json- body
evaluationIds*array<>The evaluations to put back, from GET /v1/jobs/{id}/auto-invite/evaluations, at most 100.
1 <= items <= 100Success.
application/json- response
object*stringrestoredCount*integerItems put back by this call: dismissed ones return to queued, cancelled ones return to held. Ones already queued or held are not counted.
-9007199254740991 <= value <= 9007199254740991# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.# Idempotency-Key is optional. Reuse the same key and body when retrying one logical write.curl --fail-with-body -X POST "$PROBB_URL/api/v1/jobs/ID_VALUE/auto-invite/evaluations/restore" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H "Idempotency-Key: $REQUEST_KEY" \ -H 'Content-Type: application/json' \ --data-binary '{ "evaluationIds": [ "aie_example_3" ]}'{ "object": "auto_invite_restoration", "restoredCount": -9007199254740991}