Upload a contract attachment

POST /api/customers/{id}/contracts/{contractId}/attachments on the Vigilbase One API.

Multipart upload

POST/api/customers/{id}/contracts/{contractId}/attachments

Authorizations

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Organisation API keys can't call this endpoint: it takes a file upload.

Permissions checkedwrite:contracts

Path Parameters

idstringrequired

contractIdstringrequired

Body

multipart/form-data

A multipart form upload. The catalog doesn't list the form's field names.

Response

Success

# Token from `vigilbase login`. API keys can't call this.
curl --request POST \
  --url 'https://one.vigilbase.com/api/customers/{id}/contracts/{contractId}/attachments' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --form '<field>=@./path/to/file'

Set VIGILBASE_TOKEN to an Identity access token first, or use Try it.

Responses

200Success

401Authentication required

403Not permitted

The catalog doesn't include example response bodies for this endpoint.

Was this page helpful?