Skip to main content
POST
Create contract

Authorizations

x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key

Body

application/json
contractTypeId
string
required

ID of the contract type

Example:

"550e8400-e29b-41d4-a716-446655440002"

counterparty
object
required

Counterparty for the contract. Can reference an existing counterparty by ID or create a new one.

Example:
templateId
string

ID of the template to create the document from

Example:

"550e8400-e29b-41d4-a716-446655440003"

name
string

Contract name. If omitted, auto-generated from the template name.

Example:

"Service Agreement - Acme Corp"

signatories
object

List of internal and external signatories for the contract

Example:
fields
object[]

Field values to set on the contract. Use field IDs and values (option labels for select fields).

Example:
contractMembersIds
string[]

List of members to add to the contract

Example:
integration
object

Integration parameters to link the contract with an external system.

Example:

Response

Contract created successfully Any non-signed status can transition to canceled

id
string
required

Unique identifier for the contract.

Example:

"ctr_550e8400-e29b-41d4-a716-446655440000"

name
string
required

The name or title of the contract.

Example:

"Service Agreement - Acme Corp"

status
string
required

The current status of the contract.

  • draft: The contract is being created or edited.
  • negotiating: The contract is being reviewed with counterparties.
  • signing: The contract is in the signature process.
  • signed: All parties have signed the contract.
  • canceled: The contract has been canceled.
Example:

"draft"

counterparty
object | null
required

The counterparty associated with this contract.

Example:
contractType
object | null
required

The type of the contract, it is composed of many templates.

Example:
templateId
string | null
required

The template used to create this contract.

Example:

"550e8400-e29b-41d4-a716-446655440003"

author
object
required

The member who created this contract.

Example:
fields
object[]
required

The fields associated with this contract.

Example:
signatories
object[]
required

The signatories associated with this contract.

Example:
integration
object | null
required

The third-party system this contract is linked to, when it was created via an integration (currently Salesforce or HubSpot). The shape mirrors the integration payload accepted on POST /contracts, so you can use this to look up the originating record in your CRM. null when the contract has no external link or was created from the Tomorro web app.

Example:
createdAt
string<date-time>
required

Time at which the contract was created. Formatted as an ISO 8601 date-time string.

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

Time at which the contract was last updated. Formatted as an ISO 8601 date-time string.

Example:

"2024-02-20T14:45:00.000Z"

contractMembers
object[]

The list of participants with this contract.

Example: