Skip to content
Oclavex is in private preview, available to selected users. Public signup is blocked. Request access at [email protected].

Submits a feature request, problem report or general comment. Accepted with the caller's own license-session token — the same credential they activated with — so an end user can tell the vendor something without an account or a separate sign-in.

POST
/api/v1/provision/consumer/me/feedback
curl --request POST \
--url https://example.com/api/v1/provision/consumer/me/feedback \
--header 'Content-Type: application/json' \
--data '{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "FeatureRequest", "title": "example", "body": "example", "featureCatalogId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "applicationVersion": "example", "location": "example", "isSecurityIssue": true, "contactEmail": "example" }'

Distinct from rating: a rating is a 1–5 score that gets aggregated, this is prose that gets a decision. Product, entitlement, device and reply address are resolved from the session, never taken from the body.

The caller’s session and what they want to say.

Feedback volunteered by an end user — a feature request, a problem report, or a plain comment. Distinct from a feature rating, which is a 1–5 score about one catalog feature: this carries prose and gets a decision, a rating gets aggregated.

object
sessionId

The caller’s license session; the entitlement and product are resolved from it.

string format: uuid
kind

What kind of thing the user is telling you.

Allowed values: FeatureRequest ProblemReport GeneralComment
title
required

One line summarising the request or problem.

string
0 <= 100 characters
body
required

The detail: what the user wants, or what went wrong and what they were doing.

string
0 <= 5120 characters
featureCatalogId

The feature this is about, if the user was working in one. Omit when it is not about a feature.

null | string format: uuid
applicationVersion

The version of your application the user is running. Shown in your Feedback inbox.

null | string
0 <= 100 characters
location

Where in your application the user was: a page, screen or route. Shown in your Feedback inbox.

null | string
0 <= 255 characters
isSecurityIssue

The user says this is a security issue. The item carries a Security label in your inbox, and the Feedback webhooks leave out its title and description.

boolean
contactEmail

Where a reply should go, for an application whose license session is not tied to the signed-in user, for example one activated per machine. An email address in the session’s own token wins.

null | string
0 <= 254 characters

OK

A piece of feedback and what has been decided about it.

object
id
string format: uuid
kind

What kind of thing the user is telling you.

Allowed values: FeatureRequest ProblemReport GeneralComment
title
string
body
string
submittedAt
string format: date-time
entitlementId
string format: uuid
productId
string format: uuid
featureCatalogId
null | string format: uuid
requesterEmail

Where a reply would go. Empty for a pure device activation that left no address — the feedback is still worth reading, it just cannot be answered.

null | string
deviceName

The device it was submitted from, when the session recorded one.

null | string
applicationVersion

The application version the sender reported, if any.

null | string
location

The page or screen the sender was on, if the application reported one.

null | string
isSecurityIssue

Labelled a security issue, by the sender or by you. Feedback webhooks leave out its title and description.

boolean
status

Where a piece of feedback has got to.

Allowed values: New Accepted Declined Duplicate
reviewedBy

Who decided, and when — both null while the item is still New.

null | string
reviewedAt
null | string format: date-time
reviewNote

The reviewer’s note, shown to the reporter as the reason.

null | string
duplicateOfId

The item this duplicates; set only when FeedbackStatusDto FeedbackItemDto.Status is Duplicate.

null | string format: uuid

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Unauthorized

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Conflict

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string