Orders

Share the address (step 2 of 2)

Sends the seller's address to the buyer. IRREVERSIBLE: the buyer receives it in the thread and by email, and the seller is emailed a record of every share. A first-party session sends { address }. An API key must send { confirmation_token } from the prepare endpoint and NO address — the string was frozen at step 1 and cannot be changed here. An API key arriving without a valid token is refused with CONFIRMATION_REQUIRED.

post/api/conversations/{id}/address

Request

  • Base URL: https://clearlist.me
  • URL: https://clearlist.me/api/conversations/{id}/address
  • 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)

Headers

Idempotency-Keystring

Unique client-generated key (1-255 chars from A-Za-z0-9_-:.; a UUID works well), scoped to the seller and the operation. The first successful (2xx) response is stored for 24h; retrying the identical request with the same key replays it instead of re-executing, so network-failure retries never create duplicates. A duplicate that arrives while the first is still running gets 409 idempotency_conflict. The same key with a different body (byte for byte) or a different kind of credential gets 422 idempotency_key_reuse and leaves the original record in place: send a new key. An error the operation itself returns is never stored and releases the key.

Request body

confirmation_tokenstring

Required for API-key callers. From the prepare endpoint.

addressstring

First-party sessions only. Ignored when a confirmation_token is present.

Response

Address sent. The buyer has it and the seller has been emailed a record.

successboolean

Changes

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