Cerclen API
Proposals

Withdraw a proposal

Whoever proposed it takes it back while it waits. 403 `cannot_withdraw`; 409 `proposal_decided`.

POST
/api/v1/deals/{deal_id}/proposals/{proposal_id}/withdraw

Whoever proposed it takes it back while it waits. 403 cannot_withdraw; 409 proposal_decided.

Authorization

ApiKey
headerAuthorizationBearer <token>

An API key from your organization's API Keys page in Cerclen.

Path Parameters

proposal_id*Proposal Id
Formatuuid
deal_id*Deal Id
Formatuuid

Response Body

Successful Response

application/json
  1. response

A request an editor proposed, for one of the deal's admins to file or decline. It has no number until approved, when it becomes a request; the other side never sees it.

assignee_id*|

The person id of whoever would answer it.

body*Body

The request in full, in Markdown.

can*

What you may do to this proposal.

category*Category

That category's name.

category_id*|

The deal's category it would be filed under.

created_at*Created At
Formatdate-time
decided_at*|null
due_date*|null
id*Id
priority*Priority

A request's urgency. Ordering for display is client-side (never ORDER BY).

Value in"low""medium""high"
proposed_by_id*Proposed By Id

The person id of whoever proposed it.

reason*|

Why it was declined.

request_id*|

The request it became, once approved.

requester*|

The advisor firm raising it; null for the Financial Sponsor.

state*ProposalState

pending, then approved, declined or withdrawn.

Value in"pending""approved""declined""withdrawn"
title*Title
curl -X POST 'https://app.cerclen.com/api/v1/deals/497f6eca-6276-4993-bfeb-53cbbbba6f08/proposals/497f6eca-6276-4993-bfeb-53cbbbba6f08/withdraw' \  -H "Authorization: Bearer $CERCLEN_KEY"
{  "assignee_id": "string",  "body": "string",  "can": {    "decide": true,    "withdraw": true  },  "category": "string",  "category_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "decided_at": "2019-08-24T14:15:22Z",  "due_date": "2019-08-24",  "id": "string",  "priority": "low",  "proposed_by_id": "string",  "reason": "string",  "request_id": "string",  "requester": "string",  "state": "pending",  "title": "string"}

Propose a request POST

An editor on the running side raises a request for one of the deal's admins to file. 403 `cannot_propose_request` for anyone else — an admin files at once with `POST /deals/{deal_id}/requests`; 422 `unknown_category`.

Create a request POST

The owning side's admins file requests at once. An editor's key is refused — 403 `proposal_required`: editors propose requests for an admin to file (ADR-0059), which the API does not yet carry — as is anyone else's, 403 `cannot_create_request`.