Zum Hauptinhalt springen
PUT
/
offers
/
{id}
Update an offer
curl --request PUT \
  --url https://coreapi.io/offers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "sections": [
    {}
  ],
  "customVariables": {},
  "validUntil": "2023-11-07T05:31:56Z",
  "autoActivateSubscription": true
}
'
{
  "id": "<string>",
  "autoActivateSubscription": true,
  "name": "<string>",
  "validUntil": "2023-11-07T05:31:56Z",
  "customVariables": {}
}

Autorisierungen

​
Authorization
string
header
erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Pfadparameter

​
id
string<ulid>
erforderlich

Offer ID (ULID).

Body

application/json

Partial update of a draft offer. Most fields freeze once the offer is accepted.

​
name
string | null
​
sections
object[]

Document blocks that make up the offer body.

​
customVariables
object
​
acceptanceMode
enum<string>
Verfügbare Optionen:
click,
esignature,
print
​
validUntil
string<date-time> | null
​
autoActivateSubscription
boolean

Antwort

The updated offer.

​
id
string
erforderlich
​
status
enum<string>
erforderlich
Verfügbare Optionen:
open,
signing,
awaiting_invoice_details,
signed,
archived
​
acceptanceMode
enum<string>
erforderlich
Verfügbare Optionen:
click,
esignature,
print
​
dealType
enum<string>
erforderlich
Verfügbare Optionen:
new_business,
expansion,
renewal,
one_off
​
autoActivateSubscription
boolean
erforderlich
​
name
string | null
​
validUntil
string<date-time> | null
​
customVariables
object