NPS/CSAT surveys

Replace a survey (kind is ignored)

put/surveys/{id}

Request

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

Path parameters

idinteger required

Request body

kind'nps' | 'csat' required

Cannot change after creation.

namestring required
subjectstring required
fromEmailstring required

A domain of your account. ASCII only (an IDN domain in xn-- form) — otherwise 400 with reason: address_not_ascii.

fromNamestring
questionstring

Optional. Empty = the canonical wording of the kind, in the account language (the language of the platform emails you receive: Portuguese for an account from Brazil, English for all others). Once saved it is your text; nothing rewrites it.

throttleDaysinteger
brandColorstring
logoUrlstring uri
activeboolean

Response

Updated

idinteger
kind'nps' | 'csat'
namestring
subjectstring
fromEmailstring
fromNamestring nullable
questionstring
throttleDaysinteger
brandColorstring nullable
logoUrlstring nullable
activeboolean

Changes

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