Update contract

curl --request PATCH \
  --url https://api.tomorro.com/v2/contracts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Service Agreement - Acme Corp",
  "status": "draft",
  "folderId": "550e8400-e29b-41d4-a716-446655440005",
  "counterparty": {
    "name": "Acme Corporation"
  },
  "signatureDate": "2024-06-01T00:00:00.000Z",
  "signatories": {
    "internalSignatoryMemberIds": [
      "mem_550e8400-e29b-41d4-a716-446655440004"
    ],
    "externalSignatoryEmailList": [
      "signatory@example.com"
    ]
  },
  "fields": [
    {
      "fieldId": "550e8400-e29b-41d4-a716-446655440008",
      "value": "Technology"
    }
  ],
  "contractMembersIds": [
    "550e8400-e29b-41d4-a716-446655440004"
  ],
  "contractGuestsEmails": [
    "guest@example.com",
    "guest2@example.com"
  ],
  "integration": {
    "type": "salesforce"
  }
}
'

import requests

url = "https://api.tomorro.com/v2/contracts/{id}"

payload = {
    "name": "Service Agreement - Acme Corp",
    "status": "draft",
    "folderId": "550e8400-e29b-41d4-a716-446655440005",
    "counterparty": { "name": "Acme Corporation" },
    "signatureDate": "2024-06-01T00:00:00.000Z",
    "signatories": {
        "internalSignatoryMemberIds": ["mem_550e8400-e29b-41d4-a716-446655440004"],
        "externalSignatoryEmailList": ["signatory@example.com"]
    },
    "fields": [
        {
            "fieldId": "550e8400-e29b-41d4-a716-446655440008",
            "value": "Technology"
        }
    ],
    "contractMembersIds": ["550e8400-e29b-41d4-a716-446655440004"],
    "contractGuestsEmails": ["guest@example.com", "guest2@example.com"],
    "integration": { "type": "salesforce" }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Service Agreement - Acme Corp',
    status: 'draft',
    folderId: '550e8400-e29b-41d4-a716-446655440005',
    counterparty: {name: 'Acme Corporation'},
    signatureDate: '2024-06-01T00:00:00.000Z',
    signatories: {
      internalSignatoryMemberIds: ['mem_550e8400-e29b-41d4-a716-446655440004'],
      externalSignatoryEmailList: ['signatory@example.com']
    },
    fields: [{fieldId: '550e8400-e29b-41d4-a716-446655440008', value: 'Technology'}],
    contractMembersIds: ['550e8400-e29b-41d4-a716-446655440004'],
    contractGuestsEmails: ['guest@example.com', 'guest2@example.com'],
    integration: {type: 'salesforce'}
  })
};

