Skip to content

Update event session

Moves an event session or changes its place.

Needs the product:write scope.

Call

  • Tool: update_event_session
  • Scope: product:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
product object Yes
session object Yes
starts_at string No When it starts, an ISO 8601 timestamp.
ends_at string No When it ends, after it starts, an ISO 8601 timestamp.
time_zone string No The IANA time zone it is shown in, e.g. Europe/Rome.
venue string or null No Where it takes place in person, trimmed, with no line break or control character.
online_label string or null No How it is joined online, e.g. Zoom: a label everyone sees, never a link, trimmed, with no line break or control character.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "session": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "starts_at": {
      "description": "When it starts, an ISO 8601 timestamp.",
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
    },
    "ends_at": {
      "description": "When it ends, after it starts, an ISO 8601 timestamp.",
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
    },
    "time_zone": {
      "description": "The IANA time zone it is shown in, e.g. `Europe/Rome`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "venue": {
      "description": "Where it takes place in person, trimmed, with no line break or control character.",
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "pattern": "^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"
        },
        {
          "type": "null"
        }
      ]
    },
    "online_label": {
      "description": "How it is joined online, e.g. `Zoom`: a label everyone sees, never a link, trimmed, with no line break or control character.",
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "pattern": "^(?!.*(?::\\/\\/|[\\w-]+(?:\\.[\\w-]+)+\\/))[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "product",
    "session"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
product_id string Yes
starts_at string Yes
ends_at string Yes
time_zone string Yes An IANA time zone, e.g. Europe/Rome.
venue string or null Yes Where it takes place in person, or null for none.
online_label string or null Yes How it is joined online, e.g. Zoom, or null for none.
created_at string Yes
updated_at string Yes

The answer’s full shape is on its API reference page.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_found: nothing matches a reference given.
  • conflict: the call clashes with the current state; context names the field and, where it helps, its current value, and for a from, live, expect or version that no longer matches, the argument (path) and what it takes (reason).
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
  • client-fault: the server failed around the call. core_answer ok means the write landed, so don’t send it again. When reached_core is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close