Messaging · Discord

Remove a role from a guild member

Removes a role from a guild member.

DELETEhttps://api.pozy.ai/v1/discord/guilds/{guildId}/members/{userId}/roles/{roleId}
Coming soonremoveDiscordMemberRole

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 contacts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
guildIdrequiredstring
userIdrequiredstring
roleIdrequiredstring

Query parameters

NameTypeNotes
accountIdrequiredstring

Example

curl -X DELETE "https://api.pozy.ai/v1/discord/guilds/69634a35ee7ea3cf0915ebfa/members/6da95b9455a22c1e061837af/roles/6fbd3eb5c0d929dc2c93e1f5?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • successboolean
  • operationstring

    One of role_removed.

  • guildIdstring
  • userIdstring
  • roleIdstring
200 response
{
  "success": true,
  "operation": "role_removed",
  "guildId": "69634a35ee7ea3cf0915ebfa",
  "userId": "6da95b9455a22c1e061837af",
  "roleId": "6fbd3eb5c0d929dc2c93e1f5"
}

Errors

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

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Discord