SupDesk API
POST/v1/feedback

Create a feedback post

Creates a feedback post from a title and submitter email address. Supply title and email; email must use a valid email format. You can also include the post body, submitter details, locale, or device context.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Feedback post details. title and email are required; device context is optional.

titlestringrequired
The feedback post title.
bodystringoptional
The feedback post's description or additional details.
emailstringrequired
The submitter's email address in a valid email format.
namestringoptional
The submitter's name.
localestringoptional
The submitter's locale.
deviceobjectoptional
Optional device/OS context for the reporting end user. Supplied values win per-field over the parsed User-Agent; the stored context is returned as device_context.

3 status codes
201Returns the created feedback post in the `data` object.
dataobjectoptional
401Returned when the request is unauthenticated.
errorobjectoptional
429Returned when the request is rate-limited.
errorobjectoptional

Error handling

title and email are required. A 401 is returned when the request is unauthenticated, and a 429 is returned when the request is rate-limited. email must use a valid email format; each supplied device context value must be no longer than 64 characters.