Automations

Delete Inbox Automations

Deletes the rules that match accountId, name or both. You must pass at least one of them.

DELETE
/v1/automations

Authorization

headerx-api-key<token>

Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.

Query Parameters

accountId?string
Length1 <= length
name?string

Deletes rules whose name contains this text. Matching ignores case.

Length1 <= length

Response Body

Deleted

application/json
  1. response
deleted*integer
Example Request
import { Configuration, EngagementApi } from "@onepostly/sdk";const engagementApi = new EngagementApi(  new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await engagementApi.deleteAutomations({  accountId: "a1b2c3d4-e5f6-4a7b-8c9d-e0f1a2b3c4d5",  name: "guide",});console.log(response);
Example Response
{  "deleted": 0}