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": "734290af-a230-4305-8660-a3bb81b728f6", "OrganizationID": "6862dd77-08ff-451b-a0b4-a36979bf2707", "PreviousStatus": 3, "CurrentStatus": 0, "LastAction": 0, "ValidFromUTC": "2025-09-18T02:02:17.6703707+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>6862dd77-08ff-451b-a0b4-a36979bf2707</OrganisationID> <PreviousStatus>3</PreviousStatus> <ReferenceID>734290af-a230-4305-8660-a3bb81b728f6</ReferenceID> <ValidFromUTC>2025-09-18T02:02:17.6703707+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>6862dd77-08ff-451b-a0b4-a36979bf2707</OrganisationID><PreviousStatus>3</PreviousStatus><ReferenceID>734290af-a230-4305-8660-a3bb81b728f6</ReferenceID><ValidFromUTC>2025-09-18T02:02:17.6703707+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. |