Attachments

Attachments are how you share things in Protocol — they allow you to send all sorts of files to your contacts and groups. On this page, we'll dive into the different attachment endpoints you can use to manage attachments programmatically. We'll look at how to query, upload, update, and delete attachments.

The attachment model

The attachment model contains all the information about the files you send to your contacts and groups, including the name, type, and size.

Properties

Name
id
Type
string?
Description
Unique identifier for the attachment.
Name
message_id
Type
string?
Description
Unique identifier for the message associated with the attachment.
Name
filename
Type
string?
Description
The filename for the attachment.
Name
file_url
Type
string?
Description
The URL for the attached file.
Name
file_type
Type
string?
Description
The MIME type of the attached file.
Name
file_size
Type
integer?
Description
The file size of the attachment in bytes.
Name
created_at
Type
timestamp?
Description
Timestamp of when the attachment was created.

GET/v1/attachments

List all attachments

This endpoint allows you to retrieve a paginated list of all your attachments (in a conversation if a conversation id is provided). By default, a maximum of ten attachments are shown per page.

Optional attributes

Name
conversation_id
Type
string?
Description
Limit to attachments from a given conversation.
Name
limit
Type
integer?
Description
Limit the number of attachments returned.

Request

GET

/v1/attachments

curl -G https://api.protocol.chat/v1/attachments \
  -H "Authorization: Bearer {token}" \
  -d conversation_id="xgQQXg3hrtjh7AvZ" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "Nc6yKKMpcxiiFxp6",
      "message_id": "LoPsJaMcPBuFNjg1",
      "filename": "Invoice_room_service__Plaza_Hotel.pdf",
      "file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel.pdf",
      "file_type": "application/pdf",
      "file_size": 21352,
      "created_at": 692233200
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/v1/attachments

Create an attachment

This endpoint allows you to upload a new attachment to a conversation. See the code examples for how to send the file to the Protocol API.

Required attributes

Name
file
Type
string?
Description
The file you want to add as an attachment.

Request

POST

/v1/attachments

curl https://api.protocol.chat/v1/attachments \
  -H "Authorization: Bearer {token}" \
  -F file="../Invoice_room_service__Plaza_Hotel.pdf"

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

GET/v1/attachments/:id

Retrieve an attachment

This endpoint allows you to retrieve an attachment by providing the attachment id. Refer to the list at the top of this page to see which properties are included with attachment objects.

Request

GET

/v1/attachments/Nc6yKKMpcxiiFxp6

curl https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

PUT/v1/attachments/:id

Update an attachment

This endpoint allows you to perform an update on an attachment. Currently, the only supported type of update is changing the filename.

Optional attributes

Name
filename
Type
string?
Description
The new filename for the attachment.

Request

PUT

/v1/attachments/Nc6yKKMpcxiiFxp6

curl -X PUT https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
  -H "Authorization: Bearer {token}" \
  -d filename="Invoice_room_service__Plaza_Hotel_updated.pdf"

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel_updated.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

DELETE/v1/attachments/:id

Delete an attachment

This endpoint allows you to delete attachments. Note: This will permanently delete the file.

Request

DELETE

/v1/attachments/Nc6yKKMpcxiiFxp6

curl -X DELETE https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
  -H "Authorization: Bearer {token}"