POST reapitforms/v1/events/documents/statusupdate
Request Information
URI Parameters
None.
Body Parameters
DocumentStatusChangeWebhookPayloadName | 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": "6cc646b5-b331-476a-a730-6e1707a036a8", "OrganizationID": "754a0eb4-256d-4e63-8b0e-4125f0a5ac7c", "PreviousStatus": 3, "CurrentStatus": 0, "LastAction": 0, "ValidFromUTC": "2025-07-17T17:45:25.0911134+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>754a0eb4-256d-4e63-8b0e-4125f0a5ac7c</OrganisationID> <PreviousStatus>3</PreviousStatus> <ReferenceID>6cc646b5-b331-476a-a730-6e1707a036a8</ReferenceID> <ValidFromUTC>2025-07-17T17:45:25.0911134+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>754a0eb4-256d-4e63-8b0e-4125f0a5ac7c</OrganisationID><PreviousStatus>3</PreviousStatus><ReferenceID>6cc646b5-b331-476a-a730-6e1707a036a8</ReferenceID><ValidFromUTC>2025-07-17T17:45:25.0911134+00:00</ValidFromUTC></DocumentStatusChangeWebhookPayload>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | 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. |