Update an Attachment

PUT 
/agreements/:agreement_id/documents/attachments/:attachment_id

Update an attachment for the agreement

Request

Path Parameters

agreement_id cuidrequired

PUT /agreements/:agreement_id/documents/attachments/:attachment_id parameter

attachment_id cuidrequired

PUT /agreements/:agreement_id/documents/attachments/:attachment_id parameter

application/json

Body

PUT /agreements/:agreement_id/documents/attachments/:attachment_id request body

order int64required

Possible values: <= 9007199254740991

Responses

200

PUT /agreements/:agreement_id/documents/attachments/:attachment_id Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the attachment resource.

resource_type stringrequired

Possible values: [attachment]

Data contains the attachment resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the attachment

resource_type stringrequired

Possible values: [attachment]

agreement cuidrequired

The unique identifier of the agreement which this attachment belongs to

order int64required

Possible values: <= 9007199254740991

The order of this attachment relative to the other attachments

file object required

oneOf

MOD1

string

MOD2

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the file resource.

resource_type stringrequired

Possible values: [file]

Data contains the file resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the file

resource_type stringrequired

Possible values: [file]

filename stringrequired

Possible values: non-empty

The complete filename including the file extension

mime_type stringrequired

Possible values: non-empty

The mime type of the file

url url

The signed read url of the file

metadata object

lookup_key stringrequired

A provided lookup key provided by you to help you identify the file.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

Example (from schema)

{
  "version": "1.0",
  "result_type": "single",
  "resource_type": "attachment",
  "data": {
    "id": "cfoulxwwuequxq5cqfqexample",
    "resource_type": "attachment",
    "agreement": "c2rlklyygnbavwihptaexample",
    "order": 1,
    "file": "c8gjaw3df32bzqdsy2eexample",
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

PUT /agreements/:agreement_id/documents/attachments/:attachment_id Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...