admin
admin

Update Engagement

put/admin/engagement/{engagement_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

engagement_idstring required

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
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
idstring
agent_v2_idstring nullable
contact_idstring nullable required
contact_method_idstring nullable
send_attempt_idstring nullable
override_channel_idstring nullable
latest_event_idstring nullable required
latest_event_atstring date-time nullable required
type'contact' | 'training' | 'ask_jenny' | 'slack' required
status'active' | 'inactive' | 'sent' | 'paused' | 'aborted' | 'never_replied' required
is_ai_allowed_to_respondboolean
is_simulatedboolean
sourcestring nullable
metadata_jsonobject nullable
tools_to_preloadobject[] nullable
compacted_historyobject nullable
last_compacted_event_idstring nullable
manually_booked_atstring date-time nullable
manually_booked_by_user_idstring nullable
hidden_atstring date-time nullable
hidden_by_user_idstring nullable

Response

Successful Response

idstring required
organization_idstring required
created_atstring date-time nullable
updated_atstring date-time nullable
deleted_atstring date-time nullable
agent_v2_idstring nullable
contact_idstring nullable
contact_method_idstring nullable
send_attempt_idstring nullable
override_channel_idstring nullable
latest_event_idstring nullable
latest_event_atstring date-time nullable
type'contact' | 'training' | 'ask_jenny' | 'slack' required
status'active' | 'inactive' | 'sent' | 'paused' | 'aborted' | 'never_replied' required
is_ai_allowed_to_respondboolean required
is_simulatedboolean required
sourcestring nullable
metadata_jsonobject nullable
tools_to_preloadobject[] nullable
compacted_historyobject nullable
last_compacted_event_idstring nullable
manually_booked_atstring date-time nullable
manually_booked_by_user_idstring nullable

Changes

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