POST reapitforms/v1/events/documents/statusupdate

Request Information

URI Parameters

None.

Body Parameters

Name	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.
DocumentType	DocumentType	None.
PdfAvailable	boolean	None.
RedactedPdfAvailable	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ReferenceID": "8a9a63f6-0b20-4364-a380-398a45dbcb94",
  "OrganizationID": "e868e8e7-b59f-4303-9292-654447b97760",
  "PreviousStatus": 3,
  "CurrentStatus": 0,
  "LastAction": 0,
  "ValidFromUTC": "2026-06-03T10:47:34.4823594+00:00",
  "DocumentType": 0,
  "PdfAvailable": true,
  "RedactedPdfAvailable": true
}

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>
  <DocumentType>Standard</DocumentType>
  <LastAction>None</LastAction>
  <OrganisationID>e868e8e7-b59f-4303-9292-654447b97760</OrganisationID>
  <PdfAvailable>true</PdfAvailable>
  <PreviousStatus>3</PreviousStatus>
  <RedactedPdfAvailable>true</RedactedPdfAvailable>
  <ReferenceID>8a9a63f6-0b20-4364-a380-398a45dbcb94</ReferenceID>
  <ValidFromUTC>2026-06-03T10:47:34.4823594+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><DocumentType>Standard</DocumentType><LastAction>None</LastAction><OrganisationID>e868e8e7-b59f-4303-9292-654447b97760</OrganisationID><PdfAvailable>true</PdfAvailable><PreviousStatus>3</PreviousStatus><RedactedPdfAvailable>true</RedactedPdfAvailable><ReferenceID>8a9a63f6-0b20-4364-a380-398a45dbcb94</ReferenceID><ValidFromUTC>2026-06-03T10:47:34.4823594+00:00</ValidFromUTC></DocumentStatusChangeWebhookPayload>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	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.