Orders

Prepare a reply to a buyer (step 1 of 2)

Checks the message the way the send would, names who would receive it, freezes the text, and returns a single-use confirmation token valid for 10 minutes. SENDS NOTHING: no message is written and the buyer cannot tell this was called. Show the seller the returned recipient and message, then send with POST /api/conversations/{id} and confirmation_token. The text sent is the text frozen here.

post/api/conversations/{id}/reply/prepare

Request

  • Base URL: https://clearlist.me
  • URL: https://clearlist.me/api/conversations/{id}/reply/prepare
  • Auth: one of:
    • API key in header X-ClearList-API-Key
    • OAuth 2 (authorization code, authorization URL https://clearlist.me/oauth/authorize, token URL https://clearlist.me/api/oauth/token, scopes: write)

Request body

messagestring required

Message text. Truncated to 2000 characters.

Response

Message checked and frozen. Nothing sent.

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.