Create proposal

POST/v1/proposals/envelopes

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings -> API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Length1 <= length <= 500

type?string

Default"document"

Value in"document" | "template"

contactId?string

Formatuuid

companyId?string

Formatuuid

externalId?string

Lengthlength <= 500

subject?string

Lengthlength <= 500

message?string

Lengthlength <= 5000

Response Body

`application/json`

cURL

curl -X POST "https://example.com/proposals/envelopes" \  -H "Content-Type: application/json" \  -d '{    "title": "Acme Corp - Q2 Engagement"  }'

{
  "envelope": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "secondaryId": "P-1042",
    "externalId": "string",
    "title": "Acme Corp - Q2 Engagement",
    "status": "draft",
    "type": "document",
    "totalAmount": "5000.00",
    "currency": "USD",
    "sentAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string"
}

{
  "error": "validation_failed",
  "message": "string"
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`