proposals

POST `/v1/public/proposals/{token}/accept`

Accept the newest revision. Raises its invoice in the same transaction.

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/public/proposals/{token}/accept \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "agree": <boolean> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

agree must be true and name is the typed acceptance. If the invoice cannot be raised the proposal is NOT accepted (409). A zero total raises no invoice and opens the project immediately.

Parameters

Name	Type	Required	What it is
`token (path)`	`string`	Yes	The capability token from the link in the proposal e-mail.

Request body

Name	Type	Required	What it is
`name`	`string`	Yes	—
`agree`	`boolean`	Yes	—

Response

Name	Type	Required	What it is
`reference`	`string`	Yes	—
`status`	`ProposalStatus`	Yes	—
`revision`	`integer`	Yes	—
`expired`	`boolean`	Yes	—
`answerable`	`boolean`	Yes	—
`document`	`object`	No	The frozen revision the recipient reads — title, message, lines, totals.
`invoice`	`ProposalInvoice \| null`	No	—
`project`	`object`	No	The project room — cards, messages and files — once paid.
`history`	`ProposalEvent[]`	Yes	—
`locale`	`string`	No	—
`direction`	`string<ltr, rtl>`	No	—
`issuer_name`	`string`	No	—
`labels`	`object`	Yes	—

Errors this endpoint can return

404 · 409 · 422 · 429

POST /v1/public/proposals/{token}/accept