Skip to main content
PUT
/
attachments
/
v1
/
{attachmentId}
Update attachment metadata
curl --request PUT \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/attachments/v1/{attachmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>' \
  --data '
{
  "name": "document.pdf",
  "mimeType": "application/pdf",
  "size": 1024
}
'
{
  "data": {
    "id": 1,
    "name": "document.pdf",
    "storageKey": "attachments/2024/document-123.pdf",
    "mimeType": "application/pdf",
    "size": 1024,
    "attachableType": 1,
    "uploadedById": 1,
    "anomalyId": 1,
    "clientInterventionId": 1,
    "providerInterventionId": 1,
    "logoForOrganizationId": 1,
    "updatedAt": "2024-12-05T14:56:23.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

attachmentId
integer
required

Unique identifier of the attachment.

Example:

1

Body

application/json

Update attachment

name
string
required

Name of the attachment.

Example:

"document.pdf"

mimeType
enum<string>

MIME type of the attachment.

Available options:
image/jpg,
image/jpeg,
image/png,
image/svg+xml,
image/gif,
text/plain,
text/csv,
application/pdf,
application/msword,
application/vnd.openxmlformats-officedocument.wordprocessingml.document,
application/vnd.ms-excel,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
application/zip,
application/x-7z-compressed,
application/vnd.ms-outlook,
message/rfc822
Example:

"application/pdf"

size
integer

Size of the attachment in bytes.

Example:

1024

Response

200 - application/json

The attachment has been updated

data
object
required