fetch('https://api.tomorro.com/v2/contracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tomorro.com/v2/contracts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Service Agreement - Acme Corp',
    'status' => 'draft',
    'folderId' => '550e8400-e29b-41d4-a716-446655440005',
    'counterparty' => [
        'name' => 'Acme Corporation'
    ],
    'signatureDate' => '2024-06-01T00:00:00.000Z',
    'signatories' => [
        'internalSignatoryMemberIds' => [
                'mem_550e8400-e29b-41d4-a716-446655440004'
        ],
        'externalSignatoryEmailList' => [
                'signatory@example.com'
        ]
    ],
    'fields' => [
        [
                'fieldId' => '550e8400-e29b-41d4-a716-446655440008',
                'value' => 'Technology'
        ]
    ],
    'contractMembersIds' => [
        '550e8400-e29b-41d4-a716-446655440004'
    ],
    'contractGuestsEmails' => [
        'guest@example.com',
        'guest2@example.com'
    ],
    'integration' => [
        'type' => 'salesforce'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tomorro.com/v2/contracts/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Service Agreement - Acme Corp\",\n  \"status\": \"draft\",\n  \"folderId\": \"550e8400-e29b-41d4-a716-446655440005\",\n  \"counterparty\": {\n    \"name\": \"Acme Corporation\"\n  },\n  \"signatureDate\": \"2024-06-01T00:00:00.000Z\",\n  \"signatories\": {\n    \"internalSignatoryMemberIds\": [\n      \"mem_550e8400-e29b-41d4-a716-446655440004\"\n    ],\n    \"externalSignatoryEmailList\": [\n      \"signatory@example.com\"\n    ]\n  },\n  \"fields\": [\n    {\n      \"fieldId\": \"550e8400-e29b-41d4-a716-446655440008\",\n      \"value\": \"Technology\"\n    }\n  ],\n  \"contractMembersIds\": [\n    \"550e8400-e29b-41d4-a716-446655440004\"\n  ],\n  \"contractGuestsEmails\": [\n    \"guest@example.com\",\n    \"guest2@example.com\"\n  ],\n  \"integration\": {\n    \"type\": \"salesforce\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.tomorro.com/v2/contracts/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Service Agreement - Acme Corp\",\n  \"status\": \"draft\",\n  \"folderId\": \"550e8400-e29b-41d4-a716-446655440005\",\n  \"counterparty\": {\n    \"name\": \"Acme Corporation\"\n  },\n  \"signatureDate\": \"2024-06-01T00:00:00.000Z\",\n  \"signatories\": {\n    \"internalSignatoryMemberIds\": [\n      \"mem_550e8400-e29b-41d4-a716-446655440004\"\n    ],\n    \"externalSignatoryEmailList\": [\n      \"signatory@example.com\"\n    ]\n  },\n  \"fields\": [\n    {\n      \"fieldId\": \"550e8400-e29b-41d4-a716-446655440008\",\n      \"value\": \"Technology\"\n    }\n  ],\n  \"contractMembersIds\": [\n    \"550e8400-e29b-41d4-a716-446655440004\"\n  ],\n  \"contractGuestsEmails\": [\n    \"guest@example.com\",\n    \"guest2@example.com\"\n  ],\n  \"integration\": {\n    \"type\": \"salesforce\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tomorro.com/v2/contracts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Service Agreement - Acme Corp\",\n  \"status\": \"draft\",\n  \"folderId\": \"550e8400-e29b-41d4-a716-446655440005\",\n  \"counterparty\": {\n    \"name\": \"Acme Corporation\"\n  },\n  \"signatureDate\": \"2024-06-01T00:00:00.000Z\",\n  \"signatories\": {\n    \"internalSignatoryMemberIds\": [\n      \"mem_550e8400-e29b-41d4-a716-446655440004\"\n    ],\n    \"externalSignatoryEmailList\": [\n      \"signatory@example.com\"\n    ]\n  },\n  \"fields\": [\n    {\n      \"fieldId\": \"550e8400-e29b-41d4-a716-446655440008\",\n      \"value\": \"Technology\"\n    }\n  ],\n  \"contractMembersIds\": [\n    \"550e8400-e29b-41d4-a716-446655440004\"\n  ],\n  \"contractGuestsEmails\": [\n    \"guest@example.com\",\n    \"guest2@example.com\"\n  ],\n  \"integration\": {\n    \"type\": \"salesforce\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "ctr_550e8400-e29b-41d4-a716-446655440000",
  "name": "Service Agreement - Acme Corp",
  "status": "draft",
  "counterparty": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Acme Corporation"
  },
  "contractType": {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "name": "Service Agreement"
  },
  "templateId": "550e8400-e29b-41d4-a716-446655440003",
  "author": {
    "id": "550e8400-e29b-41d4-a716-446655440004",
    "email": "john.doe@example.com"
  },
  "fields": [
    {
      "attributeDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Department",
      "value": "John Doe"
    }
  ],
  "signatories": [
    {
      "id": "sig_550e8400-e29b-41d4-a716-446655440005",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "type": "member"
    }
  ],
  "integration": {
    "type": "salesforce",
    "externalId": "sf-123456",
    "externalEntity": "Opportunity",
    "externalUrl": "https://my-crm.example.com/opportunities/sf-123456"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-02-20T14:45:00.000Z",
  "contractMembers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "email": "john.doe@example.com"
    }
  ]
}

PATCH

contracts

{id}

Update contract

curl --request PATCH \
  --url https://api.tomorro.com/v2/contracts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Service Agreement - Acme Corp",
  "status": "draft",
  "folderId": "550e8400-e29b-41d4-a716-446655440005",
  "counterparty": {
    "name": "Acme Corporation"
  },
  "signatureDate": "2024-06-01T00:00:00.000Z",
  "signatories": {
    "internalSignatoryMemberIds": [
      "mem_550e8400-e29b-41d4-a716-446655440004"
    ],
    "externalSignatoryEmailList": [
      "signatory@example.com"
    ]
  },
  "fields": [
    {
      "fieldId": "550e8400-e29b-41d4-a716-446655440008",
      "value": "Technology"
    }
  ],
  "contractMembersIds": [
    "550e8400-e29b-41d4-a716-446655440004"
  ],
  "contractGuestsEmails": [
    "guest@example.com",
    "guest2@example.com"
  ],
  "integration": {
    "type": "salesforce"
  }
}
'

import requests

url = "https://api.tomorro.com/v2/contracts/{id}"

