> ## Documentation Index > Fetch the complete documentation index at: https://outlit-codex-platform-actions-create-update-cli.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Disable automation > Disable one configured Outlit automation by id. ## OpenAPI ````yaml /openapi.json post /api/automations/{id}/disable openapi: 3.1.0 info: title: Outlit API summary: Public Outlit Platform and Ingest APIs. description: >- Canonical OpenAPI specification for the public Outlit API surfaces documented at docs.outlit.ai. version: 1.0.0 servers: - url: https://app.outlit.ai security: - bearerAuth: [] tags: - name: Platform API description: >- Authenticated API key routes for customer intelligence tools and integration management. - name: Ingest API description: Public-key event ingestion routes used by Outlit SDKs. paths: /api/automations/{id}/disable: post: tags: - Platform API summary: Disable automation description: Disable one configured Outlit automation by id. operationId: disableAutomation parameters: - name: id in: path required: true description: Automation ID. schema: type: string format: uuid responses: '200': description: Disable automation completed. content: application/json: schema: $ref: '#/components/schemas/DisableAutomationCommandSuccess' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The API key is valid but does not have the required agent write scope. content: application/json: schema: $ref: '#/components/schemas/CommandErrorEnvelope' '404': description: >- No resource was found for the authenticated organization and requested id. content: application/json: schema: $ref: '#/components/schemas/CommandErrorEnvelope' '409': description: >- The requested lifecycle change conflicts with the current platform state. content: application/json: schema: $ref: '#/components/schemas/CommandErrorEnvelope' '500': $ref: '#/components/responses/InternalServerError' '503': description: The platform could not complete the command. content: application/json: schema: $ref: '#/components/schemas/CommandErrorEnvelope' components: schemas: DisableAutomationCommandSuccess: type: object required: - ok - commandId - commandVersion - correlationId - result properties: ok: type: boolean const: true commandId: type: string const: automation.disable commandVersion: type: integer const: 1 correlationId: type: string result: allOf: - $ref: '#/components/schemas/CommandResultBase' - type: object properties: operationId: type: string const: automation.disable data: type: object required: - automation properties: automation: $ref: '#/components/schemas/AutomationRead' additionalProperties: false additionalProperties: false CommandErrorEnvelope: type: object required: - ok - commandId - commandVersion - error properties: ok: type: boolean const: false commandId: type: string commandVersion: type: integer minimum: 1 error: type: object required: - code - message - correlationId - retryable properties: code: type: string enum: - validation_failed - authorization_denied - conflict - not_found - rate_limited - transient_failure message: type: string correlationId: type: string retryable: type: boolean details: type: object additionalProperties: true additionalProperties: false additionalProperties: false CommandResultBase: type: object required: - operationId - status - resources - data - warnings properties: operationId: type: string status: type: string const: completed resources: type: array items: $ref: '#/components/schemas/CommandResource' data: type: object additionalProperties: true warnings: type: array items: type: string auditId: type: string additionalProperties: false AutomationRead: type: object required: - id - key - managedBy - name - description - enabled - triggerType - triggerJson - audienceFilterJson - agentId - matchMode - schemaVersion - configHash - archivedAt - lastRunAt - lastRunStatus - nextRunAt - createdAt - updatedAt - signals - destinations - activeSignalCount - activeDestinationCount properties: id: type: string format: uuid key: type: string managedBy: $ref: '#/components/schemas/PlatformActionManagedBy' name: type: string description: type: - string - 'null' enabled: type: boolean triggerType: $ref: '#/components/schemas/AutomationTriggerType' triggerJson: {} audienceFilterJson: {} matchMode: $ref: '#/components/schemas/AutomationMatchMode' schemaVersion: type: string configHash: type: - string - 'null' archivedAt: type: - string - 'null' format: date-time lastRunAt: type: - string - 'null' format: date-time lastRunStatus: anyOf: - $ref: '#/components/schemas/AutomationRunStatus' - type: 'null' nextRunAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time signals: type: array items: $ref: '#/components/schemas/SignalRead' destinations: type: array items: $ref: '#/components/schemas/DestinationRead' activeSignalCount: type: integer minimum: 0 activeDestinationCount: type: integer minimum: 0 agentId: type: - string - 'null' format: uuid additionalProperties: false ErrorResponse: type: object required: - error properties: error: type: string details: type: array items: $ref: '#/components/schemas/ValidationIssue' additionalProperties: true CommandResource: type: object required: - type - id properties: type: type: string id: type: string additionalProperties: false PlatformActionManagedBy: type: string enum: - UI - CODE AutomationTriggerType: type: string enum: - SIGNAL_OCCURRENCE - SCHEDULE AutomationMatchMode: type: string enum: - ANY - ALL - AT_LEAST AutomationRunStatus: type: string enum: - PENDING - SKIPPED - RUNNING_PROCESSOR - READY_FOR_DELIVERY - PENDING_DELIVERY - DELIVERED - PARTIAL_FAILURE - FAILED SignalRead: type: object required: - id - key - managedBy - name - description - kind - definition - schemaVersion - configHash - archivedAt - createdAt - updatedAt properties: id: type: string format: uuid key: type: string managedBy: $ref: '#/components/schemas/PlatformActionManagedBy' name: type: string description: type: - string - 'null' kind: $ref: '#/components/schemas/SignalKind' definition: {} schemaVersion: type: string configHash: type: - string - 'null' archivedAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time additionalProperties: false DestinationRead: type: object required: - id - key - name - description - provider - kind - enabled - maskedConfig - syncStatus - lastSyncedAt - providerErrorCode - providerErrorMessage - isDefault - schemaVersion - configHash - archivedAt - createdAt - updatedAt properties: id: type: string format: uuid key: type: string name: type: string description: type: - string - 'null' provider: $ref: '#/components/schemas/DestinationProvider' kind: $ref: '#/components/schemas/DestinationKind' enabled: type: boolean maskedConfig: anyOf: - type: object additionalProperties: true - type: 'null' syncStatus: $ref: '#/components/schemas/DestinationSyncStatus' lastSyncedAt: type: - string - 'null' format: date-time providerErrorCode: type: - string - 'null' providerErrorMessage: type: - string - 'null' isDefault: type: boolean schemaVersion: type: string configHash: type: - string - 'null' archivedAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time additionalProperties: false ValidationIssue: type: object required: - path - message properties: path: type: array items: type: - string - number message: type: string additionalProperties: false SignalKind: type: string enum: - EVENT_MATCH - EVENT_PATTERN DestinationProvider: type: string enum: - SLACK - OUTPOST - WEBHOOK DestinationKind: type: string enum: - SLACK_CHANNEL - WEBHOOK_ENDPOINT DestinationSyncStatus: type: string enum: - PENDING_PROVIDER_SYNC - SYNCED - PROVIDER_ERROR - DISABLED_BY_PROVIDER responses: Unauthorized: description: Invalid or missing API key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: Invalid credentials InternalServerError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: Internal server error securitySchemes: bearerAuth: type: http scheme: bearer description: Outlit API key using the Bearer ok_... format. ````