---
title: "Create a group"
method: POST
path: "/4.0/guestlists/{guestlist_id}/groups"
tags: ["Guest Groups"]
---

# Create a group

`POST /4.0/guestlists/{guestlist_id}/groups`

## Request

- Base URL: `https://api.socialtables.com`
- URL: `https://api.socialtables.com/4.0/guestlists/{guestlist_id}/groups`
- Auth: none declared

## Path parameters

- `guestlist_id` string, required

## Request body

- GroupBulkGuestListService
  - `action` 'CREATE' | 'DELETE', required
  - `guests` GuestsGuestListService[], required
    - `id` string, required: id of guest
    - `first_name` string, required: first name of guest
    - `last_name` string, required: last name of guest
    - `email` string: email address
    - `checked_in_status` object: checkin data
      - `checked_in` integer
      - `checked_in_at` string, date-time
      - `checked_out_at` string, date-time
    - `tags` TagsGuestListService[]
      - `id` string: id of tag
      - `guestlist_id` string: id of the guestlist the tag belongs to
      - `title` string: title of tag
      - `color` string: color of tag
      - `archived` boolean: whether the tag is archived
    - `meals` MealsGuestListService[]
      - `title` string, required: name of meal

## Response `200`

group created

- GroupGuestListService
  - `id` string, required
  - `guestlist_id` string
  - `guest_count` integer
  - `is_named` boolean
  - `guests` GuestsGuestListService[]
    - `id` string, required: id of guest
    - `first_name` string, required: first name of guest
    - `last_name` string, required: last name of guest
    - `email` string: email address
    - `checked_in_status` object: checkin data
      - `checked_in` integer
      - `checked_in_at` string, date-time
      - `checked_out_at` string, date-time
    - `tags` TagsGuestListService[]
      - `id` string: id of tag
      - `guestlist_id` string: id of the guestlist the tag belongs to
      - `title` string: title of tag
      - `color` string: color of tag
      - `archived` boolean: whether the tag is archived
    - `meals` MealsGuestListService[]
      - `title` string, required: name of meal

## Other responses

- `400`: Error creating group
- `410`: guestlist is deleted

---

[API](https://skmtc.dev/socialtables/apis/social-tables-api-gateway.md) - [All operations](https://skmtc.dev/socialtables/apis/social-tables-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/socialtables/apis/social-tables-api-gateway/revisions/5693d914a4b5?raw)