Actions API

Actions represent outreach operations — emails, LinkedIn messages, and other tasks — that can be scheduled, approved, and executed.

Create an Action

POST /v1/actions

Request Body

Field	Type	Required	Description
type	string	yes	Action type (e.g. send_email, linkedin_message).
params	object	yes	Type-specific parameters for the action.
identity_id	string	yes	Identity to perform the action as.
direct	boolean	no	Execute immediately without scheduling.
scheduled_time	string	no	ISO 8601 timestamp for scheduled execution.
list_id	string	no	Associated list ID.
item_id	string	no	Associated list item ID.
description	string	no	Human-readable description of the action.
require_approval	boolean	no	Whether the action needs approval before execution.

Example

curl -X POST https://api.pathbound.io/v1/actions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "send_email",
    "params": {
      "to": "contact@example.com",
      "subject": "Hello",
      "body": "Hi there!"
    },
    "identity_id": "id_123",
    "require_approval": true
  }'

Response — 200 OK

{
  "status": "success",
  "action_id": "act_abc123",
  "action_summary": "Email to contact@example.com scheduled"
}

---

List Actions

GET /v1/actions

Query Parameters

Parameter	Type	Default	Description
status	string	—	Filter by status.
type	string	—	Filter by action type.
list_id	string	—	Filter by list.
item_id	string	—	Filter by list item.
identity_id	string	—	Filter by identity.
limit	number	20	Results per page (1–100).
skip	number	0	Number of results to skip.
sort_by	string	—	Field to sort by.
sort_dir	string	—	Sort direction (asc or desc).

Response — 200 OK

{
  "status": "success",
  "actions": [ /* action objects */ ],
  "pagination": {
    "total_items": 42,
    "limit": 20,
    "skip": 0
  }
}

---

Get an Action

GET /v1/actions/:action_id

Returns the full action object including its current status.

---

Execute an Action

POST /v1/actions/:action_id/execute

Immediately executes a scheduled or pending action.

---

Cancel an Action

POST /v1/actions/:action_id/cancel

Cancels a scheduled action that has not yet been executed.

---

Approve or Reject an Action

POST /v1/actions/:action_id/approve

Request Body

Field	Type	Required	Description
action	string	yes	One of approve, reject, or edit.
comment	string	no	Optional reviewer comment.

---

Bulk Approve / Reject

POST /v1/actions/approve/bulk

Request Body

Field	Type	Required	Description
action	string	yes	One of approve, reject, or edit.
action_ids	string[]	yes	Array of action IDs to process.
comment	string	no	Optional reviewer comment.

---

Process Pending Actions

POST /v1/actions/process

Triggers processing of pending scheduled actions.

Query Param	Type	Default	Description
limit	number	—	Max actions to process (1–100).