POST/v1/submissions

Create a submission

Creates a submission for a bug report or feature request. Supply type, title, and email; email must use a valid email format. Optionally include device and operating system context, which is stored as device_context and takes precedence over parsed User-Agent values for fields you provide.

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

7 body fields

Submission details. type, title, and email are required; device context is optional.

typestringrequired
Submission type: `bug` or `feature`.
Allowed:bugfeature
titlestringrequired
The submission title.
bodystringoptional
The submission'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 submission in the `data` object.
dataobjectoptional
401Returned when the request is unauthenticated.
errorobjectoptional
429Returned when the request is rate-limited.
errorobjectoptional

Error handling

type, title, and email are required, and type must be bug or feature. 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.