Cancel held auto-invites
Stops held invites before they go out: the items become cancelled and the dispatcher never sends them, even if their time just passed. Nothing is sent to the candidate and no decision is recorded. Cancelling an item that is already cancelled changes nothing; an item the dispatcher invited first is counted in tooLateCount. An item that is not held is auto_invite_not_held. A person's cancel always wins over the rule.
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_held,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 cancel, from GET /v1/jobs/{id}/auto-invite/evaluations, at most 100.
1 <= items <= 100Success.
application/json- response
object*stringcancelledCount*integerHeld invites that were cancelled by this call.
-9007199254740991 <= value <= 9007199254740991tooLateCount*integerItems the dispatcher had already invited before the cancel reached them; their candidates have the invitation.
-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/cancel" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H "Idempotency-Key: $REQUEST_KEY" \ -H 'Content-Type: application/json' \ --data-binary '{ "evaluationIds": [ "aie_example_4" ]}'{ "object": "auto_invite_cancellation", "cancelledCount": -9007199254740991, "tooLateCount": -9007199254740991}