Outreach

Read or update sales workspace

Existing app workspace handlers with caller ownership, plan and optional agent role checks. All edits return confirmation_required until confirmed=true after explicit approval. Does not directly send email; resuming sequences/mailboxes permits future automation. Additional 30/minute account cap. See https://docs.outreign.io/developer-docs/workspace-actions for exact action-specific fields. Confirmation is a client/user responsibility; no server-issued approval token is required.

POST

workspace

actions

curl --request POST \
  --url https://api.outreign.io/rest-api/workspace/actions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action": "list_email_templates"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'list_email_templates'})
};

fetch('https://api.outreign.io/rest-api/workspace/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.outreign.io/rest-api/workspace/actions"

payload = { "action": "list_email_templates" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "confirmation_required": true,
  "action": "save_email_template",
  "args": {
    "name": "Example template"
  },
  "message": "Review these exact changes and confirm before calling again. Nothing changed."
}

{
  "error": "contact_name and company_name are required"
}

{
  "error": "Invalid API key"
}

{
  "error": "API access is included on Starter and above. Upgrade your plan to use the API."
}

{
  "error": "Rate limit exceeded",
  "resetAt": "2026-11-06T06:01:00.000Z"
}

Authorizations

X-API-Key

string

header

required

Your secret API key. Create it in OutReign → Settings → API Keys and send it on every request as X-API-Key: <key>. The key acts as its owner: every request reads and writes that owner's data. Keep it server-side; never ship it in browser or mobile code.

Body

application/json

action

enum<string>

required

Available options:

list_icp_profiles,

update_icp_profile,

list_signals,

refresh_signals,

list_sequence_enrollments,

update_enrollment,

update_sequence_status,

classify_reply,

list_sending_accounts,

update_sending_account,

list_deliverability_alerts,

resolve_deliverability_alert,

list_email_templates,

save_email_template,

list_objections,

save_objection,

list_campaign_briefs,

save_campaign_brief,

get_outbound_stats

args

object

Action-specific fields at https://docs.outreign.io/developer-docs/workspace-actions; handler rejects unknown fields.

agent_id

string<uuid>

confirmed

boolean

default:false

Response

Action data, confirmation preview or app action error; inspect response. Examples are illustrative, not actual customer results.

The response is of type object.

⌘I

Read or update sales workspace

curl --request POST \
  --url https://api.outreign.io/rest-api/workspace/actions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action": "list_email_templates"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'list_email_templates'})
};

fetch('https://api.outreign.io/rest-api/workspace/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.outreign.io/rest-api/workspace/actions"

payload = { "action": "list_email_templates" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "confirmation_required": true,
  "action": "save_email_template",
  "args": {
    "name": "Example template"
  },
  "message": "Review these exact changes and confirm before calling again. Nothing changed."
}

{
  "error": "contact_name and company_name are required"
}

{
  "error": "Invalid API key"
}

{
  "error": "API access is included on Starter and above. Upgrade your plan to use the API."
}

{
  "error": "Rate limit exceeded",
  "resetAt": "2026-11-06T06:01:00.000Z"
}

Overview

Endpoints

Read or update sales workspace

Authorizations

Body

Response