HomeDocumentationKnowledge HubSupportRelease NotesSearch Box
Documentation

Update end clients status in bulk

put
https://api.trulioo.com/wfs/interpreter-v2/end-clients/status

Note: Valid updates to status depend on the current state of the end client. Below are the possible status updates.

Current StateAllowed Next State
AbandonedN/A
AcceptedDeclined, Pending Review
In ProgressAbandoned
Not StartedN/A
DeclinedAccepted, Pending Review
Pending ReviewAccepted, Declined

If the passed status in the request is not permissible, then a 4111 error is returned. Refer Platform Errors for more information.

Body Params
endClientIds
array of strings

A list of unique identifiers for the clients to update. A maximum of 2000 IDs can be included.

endClientIds
string
enum

The new status to apply to all specified clients.
The request will be validated to ensure only permitted status transitions occur.

Allowed Transitions:

  • From Accepted to Declined or Pending Review
  • From In Progress to Abandoned
  • From Declinedto Accepted or Pending Review
  • From Pending Review to Accepted or Declined

Note: Leads with a status of Abandoned or Not Started cannot be updated.

Allowed:
string

A note detailing the reason for the status update.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

The status for the end clients was updated

401

Invalid token provided

Updated 18 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 18 days ago