POST reapitforms/v1/events/documents/statusupdate
Request Information
URI Parameters
None.
Body Parameters
DocumentStatusChangeWebhookPayload| Name | Description | Type | Additional information |
|---|---|---|---|
| ReferenceID | globally unique identifier |
None. |
|
| OrganizationID | globally unique identifier |
None. |
|
| PreviousStatus | integer |
None. |
|
| CurrentStatus | DocumentStatus |
None. |
|
| LastAction | DocumentActivity |
None. |
|
| ValidFromUTC | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"ReferenceID": "1e79285c-d27e-4109-9bf7-e94f85a74b51",
"OrganizationID": "8d7b7851-29b1-4f48-8ae5-2da8f7e34597",
"PreviousStatus": 3,
"CurrentStatus": 0,
"LastAction": 0,
"ValidFromUTC": "2025-12-29T10:08:45.355798+00:00"
}
application/xml, text/xml
Sample:
<DocumentStatusChangeWebhookPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.Business.Integration.ReapitForms.Jobs"> <CurrentStatus>None</CurrentStatus> <LastAction>None</LastAction> <OrganisationID>8d7b7851-29b1-4f48-8ae5-2da8f7e34597</OrganisationID> <PreviousStatus>3</PreviousStatus> <ReferenceID>1e79285c-d27e-4109-9bf7-e94f85a74b51</ReferenceID> <ValidFromUTC>2025-12-29T10:08:45.355798+00:00</ValidFromUTC> </DocumentStatusChangeWebhookPayload>
multipart/form-data
Sample:
<DocumentStatusChangeWebhookPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.Business.Integration.ReapitForms.Jobs"><CurrentStatus>None</CurrentStatus><LastAction>None</LastAction><OrganisationID>8d7b7851-29b1-4f48-8ae5-2da8f7e34597</OrganisationID><PreviousStatus>3</PreviousStatus><ReferenceID>1e79285c-d27e-4109-9bf7-e94f85a74b51</ReferenceID><ValidFromUTC>2025-12-29T10:08:45.355798+00:00</ValidFromUTC></DocumentStatusChangeWebhookPayload>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |