Skip to main content
PATCH
/
v1
/
offers
/
{id}
Update an offer
curl --request PATCH \
  --url https://api.plane.com/v1/offers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "recipient": {},
  "terms": {},
  "expires": "<string>",
  "metadata": {}
}
'
{
  "recipient": {
    "name": "Jane Smith"
  },
  "terms": {
    "role": {
      "title": "Senior Software Engineer"
    }
  },
  "expires": "2026-06-27T23:59:59Z",
  "metadata": {
    "source": "headcount-plan"
  }
}
Update recipient details, proposed terms, expiration, or metadata on a draft offer. Sent, accepted, declined, expired, and voided offers cannot be edited. Use an Idempotency-Key header when retrying update requests. See Idempotency.

​
Parameters

​
id
string
required
The offer ID.
​
recipient
object
Recipient name or email.
​
terms
object
Proposed role, employment constraints, compensations, or benefits.
​
expires
string
Offer expiration timestamp.
​
metadata
object
Set of key-value pairs to attach to the offer.

​
Returns

Returns the updated Offer object. 
{
  "recipient": {
    "name": "Jane Smith"
  },
  "terms": {
    "role": {
      "title": "Senior Software Engineer"
    }
  },
  "expires": "2026-06-27T23:59:59Z",
  "metadata": {
    "source": "headcount-plan"
  }
}