Update a shipwell automation event

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

automationEventId
required
string <uuid>

The id of the shipment automation event

Request Body schema: application/json
required
answered_by_machine
boolean
completed_at
string or null <date-time>
conversation_status
string or null
Enum: "busy" "canceled" "completed" "failed" "in-progress" "no-answer" "queued" "ringing"
created_at
string or null <date-time>
estimated_eta
string or null <date-time>
estimated_location_name
string or null
id
string or null <uuid>
parsed_message
string or null
recorded_audio
string or null

URL to an mp3 file holding recorded audio of the conversation of the event, if exists

response_message
string or null
resulting_alert_level
string or null
Enum: "HIGH" "MEDIUM" "LOW"
object (User)
scheduled_for
required
string <date-time>
shipment
string or null <uuid>
source
required
string
Enum: "CALL" "TEXT" "EMAIL"
sub_type
required
string
Enum: "LOCATION_CHECK_IN" "PRE_PICKUP"
timeline_ordering_timestamp
string or null <date-time>

Timestamp used in the default ordering of events. Will use completed_at if it is not null, otherwise will fall back on scheduled_for.

type
required
string
Enum: "CALL" "TEXT" "EMAIL"
updated_at
string or null <date-time>
Responses
200

Updated automation event

Response Schema: application/json
answered_by_machine
boolean
completed_at
string or null <date-time>
conversation_status
string or null
Enum: "busy" "canceled" "completed" "failed" "in-progress" "no-answer" "queued" "ringing"
created_at
string or null <date-time>
estimated_eta
string or null <date-time>
estimated_location_name
string or null
id
string or null <uuid>
parsed_message
string or null
recorded_audio
string or null

URL to an mp3 file holding recorded audio of the conversation of the event, if exists

response_message
string or null
resulting_alert_level
string or null
Enum: "HIGH" "MEDIUM" "LOW"
object (User)
scheduled_for
required
string <date-time>
shipment
string or null <uuid>
source
required
string
Enum: "CALL" "TEXT" "EMAIL"
sub_type
required
string
Enum: "LOCATION_CHECK_IN" "PRE_PICKUP"
timeline_ordering_timestamp
string or null <date-time>

Timestamp used in the default ordering of events. Will use completed_at if it is not null, otherwise will fall back on scheduled_for.

type
required
string
Enum: "CALL" "TEXT" "EMAIL"
updated_at
string or null <date-time>
default

Default error response

put/shipments/{shipmentId}/automation/events/{automationEventId}/
Request samples
application/json
{
  • "answered_by_machine": true,
  • "completed_at": "2019-08-24T14:15:22Z",
  • "conversation_status": "busy",
  • "created_at": "2019-08-24T14:15:22Z",
  • "estimated_eta": "2019-08-24T14:15:22Z",
  • "estimated_location_name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parsed_message": "string",
  • "recorded_audio": "string",
  • "response_message": "string",
  • "resulting_alert_level": "HIGH",
  • "scheduled_by_user": {
    },
  • "scheduled_for": "2019-08-24T14:15:22Z",
  • "shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
  • "source": "CALL",
  • "sub_type": "LOCATION_CHECK_IN",
  • "timeline_ordering_timestamp": "2019-08-24T14:15:22Z",
  • "type": "CALL",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "answered_by_machine": true,
  • "completed_at": "2019-08-24T14:15:22Z",
  • "conversation_status": "busy",
  • "created_at": "2019-08-24T14:15:22Z",
  • "estimated_eta": "2019-08-24T14:15:22Z",
  • "estimated_location_name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parsed_message": "string",
  • "recorded_audio": "string",
  • "response_message": "string",
  • "resulting_alert_level": "HIGH",
  • "scheduled_by_user": {
    },
  • "scheduled_for": "2019-08-24T14:15:22Z",
  • "shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
  • "source": "CALL",
  • "sub_type": "LOCATION_CHECK_IN",
  • "timeline_ordering_timestamp": "2019-08-24T14:15:22Z",
  • "type": "CALL",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.