BIbigchange
Attachments

Update an attachment's metadata

Changed on

Updates the metadata of a single attachment (required scope attachments:write)

put/v1/attachments/{attachmentId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/attachments/{attachmentId}
  • Auth
    HTTP bearer

Path parameters

attachmentIdinteger required

Attachment id

Headers

Customer-Idinteger required

The customer identifier

Request body

fileNamestring

The file name to assign to the attachment<br/> <br/>Validation:<br/>- Required<br/>- Maximum length of 250 characters

isVisibleToResourceboolean

Whether the attachment should be visible to the resource

Example request

{
  "fileName": "invoice.pdf",
  "isVisibleToResource": true
}

Response

No Content

Changes