---
title: Sessions
slug: docs/2IXx-sessions
createdAt: 2026-07-08T06:19:27.803Z
---

The **Sessions** endpoint sends a Session out of your event. Its endpoint is served at `/updates/api/{endpoint-uuid}/sessions`.

## How it works

The template is the shape of the payload you want out. Each key is yours to name; the merge tag on the right supplies the value for each Session at send time. Every field here is plain text, so every tag stays quoted.

`active` and `archived` use the `<<TAG|true:true,false:false>>` form. They render as the strings `"true"` and `"false"`.

## Sample mapping

:::BlockQuote
\{
&#x20;   "event\_id": "\<\<EVENT\_ID>>",
&#x20;   "event\_name": "\<\<EVENT\_NAME>>",
&#x20;   "resource\_id": "\<\<RESOURCE\_ID>>",
&#x20;   "organisation\_uid": "\<\<ORGANISATION\_UID>>",
&#x20;   "code": "\<\<CODE>>",
&#x20;   "name": "\<\<NAME>>",
&#x20;   "description": "\<\<DESCRIPTION>>",
&#x20;   "capacity": "\<\<CAPACITY>>",
&#x20;   "start\_time": "\<\<START\_TIME>>",
&#x20;   "finish\_time": "\<\<FINISH\_TIME>>",
&#x20;   "location\_name": "\<\<LOCATION\_NAME>>",
&#x20;   "active": "\<\<ACTIVE|true\:true,false\:false>>",
&#x20;   "archived": "\<\<ARCHIVED|true\:true,false\:false>>",
&#x20;   "updated\_at": "\<\<UPDATED\_AT>>",
&#x20;   "created\_at": "\<\<CREATED\_AT>>"
}
:::

## Sample output

One rendered Session from the array the endpoint returns:

:::BlockQuote
\{
&#x20; "event\_id": "your-instance/event/3365",
&#x20; "event\_name": "Platform Summit 2026",
&#x20; "resource\_id": "your-instance/session/1287",
&#x20; "organisation\_uid": "5f7c9721-ee02-45f7-b0e2-89a1da1dcdbb",
&#x20; "code": "SES-001",
&#x20; "name": "Building on the Platform API",
&#x20; "description": "A hands-on walkthrough for developers.",
&#x20; "capacity": "120",
&#x20; "start\_time": "2026-05-14T22:00:00.000000Z",
&#x20; "finish\_time": "2026-05-14T23:30:00.000000Z",
&#x20; "location\_name": "Room 5",
&#x20; "active": "true",
&#x20; "archived": "false",
&#x20; "updated\_at": "2026-06-15T08:18:09.000000Z",
&#x20; "created\_at": "2026-04-10T23:35:50.000000Z"
}
:::

## Field reference

| Key               | Merge tag               | Emits                                      |
| ----------------- | ----------------------- | ------------------------------------------ |
| event\_id         | \<\<EVENT\_ID>>         | Text. The event's resource ID.             |
| event\_name       | \<\<EVENT\_NAME>>       | Text. The event's name.                    |
| resource\_id      | \<\<RESOURCE\_ID>>      | Text. The Session's resource ID.           |
| organisation\_uid | \<\<ORGANISATION\_UID>> | Text. Your own identifier for the Session. |
| code              | \<\<CODE>>              | Text. Short Session code.                  |
| name              | \<\<NAME>>              | Text. The Session title.                   |
| description       | \<\<DESCRIPTION>>       | Text. The Session description.             |
| capacity          | \<\<CAPACITY>>          | Text. Maximum attendees.                   |
| start\_time       | \<\<START\_TIME>>       | Text. ISO 8601 timestamp.                  |
| finish\_time      | \<\<FINISH\_TIME>>      | Text. ISO 8601 timestamp.                  |
| location\_name    | \<\<LOCATION\_NAME>>    | Text. The Session's location.              |
| active            | \<\<ACTIVE\|...>>       | Text "true" or "false".                    |
| archived          | \<\<ARCHIVED\|...>>     | Text "true" or "false".                    |
| updated\_at       | \<\<UPDATED\_AT>>       | Text. ISO 8601 timestamp.                  |
| created\_at       | \<\<CREATED\_AT>>       | Text. ISO 8601 timestamp.                  |

