Skip to main content
POST
/
triggers
/
{id}
/
deactivate
Deactivate a trigger
curl --request POST \
  --url https://api.pocketflows.com/triggers/{id}/deactivate \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "name": "<string>",
  "project_defined_event": "<string>",
  "internal_event_definition": {
    "type": "customer_created",
    "segment": "<string>"
  },
  "trigger": "<string>",
  "steps": [
    {
      "type": "email",
      "custom_step_id": "<string>",
      "email_template_id": "<string>"
    }
  ],
  "status": "draft",
  "filter": "<string>",
  "email_address": "<string>",
  "phone_number": "<string>",
  "attributed_revenue": 123,
  "metadata": {},
  "statistics": {
    "total_customers_enrolled": 123,
    "total_customers_started": 123,
    "total_customers_finished": 123,
    "emails": {
      "sent": 123,
      "delivered": 123,
      "opened": 123,
      "soft_bounced": 123,
      "hard_bounced": 123,
      "clicked": 123
    },
    "custom_steps": [
      {
        "custom_step": "<string>",
        "sent": 123
      }
    ],
    "executions": {
      "total": 123,
      "pending": 123,
      "started": 123,
      "finished": 123,
      "errored": 123
    }
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

Response

200 - application/json
id
string
required
created_at
string
required
updated_at
string
required
name
string
required
project_defined_event
string | null
required
internal_event_definition
object | null
required
steps
object[]
required
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
status
enum<string>
required
Available options:
draft,
active,
inactive
filter
string | null
required
email_address
string | null
required
phone_number
string | null
required
attributed_revenue
required
metadata
object
required
statistics
object
required
trigger
string | null