API reference
Follow Up
Follow Up endpoints.
| Method | Path | Summary |
|---|---|---|
POST | /v1/account/follow-up/media | Upload an image, a video or a captions file for the follow-up page (multipart: file, plus a kind of logo, photo, video or captions). Returns its public URL |
POST | /v1/account/follow-up/test-text | Text the draft's wording to a number, with a sample page behind the link, so an editor can read it on a phone before any caller does |
Upload an image, a video or a captions file for the follow-up page (multipart: file, plus a kind of logo, photo, video or captions). Returns its public URL#
POST /v1/account/follow-up/media
Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).
Response 201
| Field | Type | Required | Description |
|---|---|---|---|
assetId | string | Yes | — |
contentType | string | Yes | — |
kind | enum | Yes | One of: "logo", "photo", "video", "captions". |
sizeBytes | integer | Yes | — |
url | string (uri) | Yes | — |
Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.
Example
bash
curl -X POST "$ANSWERSTACK_API_URL/v1/account/follow-up/media" \
-H "Authorization: Bearer $ACCESS_TOKEN"Text the draft's wording to a number, with a sample page behind the link, so an editor can read it on a phone before any caller does#
POST /v1/account/follow-up/test-text
Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).
Request body
application/json, required.
| Field | Type | Required | Description |
|---|---|---|---|
phone | string | Yes | Pattern: ^\+[1-9]\d\{6,14\}$. |
playbookId | string (pb_… ID) | Yes | ID (pb_…) |
templateKey | string | Yes | 1–64 characters. |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
body | string | Yes | — |
sent | boolean | Yes | — |
Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.
Example
bash
curl -X POST "$ANSWERSTACK_API_URL/v1/account/follow-up/test-text" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"playbookId": "pb_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
"phone": "string",
"templateKey": "string"
}'