admin
engagement-attempt-batches

Get Engagement Attempt Batch

Get a single engagement attempt batch with computed stats and cursor-paginated per-customer attempts.

get/admin/engagement-attempt-batches/{batch_id}

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

Path parameters

batch_idstring required

Query parameters

attempts_cursorstring nullable
attempts_limitinteger

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

Response

Successful Response

idstring required
statusstring required
expected_attemptsinteger required
runner_versionstring required
created_atstring date-time required
updated_atstring date-time required
campaign_send_idstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.