Skip to main content
POST
Create a new document

Authorizations

Authorization
string
header
required

OAuth 2.0 access token for a connected application. Limited to the scopes granted at consent.

Headers

authorization
string
required

Bearer token for API authentication

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Body

application/json

Body

name
string
required

Document name/title

Minimum string length: 1
signers
object[]
required

[DEPRECATED — use parties instead, will be removed in API v2] Array of signers to add to the document during creation. If both signers and parties are provided, parties takes precedence.

parties
object[]
required

Array of parties to add to the document during creation. Provide either contactId to reference existing contacts, or name and email to manually specify party details.

externalId
string | null

Your external reference ID for tracking this document

expiresAt
string<date-time> | null

Expiration date for the document

type
enum<string>

Document type: SIGNABLE (default), ACCEPTABLE, or ARCHIVE_IMPORTED

Available options:
SIGNABLE,
ACCEPTABLE,
ARCHIVE_IMPORTED
templateId
string | null

Template ID to create document from. Template fields and template parties are copied by default.

responsibleUserId
string

User ID of the person responsible for this document. Must be a member of your organization. Defaults to the creating user.

documentMeta
object

Document metadata including subject, message, signing order, etc.

documentStyle
object

Document styling configuration including orientation, padding, background, and layout

customFields
object[]

Custom field values for the document

Link the document to a CRM record. Prefills mapped custom fields and product tables from the record (configured under Integrations) and enables status write-back to it.

Response

200

documentId
string
required

Unique identifier for the created document

signers
object[]
required

[DEPRECATED — use parties instead, will be removed in API v2] Array of created parties. Same content as parties.

parties
object[]
required

Array of created parties. Use GET /documents/:id/parties/:partyId to retrieve signing URLs.

externalId
string | null

Your external reference ID

expiresAt
string<date-time> | null

Document expiration date