Documentation

DocsAPI ReferencePods & Inboxes

Pods & Inboxes API

GET/v1/pods

List all pods in the organization.

TypeScript

const pods = await client.listPods();

curl

curl https://api.outreachagent.dev/v1/pods \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"

POST/v1/pods

Create a new pod.

Parameter	Type	Required	Description
name	string	Yes	Pod display name
region	string	Yes	Region identifier (e.g., "us-east-1")

TypeScript

const pod = await client.createPod({ name: "production", region: "us-east-1" });

curl

curl -X POST https://api.outreachagent.dev/v1/pods \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "production", "region": "us-east-1"}'

GET/v1/pods/:podId

Get a specific pod.

TypeScript

const pod = await client.getPod("pod_abc123");

curl

curl https://api.outreachagent.dev/v1/pods/pod_abc123 \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"

DELETE/v1/pods/:podId

Delete a pod and all its inboxes.

TypeScript

await client.deletePod("pod_abc123");

curl

curl -X DELETE https://api.outreachagent.dev/v1/pods/pod_abc123 \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"

GET/v1/inboxes

List inboxes. Supports pagination.

TypeScript

const inboxes = await client.listInboxes({ limit: 50 });

curl

curl "https://api.outreachagent.dev/v1/inboxes?limit=50" \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"

POST/v1/inboxes

Create a new inbox.

Parameter	Type	Required	Description
address	string	Yes	Email address for the inbox
displayName	string	Yes	The sender name recipients see in their inbox and notifications (e.g., "Andy from Frandera")
podId	string	Yes	Pod to assign the inbox to

TypeScript

const inbox = await client.createInbox({
  address: "sales@yourdomain.com",
  displayName: "Sales Team",
  podId: "pod_abc123"
});

curl

curl -X POST https://api.outreachagent.dev/v1/inboxes \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address": "sales@yourdomain.com", "displayName": "Sales Team", "podId": "pod_abc123"}'

GET/v1/inboxes/:inboxId

Get inbox details.

TypeScript

const inbox = await client.getInbox("inb_abc123");

curl

curl https://api.outreachagent.dev/v1/inboxes/inb_abc123 \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"

PATCH/v1/inboxes/:inboxId

Update inbox configuration.

Parameter	Type	Required	Description
displayName	string	No	New sender name shown to recipients in their inbox and notifications
status	string	No	"active", "warming", or "disabled"

TypeScript

const updated = await client.updateInbox("inb_abc123", { displayName: "Alex from Sales" });

curl

curl -X PATCH https://api.outreachagent.dev/v1/inboxes/inb_abc123 \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"displayName": "Alex from Sales"}'

DELETE/v1/inboxes/:inboxId

Delete an inbox.

TypeScript

await client.deleteInbox("inb_abc123");

curl

curl -X DELETE https://api.outreachagent.dev/v1/inboxes/inb_abc123 \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"