Download an attachment

Downloads a file attached to a message. Get the attachment IDs from the attachments of each message in List messages.

GET /v1/attachments/{id}/content

The API does not send the file itself. It responds 302 with a Location header that points to a download link, valid for 5 minutes. Follow the redirect to get the file.

Your API key is checked on every call, so a saved response never holds a link that keeps working.
Do not send the Authorization header to the redirected host. curl and fetch drop it across hosts by default.
Each call counts toward the rate limit.

Authentication

Bearer token in the Authorization header. A read-only key is enough. See Authentication.

Authorization: Bearer rfl_live_...

Path parameters

string

required

Attachment ID prefixed with ea_.

Response

302 Found with no body.

header

The download link. Valid for 5 minutes. Call the endpoint again for a new one.

The filename, content type and size are on the message’s attachment.

Examples

Download a file

curl -L https://api.replyful.com/v1/attachments/ea_6tXw2qKb8mRf3cN7p/content \
  -H "Authorization: Bearer rfl_live_..." \
  -o receipt.pdf

import { writeFile } from "node:fs/promises";

// fetch follows the redirect and drops the Authorization header on the way.
const res = await fetch(
  "https://api.replyful.com/v1/attachments/ea_6tXw2qKb8mRf3cN7p/content",
  { headers: { Authorization: `Bearer ${process.env.REPLYFUL_API_KEY}` } },
);
if (!res.ok) {
  throw new Error(`Download failed: ${res.status}`);
}
await writeFile("receipt.pdf", Buffer.from(await res.arrayBuffer()));

Response

HTTP/1.1 302 Found
Location: https://files.example.com/receipt.pdf?X-Amz-Expires=300&X-Amz-Signature=...
Cache-Control: no-store

Error responses

Status	`error.code`	When
`401`	`missing_api_key`	The `Authorization` header is absent.
`401`	`invalid_api_key`	The token is malformed, unknown, or archived.
`404`	`attachment_not_found`	The attachment does not exist, belongs to another organization, or was erased with its ticket.
`422`	`invalid_path_parameter`	The `id` path parameter is not a valid attachment ID.
`429`	`too_many_requests`	Rate limit exceeded. Honor `Retry-After`.

See Errors for the full error envelope reference.

Documentation

Tickets

Channels

Conversations

Contacts

Attachments

Knowledge

Download an attachment

Authentication

Path parameters

Response

Examples

Download a file

Error responses

​Authentication

​Path parameters

​Response

​Examples

​Download a file

​Error responses

Authentication

Path parameters

Response

Examples

Download a file

Error responses