Skip to main content
POST
/
v1
/
offers
/
{id}
/
void
Void an offer
curl --request POST \
  --url https://api.plane.com/v1/offers/{id}/void \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
Void a draft, sent, or expired offer. Voided offers cannot be accepted by the candidate. Use an Idempotency-Key header when retrying void requests. See Idempotency.

​
Parameters

​
id
string
required
ID of the offer.
​
reason
string
Optional reason to store with the void transition.

​
Returns

Returns the updated Offer object.