UPupsmith
admin
engagement-attempt-batches

Create Engagement Attempt Batch

Create an engagement attempt batch via the in-process engagement domain.

Resolves the org from the body and assigns context.organization so the downstream handler scopes to it.

post/admin/engagement-attempt-batches

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
st_customer_idsinteger[] nullable
contact_idsstring[] nullable
variablesobject nullable
variables_override_by_customer_idobject nullable
st_location_id_by_customer_idobject nullable
admin_opener_instructionstring nullable
lead_idstring nullable
sourcestring nullable
utmobject nullable
override_channel_idstring nullable
recent_contact_window_daysnumber nullable
idempotency_keystring nullable
runner_versionstring
is_simulatedboolean
defer_initial_turnboolean
customer_initiatedboolean

Response

Successful Response

idstring required
organization_idstring required
agent_v2_idstring nullable
statusstring required
expected_attemptsinteger required

Changes

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