Attach File to Contract

Endpoint URL

https://{{base_url}}/api/v2/contract_attachment

Authentication and rate limits

Item	Details
Authentication method	OAuth 2.0 Bearer token
Rate limit	Rate Limit

Requests Example

curl --request POST \
  --url 'https://{{base_url}}/api/v2/contract_attachment \
  --header 'Authorization: Bearer $BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data-raw '$JSON'

Request Syntax

{
    "company":integer,
    "contract_id":integer,
    "file_type":"attachments",
    "file_id": integer
}

Body Parameters

company (integer) --
[REQUIRED]
The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
To lookup a specific company ID, see the List Company API.
contract_id (integer) --
[REQUIRED]
The ID of the contract. <
To lookup a specific contract ID, see the List Contract API.
file_type (string) --
[REQUIRED]
Specify the type of attachment to be added to a contract.
Options: attachments
file_id (integer) --
[REQUIRED]
The ID of the file that was uploaded. <
To lookup a specific file ID, see the List File API.

Response Syntax

{
    "details": {
        "status": "linked successfully",
        "file_uuid": "string",
        "contract_id": integer,
        "file_id": integer,
        "file_type":"asset_attachments" | "warranty_document" | "support_document"
    }
}