CLIENT_STATUS_UPDATED

This event is fired when the status of a client is updated with CLIENT_STATUS_UPDATED action

When and what fires this event?

If this event is defined for a client, and the associated actions are enabled:

Copilot: fires when a user updates a client's status;
API: can fire this event externally on demand.

Request payload

POST: https://api.{ENV}.dais.com/ioi/v3/event/fire

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <yourAuthHere>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "CLIENT_STATUS_UPDATED",
  "payload": {
      "clientId": "<UUID of the client>",
      "productId": "<UUID of the product>",
      "statusKey": "ACTIVE",
      "description": "Client moved to active status",
      "clientAnswers": {}
  }
}'

{
  "type": "CLIENT_STATUS_UPDATED",
  "payload": {
    "clientId": "9fca0c23-7e8d-4e3b-bc14-4f408c422a7f",
    "productId": "c41288e7-2a5b-4f5d-9c79-f8331e09a653",
    "statusKey": "ACTIVE",
    "description": "Client status changed to active after policy issuance",
    "clientAnswers": {
      "confirmation": true,
      "updatedBy": "AgentPortal"
    }
  }
}

Request fields

Property	Required	Description
`type`	`true`	Must be set to `CLIENT_STATUS_UPDATED`.
`payload`	`true`	See Payload fields below.

Payload fields

Property	Required	Type	Description
`clientId`	`true`	UUID	Unique identifier of the client whose status has been updated.
`productId`	`true`	UUID	Identifier of the associated product or policy line.
`statusKey`	`true`	String	Key of the new client status (e.g., "ACTIVE", "SUSPENDED").
`description`	`false`	String	Optional description or reason for the status change.
`clientAnswers`	`false`	Map	Optional custom data or form responses related to the client.

Response json

{
  "success": true,
  "message": "Event fired successfully",
  "data": {
    "triggerRequestId": "ff55a520-5194-4b6f-b84d-3457f189c5cf",
    "executedActionCount": 1,
    "expectedResponseCount": 1
  },
  "timestamp": "2025-01-17T12:00:00.000Z"
}

Response fields

Property	Required	Description
`success`	`true`	Request status
`message`	`true`	Status message
`data`	`true`	Response data
`timestamp`	`true`	Response timestamp

Data fields

Property	Required	Description
`triggerRequestId`	`true`	Request identifier
`executedActionCount`	`true`	Actions executed
`expectedResponseCount`	`true`	Expected responses