Postscript API
13 endpoints for Postscript, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.
- Base URL
- https://cotlet.dev/api/v1/postscript
- Connects with
- Your own Postscript login for the shop; the agent does what your user can do in the dashboard
- Integration page
- Postscript
Read (6)
Return data and change nothing in the account.
| Endpoint | Description |
|---|---|
| GET | Segments of the shop from Messaging > Segments, with their Segment Size. |
| GET | Campaign flows from Messaging > Flow Builder, with status and the segments they include. |
| GET | Message Analytics rows per campaign and automation: sends, clicks, orders, revenue and unsubscribes. |
| GET | Opt-in keywords from Acquisition > Keywords, with their reply. |
| GET | Subscriber profile from Search, found by phone number, name or email. |
| GET | Threads from Messaging > Conversations, filterable by state, topic and sentiment. |
Write (7)
Change the account. Calls marked Confirm wait for the user to approve them.
| Endpoint | Description |
|---|---|
| POST | Save a segment under Messaging > Segments from criteria joined with and or or. |
| POST | Save a campaign flow draft with its segments and first Send Message block. Sends nothing. |
| POST | Text a preview of a campaign message to one phone number. |
| POST | Activate a campaign flow immediately or at a date and time. |
| POST | End a running campaign flow with End campaign and Stop campaign. |
| POST | Create an opt-in keyword with a reply, optionally with a coupon. |
| POST | Send a reply in a Conversations thread with Send Reply. |