POST reapitforms/v1/events/documents/statusupdate

Request Information

URI Parameters

None.

Body Parameters

DocumentStatusChangeWebhookPayload
NameDescriptionTypeAdditional 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": "068508ca-4158-4c82-b810-ab6c0c9b04a0",
  "OrganizationID": "a3beeb57-a7ae-41ca-941e-804eb97695be",
  "PreviousStatus": 3,
  "CurrentStatus": 0,
  "LastAction": 0,
  "ValidFromUTC": "2025-07-11T11:38:40.7918304+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>a3beeb57-a7ae-41ca-941e-804eb97695be</OrganisationID>
  <PreviousStatus>3</PreviousStatus>
  <ReferenceID>068508ca-4158-4c82-b810-ab6c0c9b04a0</ReferenceID>
  <ValidFromUTC>2025-07-11T11:38:40.7918304+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>a3beeb57-a7ae-41ca-941e-804eb97695be</OrganisationID><PreviousStatus>3</PreviousStatus><ReferenceID>068508ca-4158-4c82-b810-ab6c0c9b04a0</ReferenceID><ValidFromUTC>2025-07-11T11:38:40.7918304+00:00</ValidFromUTC></DocumentStatusChangeWebhookPayload>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.