Docs

Overview

Contacts

Topics

Segments

Forms

API Keys

Automations

Broadcasts

Contact Properties

Events

Fire custom eventPOST

Inbox

Marketing Emails

Sending Domains

Transactional Emails

Automations

POST

Archive Automation

POST /v1/automations/{automationId}/archive

Archive a published automation to stop it from processing triggers.

Use Cases:

Temporarily disable an automation without deleting it
Stop a published automation that is no longer needed
Prepare an automation for deletion (published automations must be archived first)
Pause an automation for review or updates

Behavior:

Sets automation status to ARCHIVED
Stops processing new triggers immediately
Contacts currently in the automation flow may still complete their current step
Archived automations can be viewed but not edited
Create a new version to re-activate

Required Scope: write:automations

Prerequisites:

Automation must be in PUBLISHED status
Only published automations can be archived

After Archiving:

Automation stops accepting new trigger events
In-flight contacts may complete their current step
Create a new version and publish to reactivate
Archived automations can be deleted

Path parameters

automationIdstringrequired

Automation ID to archive

Response

200Automation archived successfully. It is no longer processing new triggers.

objectstringrequired

idstringrequired

namestringrequired

descriptionanyrequired

status"DRAFT" | "PUBLISHED" | "ARCHIVED"required

versionnumberrequired

parentIdanyrequired

triggerobjectrequired

nodesany[]required

edgesany[]required

statsanyrequired

publishedAtanyrequired

createdAtstringrequired

updatedAtstringrequired

Request

curl -X POST "https://api.kibamail.com/v1/automations/{automationId}/archive" \
  -H "Authorization: Bearer kb_your_api_key" \
  -H "Content-Type: application/json"

Response

Automation archived successfully. It is no longer processing new triggers.

{
  "object": "string",
  "id": "string",
  "name": "string",
  "description": null,
  "status": "DRAFT",
  "version": 1,
  "parentId": null,
  "trigger": {
    "type": "string",
    "config": {}
  },
  "nodes": [
    null
  ],
  "edges": [
    null
  ],
  "stats": null,
  "publishedAt": null,
  "createdAt": "string",
  "updatedAt": "string"
}

Copyright © 2026 Kibamail.·Privacy Policy