Escalation Reachability

post/internal/notifications/escalation-reachability

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

organization_idstring required
agent_v2_idsstring[]
roster_idsstring[]
check_recipientsboolean

Response

Successful Response

module_activeboolean required
subscribed_countinteger
reachable_countinteger
reason_countsobject
source'subscriptions' | 'rules'

Which configuration the counts were read from. Only the rules route an escalation, so only RULES is produced; the field is still served for a caller deployed before that was true.

rule_countinteger
invalid_rule_countinteger
rotation_countinteger
empty_rotation_idsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.