Skip to main content
POST
Cancel an offer

Authorizations

Authorization
string
header
required

Bearer credential for the public API: a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Dashboard sign-in tokens are not accepted.

Path Parameters

id
string
required

id public identifier.

Pattern: ^of_[A-Za-z0-9]{8,32}$
Example:

"of_A1b2C3d4E5f6"

Body

application/json
cancellation_reason
string

Free text kept with the offer and read back as cancelled_reason. The buyer is never shown it.

Maximum string length: 500

Response

Successful response

data
object
required