SupDesk
POST/v1/feedback

Create a feedback post

Creates a feedback post. Supply a title and a valid email; you can also include the post body, the reporter's name and locale, and device context. A 201 response returns the created feedback post.

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

6 body fields

Feedback post details. title and email are required.

titlestringrequired
The title of the feedback post.
bodystringoptional
The body or details of the feedback post.
emailstringrequired
The reporter's email address in a valid email format.
namestringoptional
The reporter's name.
localestringoptional
The reporter'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 not authenticated.
errorobjectoptional
429Returned when the request is rate limited.
errorobjectoptional

Error handling

A 401 is returned when the request is not authenticated, and a 429 is returned when the request is rate limited. title and email are required, and email must use a valid email format.