Moab logoMoab
Get started
Moab Docs

API Resources

Every REST resource Moab serves, with its operations.

Each resource page gives its base path, its fields and a call for every operation.

ResourceLabelOperationsSummary
analyticsAnalyticslist, getMeasured outcomes per period — what the loop earned.
artifactsArtifactslist, getFiles and images produced or uploaded by the agent.
blockersBlockerslist, getActive upstream blockers — server-stamped, cleared by the event that unblocks.
campaign-agent-runsAgent Runslist, get, create, updateOne batch of work by a campaign agent — a run is the unit drafts group by.
campaign-agentsAgentslist, get, create, update, eventsThe actors: each campaign agent is one ICP cell × content × provider, and whether it is on.
companiesCompanieslist, get, create, update, eventsTarget accounts your campaign agents research and work.
contentContentlist, get, create, update, eventsReusable message and image templates campaign agents draft from.
daily-reportsReportslist, get, create, updateOne row per operating day — the plan (which agents send how much under which tag, who is archived, who is born) and one entry per planner run.
dashboardsDashboardslist, getMetric boards built from your CRM data.
employeesEmployeeslist, get, create, updateThe sender personas outreach is written as.
goalsGoalslist, get, create, update, eventsWhat the outreach is for — the number a campaign is trying to move.
integrationsIntegrationslist, get, create, deleteProvider credentials attached to a project.
learningsLearningslist, getWhat the agent learned, kept as create/remove facts rather than a decaying score.
link-codesLink Codeslist, get, eventsOne row per minted outbound link code — who it was minted for, where it redirects, and the click/visit/convert truth the dash-links worker stamps.
link-domainsTracking Domainslist, get, eventsTracking hosts for outbound links — pending until the dash-links worker answers on the host, verified after, retired instead of deleted.
listsListslist, get, create, updateSaved groups of people and companies one campaign run works.
metric-recordsMetricslist, getStored metric values — one row per (owner, key), newest write wins.
outboxOutboxlist, get, create, update, eventsThe one outbound record — every message from creation to engagement, on two states: draft → sent (opened/clicked/replied/bounced refine it) | failed (+ declined). You always create rows at status draft; Approve or a live agent's mint SENDS right then, and each row ends sent or failed with the reason on it. Writing declined/sent yourself is refused at the boundary (outbox_status_requires_dash_action).
pagesPageslist, get, create, update, eventsLanding pages — indexed from the customer's site, or built from typed blocks, scored by the same engagement stamp as content.
peoplePeoplelist, get, create, update, eventsThe individuals Moab may draft outreach for.
preferencesPreferencesget, listPer-project dashboard state (notification read/cleared markers).
productsProductslist, get, create, update, eventsWhat you sell — the context every draft is written from.
sequencesSequenceslist, get, create, updateMulti-touch cadences: the steps a campaign agent walks a person through.
skillsSkillslist, getSkills this agent can run, and where their executed bytes come from.
timeline-eventsTimeline Eventslist, getThe append-only record of what happened to an object.

On this page

No Headings
Moab logoMoab

Ready to build? Connect an agent and go — no credit card needed to start.

Get startedSee our plans