post/users/@me/entrance-sounds

Upload an entrance sound

Uploads a short audio clip to the user's entrance sound library. Validates format, duration, and size server-side.

upload_entrance_sound

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Display label for the sound"
    },
    "audio": {
      "$ref": "#/components/schemas/Base64ImageType"
    }
  },
  "required": [
    "name",
    "audio"
  ]
}

Responses

201

Success

json

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/SnowflakeType"
    },
    "name": {
      "type": "string"
    },
    "hash": {
      "type": "string"
    },
    "extension": {
      "enum": [
        "mp3",
        "ogg",
        "m4a",
        "wav"
      ],
      "type": "string",
      "x-enumNames": [
        "mp3",
        "ogg",
        "m4a",
        "wav"
      ]
    },
    "content_type": {
      "type": "string"
    },
    "duration_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 5200,
      "format": "int32"
    },
    "size_bytes": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1048576,
      "format": "int32"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "name",
    "hash",
    "extension",
    "content_type",
    "duration_ms",
    "size_bytes",
    "url",
    "created_at"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}