Guild Template Resource

Templates represent a code that when used, creates a guild based on a snapshot of an existing guild. For a list of official templates, refer to this Gist.

Guild Template Object

Guild Template Structure
FieldTypeDescription
codestringThe code of the template (unique ID)
namestringThe name of the template (1-100 characters)
description?stringThe description for the template (max 120 characters)
usage_countintegerNumber of times this template has been used
creator_idsnowflakeThe ID of the user who created the template
creatorpartial user objectThe user who created the template
created_atISO8601 timestampWhen this template was created
updated_atISO8601 timestampWhen this template was last synced to the source guild
source_guild_idsnowflakeThe ID of the guild this template is based on
serialized_source_guild 1partial guild objectThe guild snapshot this template contains
is_dirty?booleanWhether the template has unsynced changes

1 This partial guild object is special in that it and the objects within always contain applicable optional fields (even if they're not applicable). This leads to unexpected behavior, such as available_tags being serialized for voice channels. Additionally, the main guild object is missing the id field, and all other id fields are not real snowflakes.

Example Guild Template Object
{
  "code": "2TffvPucqHkN",
  "name": "Blank Server",
  "description": null,
  "usage_count": 34061,
  "creator_id": "268473310986240001",
  "creator": {
    "id": "268473310986240001",
    "username": "discordapp",
    "global_name": "Discord",
    "avatar": "f749bb0cbeeb26ef21eca719337d20f1",
    "avatar_decoration_data": null,
    "discriminator": "0",
    "public_flags": 4325376,
    "avatar_decoration_data": null
  },
  "created_at": "2020-04-17T20:59:35+00:00",
  "updated_at": "2020-04-17T20:59:35+00:00",
  "source_guild_id": "700811170902179862",
  "serialized_source_guild": {
    "name": "Blank Server",
    "description": null,
    "region": "us-west",
    "verification_level": 0,
    "default_message_notifications": 0,
    "explicit_content_filter": 0,
    "preferred_locale": "en-US",
    "afk_timeout": 300,
    "roles": [
      {
        "id": 0,
        "name": "@everyone",
        "color": 0,
        "hoist": false,
        "mentionable": false,
        "permissions": "927817256513",
        "icon": null,
        "unicode_emoji": null
      }
    ],
    "channels": [
      {
        "id": 1,
        "type": 4,
        "name": "Text Channels",
        "position": 0,
        "topic": null,
        "bitrate": 64000,
        "user_limit": 0,
        "nsfw": false,
        "rate_limit_per_user": 0,
        "parent_id": null,
        "default_auto_archive_duration": null,
        "permission_overwrites": [],
        "available_tags": null,
        "template": "",
        "default_reaction_emoji": null,
        "default_thread_rate_limit_per_user": null,
        "default_sort_order": null,
        "default_forum_layout": null
      },
      {
        "id": 2,
        "type": 0,
        "name": "general",
        "position": 0,
        "topic": null,
        "bitrate": 64000,
        "user_limit": 0,
        "nsfw": false,
        "rate_limit_per_user": 0,
        "parent_id": 1,
        "default_auto_archive_duration": null,
        "permission_overwrites": [],
        "available_tags": null,
        "template": "",
        "default_reaction_emoji": null,
        "default_thread_rate_limit_per_user": null,
        "default_sort_order": null,
        "default_forum_layout": null
      },
      {
        "id": 3,
        "type": 4,
        "name": "Voice Channels",
        "position": 0,
        "topic": null,
        "bitrate": 64000,
        "user_limit": 0,
        "nsfw": false,
        "rate_limit_per_user": 0,
        "parent_id": null,
        "default_auto_archive_duration": null,
        "permission_overwrites": [],
        "available_tags": null,
        "template": "",
        "default_reaction_emoji": null,
        "default_thread_rate_limit_per_user": null,
        "default_sort_order": null,
        "default_forum_layout": null
      },
      {
        "id": 4,
        "type": 2,
        "name": "General",
        "position": 0,
        "topic": null,
        "bitrate": 64000,
        "user_limit": 0,
        "nsfw": false,
        "rate_limit_per_user": 0,
        "parent_id": 3,
        "default_auto_archive_duration": null,
        "permission_overwrites": [],
        "available_tags": null,
        "template": "",
        "default_reaction_emoji": null,
        "default_thread_rate_limit_per_user": null,
        "default_sort_order": null,
        "default_forum_layout": null
      }
    ],
    "afk_channel_id": null,
    "system_channel_id": 2,
    "system_channel_flags": 0
  },
  "is_dirty": null
}

Endpoints

Get Guild Template

GET/guilds/templates/{template.code}
Unauthenticated

Returns a guild template object for the given code.

Use Guild Template

POST/guilds/templates/{template.code}

Create a new guild based on a template. Returns a guild object on success. Fires a Guild Create Gateway event.

JSON Params
FieldTypeDescription
namestringThe name of the guild (2-100 characters)
icon?image data128x128 image for the guild's icon

Get Guild Templates

GET/guilds/{guild.id}/templates

Returns an array of guild template objects. Requires the MANAGE_GUILD permission.

Create Guild Template

POST/guilds/{guild.id}/templates

Creates a template for the guild. Requires the MANAGE_GUILD permission. Returns the created guild template object on success.

JSON Params
FieldTypeDescription
namestringThe name of the template (1-100 characters)
description??stringThe description for the template (max 120 characters)

Sync Guild Template

PUT/guilds/{guild.id}/templates/{template.code}

Syncs the template to the guild's current state. Requires the MANAGE_GUILD permission. Returns the updated guild template object on success.

Modify Guild Template

PATCH/guilds/{guild.id}/templates/{template.code}

Modifies the template's metadata. Requires the MANAGE_GUILD permission. Returns the updated guild template object on success.

JSON Params
FieldTypeDescription
name?stringThe name of the template (1-100 characters)
description??stringThe description for the template (max 120 characters)

Delete Guild Template

DELETE/guilds/{guild.id}/templates/{template.code}

Deletes the template. Requires the MANAGE_GUILD permission. Returns the deleted guild template object on success.