> ## Documentation Index > Fetch the complete documentation index at: https://docs.moderationapi.com/llms.txt > Use this file to discover all available pages before exploring further. # Suspend author > Block an author for a limited time with the built-in suspend action. ## OpenAPI ````yaml post /authors/{id}/suspend openapi: 3.1.0 info: title: Moderation API description: >- Moderate text, images, video and audio in real time, manage authors, review queues and actions, and receive webhooks. version: 1.1.0 servers: - url: https://api.moderationapi.com/v1 security: [] tags: - name: Content description: Submit content for moderation. - name: Authors description: The users who create content, with their trust level and history. - name: Review queues description: Queues of content for human review, and their items. - name: Actions description: Moderation actions reviewers and rules can take. - name: Wordlists description: Custom word and phrase lists used by policies. - name: Webhooks description: Endpoints that receive events, and the events they receive. - name: Analytics description: Moderation numbers for a project, as on the dashboard overview. - name: Account description: The account that owns the API key. - name: Projects description: Projects in the organization. Needs an organization key. - name: Channels description: Channels in a project. Needs an organization key. - name: Voice description: Real-time voice moderation over WebSocket. - name: Feedback description: Send feature requests and product feedback to the Moderation API team. externalDocs: url: https://docs.moderationapi.com paths: /authors/{id}/suspend: post: tags: - Authors summary: Suspend author description: Block an author for a limited time with the built-in suspend action. operationId: suspendAuthor parameters: - in: path name: id schema: type: string description: Either external ID or the ID assigned by moderation API. required: true description: Either external ID or the ID assigned by moderation API. - in: header name: Project-Id required: false schema: type: string description: >- The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error. x-speakeasy-name-override: projectId requestBody: required: true content: application/json: schema: type: object properties: reason: description: >- Why the action was taken. Saved with the action and sent in the webhook event. type: string duration: description: >- How long the suspension lasts, in milliseconds. Defaults to 24 hours. type: number minimum: 0 example: reason: Violation of community guidelines duration: 604800000 responses: '200': description: Action executed successfully content: application/json: schema: type: object properties: success: type: boolean description: Whether the action was executed successfully required: - success additionalProperties: false description: Execution result '400': description: Invalid input data content: application/json: schema: $ref: '#/components/schemas/BadRequestError' '401': description: Authorization not provided content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '429': description: >- Too many requests. Retry after the number of seconds in the `Retry-After` header. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RateLimitError' security: - Authorization: [] x-codeSamples: - lang: typescript label: TypeScript source: | import { ModerationApi } from "@moderation-api/sdk"; const moderationApi = new ModerationApi({ secretKey: process.env["MODAPI_SECRET_KEY"] ?? "", }); async function run() { const result = await moderationApi.authors.suspend("", { reason: "Violation of community guidelines", duration: 604800000, }); console.log(result); } run(); - lang: python label: Python source: | import os from moderation_api import ModerationAPI with ModerationAPI( secret_key=os.environ["MODAPI_SECRET_KEY"], ) as moderation_api: res = moderation_api.authors.suspend(id="", reason="Violation of community guidelines", duration=604800000) # Handle response print(res) - lang: php label: PHP source: | declare(strict_types=1); require 'vendor/autoload.php'; use ModerationApi; use ModerationApi\Models\Operations; $sdk = ModerationApi\ModerationApi::builder() ->setSecurity( getenv('MODAPI_SECRET_KEY') ) ->build(); $body = new Operations\SuspendAuthorRequestBody( reason: 'Violation of community guidelines', duration: 604800000, ); $response = $sdk->authors->suspend( id: '', body: $body ); if ($response->object !== null) { // handle response } - lang: ruby label: Ruby source: > require 'moderation_api' Models = ::ModerationApi::Models s = ::ModerationApi::ModerationApi.new( secret_key: ENV.fetch('MODAPI_SECRET_KEY') ) res = s.authors.suspend(id: '', body: Models::Operations::SuspendAuthorRequestBody.new( reason: 'Violation of community guidelines', duration: 604_800_000.0 )) unless res.object.nil? # handle response end - lang: bash label: CLI source: > modapi authors suspend --secret-key "$MODAPI_SECRET_KEY" --id '' --reason 'Violation of community guidelines' --duration 604800000 components: schemas: BadRequestError: type: object description: The request is malformed or a parameter is invalid. properties: type: type: string const: invalid_request_error description: Broad error category. Stable; safe to switch on. code: type: string enum: - invalid_request - project_id_required - project_name_ambiguous - validation_failed x-speakeasy-unknown-values: allow description: >- Exactly what went wrong. Stable; safe to branch on. New codes may be added. - `invalid_request`: A parameter is invalid. `message` says which one. - `project_id_required`: An organization key called a project endpoint without naming the project in `Project-Id`, and the key reaches more than one project. `message` lists the projects it reaches. - `project_name_ambiguous`: The name in `Project-Id` fits more than one project the key reaches. `message` lists them; name the project by ID instead. - `validation_failed`: The request body does not match the schema. `issues` lists each problem with its `path`. example: invalid_request message: type: string description: Human-readable explanation. example: Invalid input data issues: type: array items: $ref: '#/components/schemas/ErrorIssue' description: Validation problems, when the request body is invalid. request_id: type: string description: Identifies this request. Include it when you contact support. example: h8fkz6kkzoa446ffve37atys doc_url: type: string format: uri description: Documentation for this `code`. required: - type - code - message - request_id - doc_url AuthenticationError: type: object description: The API key is missing, invalid or revoked. properties: type: type: string const: authentication_error description: Broad error category. Stable; safe to switch on. code: type: string enum: - unauthorized - missing_api_key - malformed_api_key - invalid_api_key x-speakeasy-unknown-values: allow description: >- Exactly what went wrong. Stable; safe to branch on. New codes may be added. - `unauthorized`: Authentication failed. - `missing_api_key`: No API key in the `Authorization` header. - `malformed_api_key`: The `Authorization` header does not contain a valid key format. - `invalid_api_key`: The API key does not exist or was revoked. example: unauthorized message: type: string description: Human-readable explanation. example: Authorization not provided issues: type: array items: $ref: '#/components/schemas/ErrorIssue' description: Validation problems, when the request body is invalid. request_id: type: string description: Identifies this request. Include it when you contact support. example: h8fkz6kkzoa446ffve37atys doc_url: type: string format: uri description: Documentation for this `code`. required: - type - code - message - request_id - doc_url NotFoundError: type: object description: The resource does not exist or the key cannot see it. properties: type: type: string const: not_found_error description: Broad error category. Stable; safe to switch on. code: type: string enum: - resource_not_found - action_not_found - author_not_found - queue_not_found - queue_item_not_found - wordlist_not_found - webhook_not_found - project_not_found - channel_not_found x-speakeasy-unknown-values: allow description: >- Exactly what went wrong. Stable; safe to branch on. New codes may be added. - `resource_not_found`: The resource does not exist. - `action_not_found`: The action does not exist. - `author_not_found`: The author does not exist. - `queue_not_found`: The review queue does not exist. - `queue_item_not_found`: The queue item does not exist in the project. - `wordlist_not_found`: The wordlist does not exist. - `webhook_not_found`: The webhook does not exist. - `project_not_found`: The project does not exist. - `channel_not_found`: The channel does not exist. example: resource_not_found message: type: string description: Human-readable explanation. example: Not found issues: type: array items: $ref: '#/components/schemas/ErrorIssue' description: Validation problems, when the request body is invalid. request_id: type: string description: Identifies this request. Include it when you contact support. example: h8fkz6kkzoa446ffve37atys doc_url: type: string format: uri description: Documentation for this `code`. required: - type - code - message - request_id - doc_url RateLimitError: type: object description: >- Too many requests. Retry after the number of seconds in the `Retry-After` header. properties: type: type: string const: rate_limit_error description: Broad error category. Stable; safe to switch on. code: type: string enum: - rate_limit_exceeded x-speakeasy-unknown-values: allow description: >- Exactly what went wrong. Stable; safe to branch on. New codes may be added. - `rate_limit_exceeded`: Too many requests. Wait for the `Retry-After` seconds. example: rate_limit_exceeded message: type: string description: Human-readable explanation. example: Rate limit exceeded issues: type: array items: $ref: '#/components/schemas/ErrorIssue' description: Validation problems, when the request body is invalid. request_id: type: string description: Identifies this request. Include it when you contact support. example: h8fkz6kkzoa446ffve37atys doc_url: type: string format: uri description: Documentation for this `code`. required: - type - code - message - request_id - doc_url ErrorIssue: type: object properties: message: type: string description: What is wrong. path: type: array items: anyOf: - type: string - type: number description: Location of the invalid field in the request body. code: type: string description: Validation rule that failed. required: - message securitySchemes: Authorization: type: http scheme: bearer x-speakeasy-name-override: secretKey ````