payload = {
    "name": "Service Agreement - Acme Corp",
    "status": "draft",
    "folderId": "550e8400-e29b-41d4-a716-446655440005",
    "counterparty": { "name": "Acme Corporation" },
    "signatureDate": "2024-06-01T00:00:00.000Z",
    "signatories": {
        "internalSignatoryMemberIds": ["mem_550e8400-e29b-41d4-a716-446655440004"],
        "externalSignatoryEmailList": ["signatory@example.com"]
    },
    "fields": [
        {
            "fieldId": "550e8400-e29b-41d4-a716-446655440008",
            "value": "Technology"
        }
    ],
    "contractMembersIds": ["550e8400-e29b-41d4-a716-446655440004"],
    "contractGuestsEmails": ["guest@example.com", "guest2@example.com"],
    "integration": { "type": "salesforce" }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Service Agreement - Acme Corp',
    status: 'draft',
    folderId: '550e8400-e29b-41d4-a716-446655440005',
    counterparty: {name: 'Acme Corporation'},
    signatureDate: '2024-06-01T00:00:00.000Z',
    signatories: {
      internalSignatoryMemberIds: ['mem_550e8400-e29b-41d4-a716-446655440004'],
      externalSignatoryEmailList: ['signatory@example.com']
    },
    fields: [{fieldId: '550e8400-e29b-41d4-a716-446655440008', value: 'Technology'}],
    contractMembersIds: ['550e8400-e29b-41d4-a716-446655440004'],
    contractGuestsEmails: ['guest@example.com', 'guest2@example.com'],
    integration: {type: 'salesforce'}
  })
};

fetch('https://api.tomorro.com/v2/contracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tomorro.com/v2/contracts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Service Agreement - Acme Corp',
    'status' => 'draft',
    'folderId' => '550e8400-e29b-41d4-a716-446655440005',
    'counterparty' => [
        'name' => 'Acme Corporation'
    ],
    'signatureDate' => '2024-06-01T00:00:00.000Z',
    'signatories' => [
        'internalSignatoryMemberIds' => [
                'mem_550e8400-e29b-41d4-a716-446655440004'
        ],
        'externalSignatoryEmailList' => [
                'signatory@example.com'
        ]
    ],
    'fields' => [
        [
                'fieldId' => '550e8400-e29b-41d4-a716-446655440008',
                'value' => 'Technology'
        ]
    ],
    'contractMembersIds' => [
        '550e8400-e29b-41d4-a716-446655440004'
    ],
    'contractGuestsEmails' => [
        'guest@example.com',
        'guest2@example.com'
    ],
    'integration' => [
        'type' => 'salesforce'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tomorro.com/v2/contracts/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Service Agreement - Acme Corp\",\n  \"status\": \"draft\",\n  \"folderId\": \"550e8400-e29b-41d4-a716-446655440005\",\n  \"counterparty\": {\n    \"name\": \"Acme Corporation\"\n  },\n  \"signatureDate\": \"2024-06-01T00:00:00.000Z\",\n  \"signatories\": {\n    \"internalSignatoryMemberIds\": [\n      \"mem_550e8400-e29b-41d4-a716-446655440004\"\n    ],\n    \"externalSignatoryEmailList\": [\n      \"signatory@example.com\"\n    ]\n  },\n  \"fields\": [\n    {\n      \"fieldId\": \"550e8400-e29b-41d4-a716-446655440008\",\n      \"value\": \"Technology\"\n    }\n  ],\n  \"contractMembersIds\": [\n    \"550e8400-e29b-41d4-a716-446655440004\"\n  ],\n  \"contractGuestsEmails\": [\n    \"guest@example.com\",\n    \"guest2@example.com\"\n  ],\n  \"integration\": {\n    \"type\": \"salesforce\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.tomorro.com/v2/contracts/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Service Agreement - Acme Corp\",\n  \"status\": \"draft\",\n  \"folderId\": \"550e8400-e29b-41d4-a716-446655440005\",\n  \"counterparty\": {\n    \"name\": \"Acme Corporation\"\n  },\n  \"signatureDate\": \"2024-06-01T00:00:00.000Z\",\n  \"signatories\": {\n    \"internalSignatoryMemberIds\": [\n      \"mem_550e8400-e29b-41d4-a716-446655440004\"\n    ],\n    \"externalSignatoryEmailList\": [\n      \"signatory@example.com\"\n    ]\n  },\n  \"fields\": [\n    {\n      \"fieldId\": \"550e8400-e29b-41d4-a716-446655440008\",\n      \"value\": \"Technology\"\n    }\n  ],\n  \"contractMembersIds\": [\n    \"550e8400-e29b-41d4-a716-446655440004\"\n  ],\n  \"contractGuestsEmails\": [\n    \"guest@example.com\",\n    \"guest2@example.com\"\n  ],\n  \"integration\": {\n    \"type\": \"salesforce\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tomorro.com/v2/contracts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Service Agreement - Acme Corp\",\n  \"status\": \"draft\",\n  \"folderId\": \"550e8400-e29b-41d4-a716-446655440005\",\n  \"counterparty\": {\n    \"name\": \"Acme Corporation\"\n  },\n  \"signatureDate\": \"2024-06-01T00:00:00.000Z\",\n  \"signatories\": {\n    \"internalSignatoryMemberIds\": [\n      \"mem_550e8400-e29b-41d4-a716-446655440004\"\n    ],\n    \"externalSignatoryEmailList\": [\n      \"signatory@example.com\"\n    ]\n  },\n  \"fields\": [\n    {\n      \"fieldId\": \"550e8400-e29b-41d4-a716-446655440008\",\n      \"value\": \"Technology\"\n    }\n  ],\n  \"contractMembersIds\": [\n    \"550e8400-e29b-41d4-a716-446655440004\"\n  ],\n  \"contractGuestsEmails\": [\n    \"guest@example.com\",\n    \"guest2@example.com\"\n  ],\n  \"integration\": {\n    \"type\": \"salesforce\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "ctr_550e8400-e29b-41d4-a716-446655440000",
  "name": "Service Agreement - Acme Corp",
  "status": "draft",
  "counterparty": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Acme Corporation"
  },
  "contractType": {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "name": "Service Agreement"
  },
  "templateId": "550e8400-e29b-41d4-a716-446655440003",
  "author": {
    "id": "550e8400-e29b-41d4-a716-446655440004",
    "email": "john.doe@example.com"
  },
  "fields": [
    {
      "attributeDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Department",
      "value": "John Doe"
    }
  ],
  "signatories": [
    {
      "id": "sig_550e8400-e29b-41d4-a716-446655440005",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "type": "member"
    }
  ],
  "integration": {
    "type": "salesforce",
    "externalId": "sf-123456",
    "externalEntity": "Opportunity",
    "externalUrl": "https://my-crm.example.com/opportunities/sf-123456"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-02-20T14:45:00.000Z",
  "contractMembers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "email": "john.doe@example.com"
    }
  ]
}

