Change Form Stage
Move a form submission to a new stage.
Last updated
Was this helpful?
Was this helpful?
local Sonoran = require("sonoran")
local sonoran = Sonoran.createClient({
product = Sonoran.productEnums.CMS,
apiKey = "YOUR_API_KEY",
communityId = "YOUR_COMMUNITY_ID",
defaultServerId = 1,
timeoutMs = 30000,
})
local formId = 1
local payload = {
["accId"] = "00000000-0000-0000-0000-000000000000",
["newStageId"] = "review",
["optionalReason"] = "Reviewed manually."
}
local response = sonoran.cms:changeFormStageV2(formId, payload)
if response.success then
print(response.data)
else
print(response.reason)
endconst Sonoran = require("sonoran.js");
const instance = Sonoran.instance({
apiKey: "YOUR_API_KEY",
communityId: "YOUR_COMMUNITY_ID",
product: Sonoran.productEnums.CMS,
serverId: 1,
});
async function main() {
const formId = 1;
const payload = {
"accId": "00000000-0000-0000-0000-000000000000",
"newStageId": "review",
"optionalReason": "Reviewed manually."
};
const response = await instance.cms.changeFormStageV2(formId, payload);
if (response.success) {
console.log(response.data);
} else {
console.error(response.reason);
}
}
main().catch((error) => {
console.error(error);
});from sonoran import Instance, productEnums
instance = Instance(
apiKey="YOUR_API_KEY",
communityId="YOUR_COMMUNITY_ID",
product=productEnums.CMS,
serverId=1,
)
formId = 1
payload = {
"accId": "00000000-0000-0000-0000-000000000000",
"newStageId": "review",
"optionalReason": "Reviewed manually."
}
response = instance.cms.changeFormStageV2(formId, payload)
if response.success:
print(response.data)
else:
print(response.reason)using Sonoran;
using System.Text.Json;
using var sonoran = new SonoranClient(new SonoranClientOptions
{
product = SonoranProduct.CMS,
apiKey = "YOUR_API_KEY",
communityId = "YOUR_COMMUNITY_ID",
defaultServerId = 1
});
var formId = 1;
var payload = new {
accId = "00000000-0000-0000-0000-000000000000",
newStageId = "review",
optionalReason = "Reviewed manually."
};
var response = await sonoran.Cms.changeFormStageV2(formId, payload);
if (response.success)
{
Console.WriteLine(JsonSerializer.Serialize(response.data));
}
else
{
Console.WriteLine(response.reason);
}openapi: "3.0.3"
info:
title: "Sonoran CMS v2 - Change Stage"
version: "1.0.0"
description: "Move a form submission to a new stage."
servers:
-
url: "https://api.sonorancms.com"
paths:
/v2/community/forms/{formId}/stage:
patch:
summary: "Change Stage"
operationId: "changeFormStage"
parameters:
-
description: "Target form id."
name: "formId"
in: "path"
schema:
type: "integer"
required: true
requestBody:
required: true
content:
application/json:
schema:
type: "object"
security:
-
bearerAuth: []
responses:
"200":
description: "Successful response"
content:
application/json:
schema:
type: "object"
example:
success: true
data:
authorized: true
failed: false
data:
form:
formId: 42
sysStatus: true
submissionTime: "2026-04-15T00:00:00.000Z"
lastActionTime: "2026-04-15T00:00:00.000Z"
formSubmitter: "00000000-0000-0000-0000-000000000000"
formContextUser: null
relatedUsers: []
formStructure:
_label: "Example Form Submission"
fields: []
formComments:
comments: []
stageId: "22222222-2222-2222-2222-222222222222"
stageGroupId: "11111111-1111-1111-1111-111111111111"
stageInfoBackup:
stages: []
groups: []
formTemplateId: 100
formType: 0
formReplySettings:
locked: false
submitter: true
rankIds: []
showInProfile: false
stages: []
newStage:
id: "33333333-3333-3333-3333-333333333333"
label: "Interview"
availableStages:
-
id: "44444444-4444-4444-4444-444444444444"
label: "Training"
meta:
timestamp: "2026-04-15T00:00:00.000Z"
path: "/v2/community/forms/1/stage"
components:
securitySchemes:
bearerAuth:
type: "http"
scheme: "bearer"
bearerFormat: "JWT"curl --request PATCH \
--url "https://api.sonorancms.com/v2/community/forms/1/stage" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json" \
--data '{"accId":"00000000-0000-0000-0000-000000000000","newStageId":"review","optionalReason":"Reviewed manually."}'
{
"success": true,
"data": {
"authorized": true,
"failed": false,
"data": {
"form": {
"formId": 42,
"sysStatus": true,
"submissionTime": "2026-04-15T00:00:00.000Z",
"lastActionTime": "2026-04-15T00:00:00.000Z",
"formSubmitter": "00000000-0000-0000-0000-000000000000",
"formContextUser": null,
"relatedUsers": [],
"formStructure": {
"_label": "Example Form Submission",
"fields": []
},
"formComments": {
"comments": []
},
"stageId": "22222222-2222-2222-2222-222222222222",
"stageGroupId": "11111111-1111-1111-1111-111111111111",
"stageInfoBackup": {
"stages": [],
"groups": []
},
"formTemplateId": 100,
"formType": 0,
"formReplySettings": {
"locked": false,
"submitter": true,
"rankIds": []
},
"showInProfile": false,
"stages": []
},
"newStage": {
"id": "33333333-3333-3333-3333-333333333333",
"label": "Interview"
},
"availableStages": [
{
"id": "44444444-4444-4444-4444-444444444444",
"label": "Training"
}
]
}
},
"meta": {
"timestamp": "2026-04-15T00:00:00.000Z",
"path": "/v2/community/forms/1/stage"
}
}