Moab logoMoab
Get started
Moab Docs

Products

What you sell — the context every draft is written from.

Base path /api/v1/products on https://moabcrm.com. Authenticate with Authorization: Bearer $DASH_API_KEY and name the project with the Project-ID header. Writes are validated in declared mode; an operation this resource does not declare answers 405 operation_not_supported.

List products

GET /api/v1/products

curl "https://moabcrm.com/api/v1/products" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest"
Show me the products filtered by domain
data_query {
  "collection": "products"
}

Returns a paginated list of product objects, newest first.

{
  "object": "list",
  "data": [
    {
      "object": "product",
      "id": "obj_123",
      "name": "name",
      "status": "paused",
      "product_prompt": "product prompt",
      "exclude": [],
      "product_url": "product url",
      "domain": "example.com",
      "competitors": "competitors",
      "created_at": "2026-07-25T12:00:00.000Z",
      "updated_at": "2026-07-25T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Parameters

ParameterTypeKindDescription
domainstringfilterThe product's domain, used for logo resolution and research.
qstringsearchFree-text search across name, domain.
sortstringsortOne of agent_count, last_performance_at; prefix with - to reverse.
limitnumberpageRows to return, 1–100. Defaults to 20.
cursorstringpagenext_cursor from the previous page.

Retrieve a product

GET /api/v1/products/draft-001

curl "https://moabcrm.com/api/v1/products/draft-001" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest"
Open the product {id}
data_get {
  "collection": "products",
  "object_id": "draft-001"
}

Returns the product object.

{
  "object": "product",
  "id": "obj_123",
  "name": "name",
  "status": "paused",
  "product_prompt": "product prompt",
  "exclude": [],
  "product_url": "product url",
  "domain": "example.com",
  "competitors": "competitors",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

ParameterTypeKindDescription
idstringpathThe product's id or slug.

Create a product

POST /api/v1/products

curl -X POST "https://moabcrm.com/api/v1/products" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'
Create a new product
data_set {
  "collection": "products",
  "object_id": "draft-001",
  "data": {
    "status": "paused"
  }
}

Returns the product object.

{
  "object": "product",
  "id": "obj_123",
  "name": "name",
  "status": "paused",
  "product_prompt": "product prompt",
  "exclude": [],
  "product_url": "product url",
  "domain": "example.com",
  "competitors": "competitors",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoHuman name of the product being sold.
statusstringnoRun-mode ladder for this product: paused, sandbox (sends confined to the sandbox audience), or live (delivers to real recipients). One of paused, sandbox, live.
product_promptstringnoThe product context drafting passes write from — what it is, who it is for, and the claims that are safe to make.
excludearraynoKinds of company this product NEVER sells to ("credit unions", "law firms"). The one lead gate besides relevance: the draft door refuses a lead whose company NAME names one (draft_company_excluded), and every lead source's query excludes them. One list per product — never per agent.
product_urlstringnoMarketing homepage URL — the CTA link drafts default to.
domainstringnoThe product's domain, used for logo resolution and research.
competitorstextnoKnown competitors and how the product differs, in plain text for drafting context.

Update a product

PATCH /api/v1/products/draft-001

curl -X PATCH "https://moabcrm.com/api/v1/products/draft-001" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'
Update the product {id}
data_set {
  "collection": "products",
  "object_id": "draft-001",
  "data": {
    "status": "paused"
  }
}

Returns the product object.

{
  "object": "product",
  "id": "obj_123",
  "name": "name",
  "status": "paused",
  "product_prompt": "product prompt",
  "exclude": [],
  "product_url": "product url",
  "domain": "example.com",
  "competitors": "competitors",
  "created_at": "2026-07-25T12:00:00.000Z",
  "updated_at": "2026-07-25T12:00:00.000Z"
}

Parameters

FieldTypeRequiredDescription
namestringnoHuman name of the product being sold.
statusstringnoRun-mode ladder for this product: paused, sandbox (sends confined to the sandbox audience), or live (delivers to real recipients). One of paused, sandbox, live.
product_promptstringnoThe product context drafting passes write from — what it is, who it is for, and the claims that are safe to make.
excludearraynoKinds of company this product NEVER sells to ("credit unions", "law firms"). The one lead gate besides relevance: the draft door refuses a lead whose company NAME names one (draft_company_excluded), and every lead source's query excludes them. One list per product — never per agent.
product_urlstringnoMarketing homepage URL — the CTA link drafts default to.
domainstringnoThe product's domain, used for logo resolution and research.
competitorstextnoKnown competitors and how the product differs, in plain text for drafting context.

Append an event to a product

POST /api/v1/products/{id}/events

curl -X POST "https://moabcrm.com/api/v1/products/draft-001/events" \
  -H "Authorization: Bearer $DASH_API_KEY" \
  -H "Project-ID: pr_zest" \
  -H "Content-Type: application/json" \
  -d '{"event":"Noted by the operator","context":{"source":"api"}}'
Add a note to the product {id}
data_event {
  "collection": "products",
  "object_id": "draft-001",
  "event": "Noted by the operator"
}

Returns the appended event object.

{
  "object": "event",
  "id": "evt_123",
  "event": "Noted by the operator"
}

Parameters

FieldTypeRequiredDescription
eventstringyesThe human-readable timeline entry.
contextobjectnoProvenance — source, integration, worker_run_id, …

What comes back (read-only)

Every product carries the envelope below. The fields under it are computed or stamped by the platform — they are returned, never sent.

FieldTypeDescription
objectstringAlways product.
idstringStable object id. Also accepted in place of slug on any path.
slugstringURL-safe name, unique within the collection.
created_atstringISO-8601 timestamp of the first write.
updated_atstringISO-8601 timestamp of the most recent write. The cursor sorts on this.
versionstringFree-form version marker for the product record itself.
agent_countnumberHow many campaign agents currently sell this product, stamped by the performance pass.
performance_summarytextONE short sentence (<=160 chars) on how the product's campaigns are doing, written by the performance pass. Plain prose — no leading timestamp (last_performance_at carries the clock), no channel-capacity inventory.
last_performance_atdateWhen the performance pass last ran for this product — also the list's "Runs" cell.
screenshotstextScraped screenshot references from the product site, kept for image seeding.
changelogtextRecent product changes worth mentioning in outreach.

Errors

Failures use { error: { type, code, message, param } }. The full code table is generated at Error Codes.