|
Http Verb |
POST |
|---|---|
|
Url |
/documents/dynamic-forms/r1/sheets/{sheetId}/status |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2026 W1 (FSM 22.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API changes the status of a dynamic forms sheet.
The validations are:
-
Status must not be null
-
Valid status values: CANCELLED (2), CLOSED (3), FIXED (4)
Returns the ID of the sheet.
Path Parameters
|
Field |
|---|
|
sheetId |
Header Parameters
Default.
Request Body Parameters
|
Field |
Notes |
|---|---|
|
status |
Required. Status ID: 2 (CANCELLED), 3 (CLOSED), or 4 (FIXED) |
Response documentation
Response payload fields
|
Field |
Note |
Example value |
|---|---|---|
|
payload |
Id of the dynamic forms sheet |
|
Response error codes
NOT_FOUND, BASE_0001, BASE_0006, BASE_0007, BASE_0010