Change a submission category

Move a public submission to a different category.


PATCH/api/v1/forms/{formId}/submissions/{submissionId}/category

Authorization

Authorization required string · header
Send Bearer <token> with an account API key that has the submissions:write scope.

Path parameters

formId required string
Form ID. See FormModel.
submissionId required string
The 24-character hexadecimal submission ID. See SubmissionModel.

Request body

application/json

category required string
inbox, spam, starred, or archive. See SubmissionCategoryEnum.

Response

200 · application/json

Source model: SubmissionModel.

FieldTypeDescription
idstringID returned by the operation.
categorystringSubmission category. See SubmissionCategoryEnum.