SmartAdvocate

Create Smartadvocate Case Status Rule

Changed on

Create a case status routing rule for the customer.

post/smartadvocate/case-status-rules

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/smartadvocate/case-status-rules
  • Auth: none declared

Request body

sa_status_idinteger required
status_namestring required
status_type_namestring nullable
destination_kind'destination' | 'case_staff' | 'take_message' required
transfer_destination_idstring uuid nullable

Required when destination_kind is 'destination'; must be omitted for any other kind

staff_rolestring nullable

Required when destination_kind is 'case_staff', e.g. 'Negotiator'; must be omitted for any other kind. A 'take_message' rule carries neither target field - the agent takes a message about the case instead of transferring

spoken_status_phrasestring nullable

Plain-English phrase the voice agent reads aloud verbatim when a caller asks where the case stands. Must be wording a caller can understand - never internal jargon, a stage code, a date or a dollar figure. Omit for no phrase, in which case the agent only says whether the case is active or closed

records_emailstring nullable

Email address the voice agent gives a medical provider who wants to send records or bills for a case in this status, e.g. liens@firm.com. Omit for no email

activeboolean

Response

Successful Response

smartadvocate_case_status_rule_idstring uuid required
sa_status_idinteger required
status_namestring required
status_type_namestring nullable

None = primary case status rule; otherwise the second-status type this rule matches within

destination_kind'destination' | 'case_staff' | 'take_message' required
transfer_destination_idstring uuid nullable
staff_rolestring nullable
spoken_status_phrasestring nullable

Plain-English phrase the voice agent reads aloud verbatim when a caller asks where the case stands, e.g. 'The case has settled and the team is preparing the closing statement'. Must be wording a caller can understand - never internal jargon, a stage code, a date or a dollar figure. None = the agent only says whether the case is active or closed

records_emailstring nullable

Email address the voice agent gives a medical provider who wants to send records or bills for a case in this status, e.g. liens@firm.com. None = no email for this status

activeboolean required

Changes

  • 5d668a9fc9ddRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 28867c1dbb52Revision changes
    • warning

      added the new take_message enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new take_message enum value to the request property

    • info

      added the optional property to the response with the status