Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview

Update event

Apply a partial update to an event.

Access control

  • Restricted tokens need the API scope api.everything_else
PUT/v2/events/id/{event_id}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
event_idstringrequired
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Request body
requiredapplication/json
namestring | null
Show properties
Any of:
string
string
null
null
descriptionstring | null
Show properties
Any of:
string
string
null
null
null
null
start_timeinteger | null
Show properties
Any of:
integer
integer
null
null
end_timeinteger | null
Show properties
Any of:
integer
integer
null
null
topicsEventTopicRequest[] | null
Show properties
Any of:
EventTopicRequest[]
Array of EventTopicRequest
topic_idstringrequired
field_idsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
null
null
metadata_changesetMetadataChangeset | null
Show properties
Any of:
MetadataChangeset
put_tagsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
string[]
Array of string
string
null
null
remove_tagsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
string[]
Array of string
string
null
null
put_fieldsobject | null
default: null
Show properties
Any of:
object
object
null
null
remove_fieldsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
string[]
Array of string
string
null
null
replace_allboolean
default: false
null
null
display_options_changesetEventDisplayOptionsChangeset | null
Show properties
Any of:
EventDisplayOptionsChangeset
colorstring | null
Show properties
Any of:
string
string
null
null
null
null
null
null
custom_fields_changesetCustomFieldChangeset | null
default: null
Show properties
Any of:
CustomFieldChangeset
set_fieldsobject | null
default: null
Show properties
Any of:
object
object
null
null
clear_fieldsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
string[]
Array of string
string
null
null
null
null
Responses
200

OK

dataobjectrequired

A wire-transmissible representation of an event that belongs to a session.

Show properties
event_idstringrequired
org_idstringrequired
namestringrequired
descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
session_idstringrequired
topicsEventTopic[]
Show properties
Array of EventTopic
topic_idstringrequired
topic_namestringrequired
fieldsEventTopicField[] | null
default: null
Show properties
Any of:
EventTopicField[]
Array of EventTopicField
field_idstringrequired
path_in_schemastring[]required
null
null
start_timeintegerrequired
end_timeintegerrequired
tagsstring[]
metadataobject
custom_fieldsobject
display_optionsEventDisplayOptions | null
default: null
Show properties
Any of:
EventDisplayOptions
colorstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
createdstring<date-time>required
created_bystringrequired
modifiedstring<date-time>required
modified_bystringrequired
400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
401

Thrown when authentication fails

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
403

Thrown if an operation would exceed a user or org level limit.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
410

Thrown if a resource is missing or expired.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
501

Thrown by shimmed out APIs which have not yet been implemented

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PUT 'https://api.roboto.ai/v2/events/id/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "start_time": 0,
  "end_time": 0,
  "topics": [
    {
      "topic_id": "string",
      "field_ids": null
    }
  ],
  "metadata_changeset": {
    "put_tags": null,
    "remove_tags": null,
    "put_fields": null,
    "remove_fields": null,
    "replace_all": false
  },
  "display_options_changeset": {
    "color": "string"
  },
  "custom_fields_changeset": null
}'
Response
{
  "data": {
    "event_id": "string",
    "org_id": "string",
    "name": "string",
    "description": null,
    "session_id": "string",
    "topics": [
      {
        "topic_id": "string",
        "topic_name": "string",
        "fields": null
      }
    ],
    "start_time": 0,
    "end_time": 0,
    "tags": [
      "string"
    ],
    "metadata": {},
    "custom_fields": {},
    "display_options": null,
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string"
  }
}

Was this page helpful?