CLIENT_STATUS_UPDATED

Called when the status of a client is updated

Submit this event using Firing an Event. Product configuration and enabled actions determine the workflow behavior. Use identifiers and snapshots from the same environment.

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 <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "CLIENT_STATUS_UPDATED",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "productId": "<UUID of the product ID>",
    "statusKey": "ACTIVE",
    "description": "<Description>",
    "clientAnswers": {
      "confirmation": true,
      "updatedBy": "<User identifier>"
    }
  }
}'

{
  "type": "CLIENT_STATUS_UPDATED",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "productId": "<UUID of the product ID>",
    "statusKey": "ACTIVE",
    "description": "<Description>",
    "clientAnswers": {
      "confirmation": true,
      "updatedBy": "<User identifier>"
    }
  }
}

Request Fields#

See the shared event envelope. Set type to CLIENT_STATUS_UPDATED and provide the payload below.

Payload Fields#

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

Response#

This example illustrates the common trigger response structure. Action counts and metadata depend on the actions that run; action-specific result fields are described where applicable.

{
  "triggerRequestId": "<UUID of the trigger request ID>",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response Fields#

Property	Description
`triggerRequestId`	UUID identifying this trigger execution.
`executedActionCount`	Number of actions reported as executed.
`expectedResponseCount`	Number of expected action responses.
`metadata`	Action-specific results; may be empty.

See Firing an Event for execution modes and response handling.