admin
engagement-attempt-batches

Preflight Direct Engagement Batch

post/admin/engagement-attempt-batches/direct/preflight

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
    • or HTTP bearer

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_idstring required
phone_numberstring required
selected_contact_method_idstring nullable
is_simulatedboolean

Response

Successful Response

normalized_phonestring required
match_status'none' | 'unique' | 'ambiguous' | 'selected' required
tool_functionsstring[]
warningsstring[]
blockersstring[]
can_startboolean required

Changes

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