Messaging · Discord

Create a Discord guild role

Creates a Discord guild role.

POSThttps://api.pozy.ai/v1/discord/guilds/{guildId}/roles

Coming sooncreateDiscordGuildRole

Discord is coming soon. Discord accounts cannot be connected yet: GET /v1/connect/discord returns 403 feature_not_available, so this endpoint has no account to act on for now.

Guide: Discord

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the engagement resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`guildId`required	string

Query parameters

Name	Type	Notes
`accountId`required	string

Request body

application/json, required

namestringrequired
1 to 100 characters.
colorinteger
0 to 16777215.
hoistboolean
mentionableboolean
permissionsstring

Example

curl -X POST "https://api.pozy.ai/v1/discord/guilds/69634a35ee7ea3cf0915ebfa/roles?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme"
}'

const res = await fetch("https://api.pozy.ai/v1/discord/guilds/69634a35ee7ea3cf0915ebfa/roles?accountId=696e0b682d0a31188e7a2ba9", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Acme"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.post(
    "https://api.pozy.ai/v1/discord/guilds/69634a35ee7ea3cf0915ebfa/roles",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    json={
        "name": "Acme",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

201 on success

dataobject
8 child fields
- idstring
- namestring
- colorinteger
- positioninteger
- permissionsstring
- managedboolean
- mentionableboolean
- hoistboolean

201 response

{
  "data": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "color": 1,
    "position": 1,
    "permissions": "string",
    "managed": true,
    "mentionable": true,
    "hoist": true
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.