Skip to main content
POST
Create a quote from a template

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

sequence-version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

id
string
required

Quote Template ID

Body

application/json
title
string | null

The quote title. Overrides the template's title when provided.

Example:

"My quote"

currency
enum<string> | null

Quote currency. Overrides the template's currency when provided.

Available options:
AED,
ARS,
AUD,
BRL,
BGN,
CAD,
CHF,
CLP,
CNY,
COP,
CZK,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
ISK,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SAR,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
Example:

"GBP"

dealType
enum<string> | null

Quote deal type. Overrides the template's deal type when provided.

Available options:
NEW_BUSINESS,
RENEWAL,
AMENDMENT
Example:

"AMENDMENT"

expiryDays
integer<int32> | null

Number of days after publishing in which the quote will expire. Overrides the template's value when provided.

Example:

30

preliminaryBillingStartDate
string | null

Preliminary start date of the contract. A template does not carry one, so this sets the new quote's value.

Example:

"2022-10-01"

defaultDueDateDays
integer | null

Default number of days between issue date and due date. Passed onto a billing schedule created from the quote. Overrides the template's value when provided.

Example:

30

integrationIds
object[] | null

IDs of external entities that are linked to this quote.

Example:
salesforceOpportunityId
string | null

Salesforce ID of the opportunity that created this quote.

Example:

"a00Hr00001BiFbjIAF"

ownerId
string | null

ID of the quote owner. Required when the request is not made by a Sequence user.

Example:

"4ffd439e-32e5-4046-bb40-3cb81f40e5da"

phases
object[] | null

Phases for this quote, in sequential order. Replaces the template's phases entirely when provided.

Example:
contactIds
string[] | null

IDs of contacts who will receive this quote (and sign this quote if using e-signatures).

Example:
counterSignerIds
string[] | null

IDs of internal counter signers who will receive this quote. Replaces the default counter signer when provided; send an empty list for no counter signers.

Example:
attachmentAssetIds
string[] | null

IDs of assets to attach to this quote. Merged with the template's attachments rather than replacing them.

Example:

Response

Created

id
string
required

Unique ID

Example:

"678ca125-8bc3-478f-9a96-6ba73605cf1e"

createdBy
string
required

The Sequence user who created this quote

Example:

"4ffd439e-32e5-4046-bb40-3cb81f40e5da"

quoteNumber
string
required

An alpha-numeric value that identifies the quote

Example:

"Q00001"

status
enum<string>
required

The status of the quote

Available options:
DRAFT,
PUBLISHED,
PREPARING_SIGNATURE_REQUEST,
READY_TO_SIGN,
ACCEPTED,
EXECUTED
Example:

"ACCEPTED"

createdAt
string
required

Creation timestamp. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

updatedAt
string
required

Timestamp when quote was last updated. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

merchantBranding
object
required

Merchant information and branding (for quote rendering)

Example:
phases
object[]
required

Phases for this quote, in sequential order

Example:
contactIds
string[]
required

IDs of contacts who will receive this quote (and sign this quote if using e-signatures)

Example:
contacts
object[]
required

List of contacts requested to sign this quote

Example:
counterSigners
object[]
required

List of internal persons who countersign every quote

Example:
isSignaturesEnabled
boolean
required

Enable e-signatures to allow customers to sign this quote through Dropbox Sign.

Example:

false

integrationIds
object[]
required

IDs of external entities that are linked to this quote

Example:
pdfStatus
enum<string>
required

Status of quote PDF generation for this variant

Available options:
NOT_YET_REQUESTED,
REQUESTED,
IN_PROGRESS,
FAILED,
GENERATED
Example:

"NOT_YET_REQUESTED"

attachmentAssets
object[]
required

Assets attached to this quote

Example:
isExpired
boolean
required

True if the quote expiry date has passed

Example:

false

activeErrors
object[]
required

Active (unresolved) errors on the current quote variant. Empty when the quote is healthy.

Example:
customerId
string | null

ID of Customer to which this quote pertains

Example:

"377bf97b-ca1d-4538-be06-4022afa6bde3"

title
string | null

The quote title

Example:

"My quote"

currency
enum<string> | null

Quote currency

Available options:
AED,
ARS,
AUD,
BRL,
BGN,
CAD,
CHF,
CLP,
CNY,
COP,
CZK,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
ISK,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SAR,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
Example:

"GBP"

dealType
enum<string> | null

Quote deal type

Available options:
NEW_BUSINESS,
RENEWAL,
AMENDMENT
Example:

"AMENDMENT"

amendment
object | null

The billing schedule this quote amends and the date the change takes effect. Only present on AMENDMENT quotes.

Example:
preliminaryBillingStartDate
string | null

Preliminary start date of contract

Example:

"2022-10-01"

expiresAt
string | null

Date when quote expires

Example:

"2022-10-01"

publishedAt
string | null

Timestamp when quote was published. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

readyToSignAt
string | null

Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

acceptedAt
string | null

Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

executedAt
string | null

Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

createdFrom
object | null

Entity from which this quote was created

Example:
salesforceOpportunityId
string | null

Salesforce ID of the opportunity that created this quote

Example:

"006Hr00001MfnEIIAZ"

expiryDays
integer<int32> | null

Number of days after publishing in which quote will expire

Example:

30

archivedAt
string | null

Date and time the quote was archived

Example:

"2022-06-28T16:47:00Z"

approvalWorkflowId
string | null

The ID of the active approval workflow for this quote, if one is in progress

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Customer legal name

Example:

"Acme Corp"

customerAddress
object | null
Example:
defaultDueDateDays
integer | null

Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.

Example:

30

signatureMode
enum<string> | null

The signature mode used when the quote is published. Can be EMBEDDED, NON_EMBEDDED. It is null if the quote is a draft or if e-signatures are disabled for the quote.

Available options:
EMBEDDED,
NON_EMBEDDED
Example:

"EMBEDDED"

preparingSignatureRequestAt
string | null

Timestamp when quote ready-to-sign operation was triggered.

Example:

"2022-06-28T16:47:00Z"