v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Send Contract

This API endpoint sends a contract to the specified recipient.

post/v1/contracts

Request body

contractTemplateIdstring required

The unique ID of the contract template the contract is associated with.

recipientIdstring

Deprecated: Use clientId instead.

clientIdstring required

The unique ID of the client receiving the contract request.

companyIdstring

The company ID of the client. Required when the client has more than one company.

variableValuesstring

A list of fields which represent the specific values for certain contract inputs. This param is only required if the contract template it is associated with has variable inputs. Example: {"input_id":"someValue", "other_input_id": "otherValue"}

Response

200

contractTemplateIdstring

createdAtstring

fileUrlstring

idstring

namestring

objectstring

recipientIdstring

clientIdstring

companyIdstring

shareDatestring

signedFileUrlstring

statusstring

updatedAtstring

Example response

{
  "contractTemplateId": "f919eafa-c800-48eb-bbf2-38e812b7241f",
  "createdAt": "2023-12-20T23:22:55.242621924Z",
  "fields": [
    {
      "id": "4d29b7af-44aa-4d81-9947-a6186abe208a",
      "inputType": "fixed",
      "page": 1,
      "type": "signature",
      "value": "Allene"
    }
  ],
  "fileUrl": "https://copilot-user-files.s3.amazonaws.com/protected/us-east-1%3A785e4ea4-8cf8-4cea-a9cd-cdb6a5732c40/files/2023-12-20T23%3A10%3A29.951Z/Sample%20Contract.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIARGA4UFWVDZQAKD2G%2F20240127%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240127T000740Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQDJ84qWjYhqpt6laxi5WRVeX4Etz6WX7ttOEEUzu4C5aQIhAJz6WQOpVNarWlR%2F0oikd6JihZTK%2BoYvln0yVozQ%2FQi0KocDCLH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQAhoMMDgxNjY0NDIxMjkwIgy7rlnasmBOc521Xlsq2wJnfSejnfqCsMPrpV6FFhcWRKPnxkhTQf75UuhBbJ7ZeZHvQM2Zw0xNo8rG%2BdbwknQvHdLudZ369Gn4hgr2ex462TYzGkR7tKmTEp5T4kSvSQ5rNaM7lQ%2BTEV76rKprkvbeke6yiyebbyIQg52HF3%2BKnF1FSVMDOHzTCaLC5haZorBzAC6Y4kDfrTgExN88amXCVoY7G6N3Ld62E9cKlJA5fzJl8Z3c0GjPfxpme73VH%2Fk1vU8MdMIneGaxCRCf%2BwIuVs6opPK14zfRZhHZJax1JCj08dRBOYIAulAFGSP1MyP0kMblwnOR0jdaiJh9aNsGeTAVToGZQg5qWjxscTwaRp0dRgXUPfObVkkknupSF52A9FfezUSqkfD4mnnj%2BIJsdr94VB%2FZA%2BTe2rHJuBIFeCTrvvylhBopgTdlywe3Yo8NiNnjy%2FAmuW3IInjZoC4Mj%2FVAvSnDcc1A6DCsktGtBjqdAV4Rr%2FiXg719jfhuCeTgSn1lZMlrFZyC87oq2I0wlMAzy%2BQvjhPJZjmCYoPlGRvjmtF%2BrOSDkpGEuNvFphiEsXIwE9LXYHe9DT7%2FjAP2vb0NnGszWQFjLWLzG9N3go4UPEUIQCQgscVn%2B4vPZxwpaojYZiCARP2j%2FAP7s7cIBgK4v7uxCPi8fPnNH7b%2B1t78Zeh4NLicsoruBdu5jBU%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=710e496014d1ea018f246d681877d69c4972eee20c1ae18a7f93d984ea1d74ea",
  "id": "501543eb-40be-43d4-bde1-6640bfbb7895",
  "name": "Sample contract 1",
  "object": "contract",
  "recipientId": "501543eb-40be-43d4-bde1-6640bfbb7895",
  "clientId": "501543eb-40be-43d4-bde1-6640bfbb7895",
  "companyId": "501543eb-40be-43d4-bde1-6640bfbb7895",
  "shareDate": "2024-01-27T00:19:18.213398182Z",
  "status": "pending"
}