UPupsmith
admin
engagement-attempt-batches

Create Direct Engagement Batch

post/admin/engagement-attempt-batches/direct

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
variablesobject nullable
admin_opener_instructionstring nullable
sourcestring nullable
utmobject nullable
recent_contact_window_daysnumber nullable
idempotency_keystring nullable

Response

Successful Response

batch_idstring required
idempotency_keystring required
organization_idstring required
agent_v2_idstring required
contact_idstring required
contact_method_idstring required
statusstring required

Changes

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