Approve, reject, or revert form element submission

curl --request PATCH \
  --url https://app.azalt.co/api/v1/form-element-submissions/{formElementSubmissionId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "id": "<string>",
  "formSubmissionId": "<string>",
  "formElementId": "<string>",
  "periodUnit": 123,
  "sequence": 123,
  "activityId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "organizationId": "<string>",
  "docs": [
    "<unknown>"
  ],
  "recordedAt": "<string>",
  "value": "<unknown>",
  "originalValue": null,
  "selectedUnitId": "<string>",
  "comments": [
    "<unknown>"
  ]
}

FormElementSubmission

Approve, reject, or revert form element submission

Approve, reject, or revert a specific form element submission.

Note: For ACTIVITY elements, this action applies to all submissions for the same form element and period within the same form submission (site + year), ensuring consistent status across multiple activity rows in that period.

Workflow Actions:

approve: Sets the submission status to “APPROVED”
reject: Sets the submission status to “REJECTED”
revert: Sets the submission status back to “COMPLETED” (pending approval)

Permission Requirements:

User must have APPROVER, MANAGER, or OWNER role in the organization
User must have access to the site where the form is deployed
The form element submission must belong to the user’s organization

Parameters:

formElementSubmissionId: The unique identifier of the form element submission to approve/reject/revert
action: One of “approve”, “reject”, or “revert”
reason: Optional reason for the approval/rejection/revert action

This endpoint is essential for workflow management and quality control in data collection processes.

PATCH

form-element-submissions

{formElementSubmissionId}

status

Approve, reject, or revert form element submission

curl --request PATCH \
  --url https://app.azalt.co/api/v1/form-element-submissions/{formElementSubmissionId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "id": "<string>",
  "formSubmissionId": "<string>",
  "formElementId": "<string>",
  "periodUnit": 123,
  "sequence": 123,
  "activityId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "organizationId": "<string>",
  "docs": [
    "<unknown>"
  ],
  "recordedAt": "<string>",
  "value": "<unknown>",
  "originalValue": null,
  "selectedUnitId": "<string>",
  "comments": [
    "<unknown>"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

formElementSubmissionId

string

required

Body

application/json

action

enum<string>

required

Available options:

approve,

reject,

revert

reason

string

Response

Successful response

string

required

formSubmissionId

string

required

formElementId

string

required

periodUnit

number

required

sequence

number

required

activityId

string | null

required

status

enum<string>

required

Available options:

COMPLETED,

APPROVED,

REJECTED

createdAt

string

required

updatedAt

string

required

organizationId

string | null

required

docs

any[]

required

recordedAt

string | null

required

value

any

originalValue

unknown

selectedUnitId

string | null

comments

any[]

Preview form element submissions import Bulk approve, reject, or revert form element submissions