Messaging · Discord

Get Discord account settings

Fetches Discord account settings.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/discord-settings

Coming soongetDiscordSettings

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 can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/discord-settings" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/discord-settings", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
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.get(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/discord-settings",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

accountobject
11 child fields
- _idstring
- platformstring
- usernamestring
- displayNamestring
- profilePicturestring
- channelIdstring
- channelNamestring
- channelTypestring
- guildIdstring
- webhookUsernamestring
  Can be null.
- webhookAvatarUrlstring
  Can be null.

200 response

{
  "account": {
    "_id": "635d87e261ae344ef27fd1df",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "profilePicture": "string",
    "channelId": "6750a975638e9df035530f04",
    "channelName": "Acme",
    "channelType": "string",
    "guildId": "69634a35ee7ea3cf0915ebfa",
    "webhookUsername": "acme",
    "webhookAvatarUrl": "https://pozy.ai/media/example-1.jpg"
  }
}

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 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.

Request

Path parameters

Example

Response

Errors

More in Discord