post/read-states/ack

Acknowledge read states

Applies one or more read-state acknowledgements and returns the authoritative read states after the write.

ack_read_states

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "read_states": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "channel_id": {
            "$ref": "#/components/schemas/SnowflakeType"
          },
          "message_id": {
            "$ref": "#/components/schemas/SnowflakeType"
          },
          "mention_count": {
            "$ref": "#/components/schemas/Int32Type"
          },
          "manual": {
            "type": "boolean",
            "description": "Whether this acknowledgement is an explicit manual read marker"
          }
        },
        "required": [
          "channel_id",
          "message_id"
        ]
      },
      "minItems": 1,
      "maxItems": 100,
      "description": "Read-state acknowledgements to apply. Supports normal and manual acknowledgements."
    }
  },
  "required": [
    "read_states"
  ]
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "read_states": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ReadStateResponse"
      },
      "description": "Authoritative read states after applying the acknowledgement"
    },
    "read_state_proto": {
      "type": "string",
      "description": "Authoritative read states after applying the acknowledgement, encoded as a base64 protobuf bundle"
    }
  },
  "required": [
    "read_states",
    "read_state_proto"
  ]
}

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"
  ]
}