NPS/CSAT surveys

Send to one recipient

The score is the click in the email. Anti-fatigue: the same recipient is surveyed once per account window (429 recipient_recently_surveyed, with a Retry-After that may be weeks). The fixed text of the email and the voting page follow the account language; your subject and question go out as you wrote them.

post/surveys/{id}/send

Request

  • Base URL: https://api.oveyon.com/v1
  • URL: https://api.oveyon.com/v1/surveys/{id}/send
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

tostring email required

ASCII only: no accents; an international (IDN) domain only in its xn-- (punycode) form. Anything else is refused with reason: address_not_ascii.

metaobject

Your context (≤ 4 KB); comes back in the webhook and in the responses.

idempotencyKeystring

Response

Duplicate (idempotencyKey): the id of the ORIGINAL survey send (an integer — not the message id).

idinteger required
status'duplicate' required
messagestring required

Changes

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