Messaging · Discord

Update a Discord scheduled event

Updates a Discord scheduled event. Fields you leave out keep their current values.

PATCHhttps://api.pozy.ai/v1/discord/guilds/{guildId}/events/{eventId}
Coming soonupdateDiscordScheduledEvent

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

NameTypeNotes
guildIdrequiredstring
eventIdrequiredstring

Request body

application/json, required

  • accountIdstringrequired
  • namestring

    1 to 100 characters.

  • descriptionstring

    Up to 1000 characters.

  • startsAtstring (date-time)
  • endsAtstring (date-time)
  • locationstring

    1 to 100 characters.

  • statusstring

    One of scheduled, active, completed, cancelled.

  • imageDataUristring

    Matches ^data:image/(png|jpeg|gif);base64,.

Example

curl -X PATCH "https://api.pozy.ai/v1/discord/guilds/69634a35ee7ea3cf0915ebfa/events/60c89d0a2e8d4a8ebed77064" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9"
}'

Response

200 on success

  • dataobject
    15 child fields
    • idstring
    • guild_idstring
    • channel_idstring

      Can be null.

    • creator_idstring

      Can be null.

    • namestring
    • descriptionstring

      Can be null.

    • scheduled_start_timestring (date-time)
    • scheduled_end_timestring (date-time)

      Can be null.

    • privacy_levelinteger

      One of 2.

    • statusinteger

      One of 1, 2, 3, 4.

    • entity_typeinteger

      One of 1, 2, 3.

    • entity_idstring

      Can be null.

    • entity_metadataobject

      Can be null.

      1 child field
      • locationstring
    • user_countinteger
    • imagestring

      Can be null.

200 response
{
  "data": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "guild_id": "6f7a1e97c67f78e772f7d99c",
    "channel_id": "6b2ec906b12b4a70367908ea",
    "creator_id": "68da2acddb78da9c114f691a",
    "name": "Acme",
    "description": "A short description",
    "scheduled_start_time": "2026-10-02T09:00:00.000Z",
    "scheduled_end_time": "2026-10-02T09:00:00.000Z",
    "privacy_level": 2,
    "status": 1,
    "entity_type": 1,
    "entity_id": "62e9217d133055b4a528ea76",
    "entity_metadata": {
      "location": "string"
    },
    "user_count": 42,
    "image": "string"
  }
}

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