Skip to main content
PATCH
/
interventions
/
v2
/
rs
/
{interventionId}
/
verify
Accept or reject intervention verification
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/interventions/v2/rs/{interventionId}/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "decisionComment": "Provider refused the intervention due to scheduling conflicts.",
  "decision": 2,
  "notificationId": "notification-12345"
}
'
{
  "data": {
    "id": 1,
    "status": 2,
    "type": 1,
    "description": "Description of the intervention",
    "imgSignature": "Signature image",
    "codePin": 123456,
    "autoCreated": true,
    "creationStatus": 1,
    "scheduledStart": "2024-12-01T12:34:56.000Z",
    "scheduledEnd": "2024-12-05T14:56:23.000Z",
    "actualStart": "2024-12-01T12:34:56.000Z",
    "actualEnd": "2024-12-01T12:34:56.000Z",
    "providerName": "Provider name",
    "providerEmail": "example@mail.fr",
    "providerActionComment": "Action comment from the provider",
    "providerGeneralComment": "General comment from the provider",
    "assignedCompanyContactId": 1,
    "assignedUserId": 1,
    "verifiedByUserId": 1,
    "verifiedAt": "2024-12-09T14:23:00.000Z",
    "decisionComment": "Provider refused the intervention due to scheduling conflicts.",
    "attendeeCount": 25,
    "routineId": 1,
    "organizationId": 1,
    "createdByUserId": 1,
    "archivedAt": "2024-12-09T14:23:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

interventionId
integer
required

Unique identifier of the intervention.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Body

application/json

Details required to verify an intervention

decisionComment
string
required

Reason for refusing the intervention.

Maximum string length: 2500
Example:

"Provider refused the intervention due to scheduling conflicts."

decision
enum<number>
required

Client approval decision on intervention. Available values:

  • 1: accept
  • 2: reject
Available options:
1,
2
Example:

2

notificationId
string

Notification ID to mark the notification as read.

Example:

"notification-12345"

Response

200 - application/json

The intervention has been verified

data
object
required