Authorizations

x-api-key

string

header

required

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

Path Parameters

string

required

The unique identifier (UUID) of the contract

Example:

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

Body

application/json

name

string

The name or title of the contract.

Example:

"Service Agreement - Acme Corp"

status

enum<string>

The status of the contract.

draft: The contract is being created or edited.
negotiating: The contract is being reviewed with counterparties.
canceled: The contract has been canceled.

Available options:

draft,

negotiating,

signing,

signed,

canceled

Example:

"draft"

folderId

string

ID of the folder to move the contract to.

Example:

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

counterparty

object

Counterparty for the contract. Can reference an existing counterparty by ID or update with a new name.

Show child attributes

Example:

{ "name": "Acme Corporation" }

signatureDate

string<date-time> | null

The date when the contract was signed. Formatted as an ISO 8601 date-time string.

Example:

"2024-06-01T00:00:00.000Z"

signatories

object

List of internal and external signatories for the contract

Show child attributes

Example:

{
  "internalSignatoryMemberIds": ["mem_550e8400-e29b-41d4-a716-446655440004"],
  "externalSignatoryEmailList": ["signatory@example.com"]
}

fields

object[]

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

Show child attributes

Example:

[
  {
    "fieldId": "550e8400-e29b-41d4-a716-446655440008",
    "value": "Technology"
  }
]

contractMembersIds

string[]

List of members to add to the contract

Example:

["550e8400-e29b-41d4-a716-446655440004"]

contractGuestsEmails

string[]

List of guests to add to the contract

Example:

["guest@example.com", "guest2@example.com"]

integration

object

Integration parameters. When provided, field values will be resolved using integration-specific option mappings.

Show child attributes

Example:

{ "type": "salesforce" }

Response

Contract updated successfully

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.

Show child attributes

Example:

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Acme Corporation"
}

contractType

object | null

required

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

Show child attributes

Example:

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "name": "Service Agreement"
}

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.

Show child attributes

Example:

{
  "id": "550e8400-e29b-41d4-a716-446655440004",
  "email": "john.doe@example.com"
}

fields

object[]

required

The fields associated with this contract.

Show child attributes

Example:

[
  {
    "attributeDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Department",
    "value": "John Doe"
  }
]

signatories

object[]

required

The signatories associated with this contract.

Show child attributes

Example:

[
  {
    "id": "sig_550e8400-e29b-41d4-a716-446655440005",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "type": "member"
  }
]

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.

Show child attributes

Example:

{
  "type": "salesforce",
  "externalId": "sf-123456",
  "externalEntity": "Opportunity",
  "externalUrl": "https://my-crm.example.com/opportunities/sf-123456"
}

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.

Show child attributes

Example:

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440004",
    "email": "john.doe@example.com"
  }
]

Create contract Get contract signed files

Overview

Contracts

Files

Contract Types

Smart Fields

Custom Objects

Clauses

Counterparties

Members

Organization

Audit Logs

Update contract

Authorizations

Path Parameters

Body

Response