Sales Engine
API documentation
JobsOperation jobs.enqueue

Queue a job

Queue one of the jobs that send nothing and spend only the workspace keys: a search preview, an inbox poll, a deliverability scan, a signals scan, a learning run, a timezone fill. Launches, sends, replies, copy, sourcing and the memory build have their own endpoints.

POST/api/v1/jobs
Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Body

A JSON object. Fields not listed are ignored.

NameInDescription
typerequiredbodyJob type. One of noop, lead_list.preview, inbox.poll, deliverability.scan, signals.scan, learning.weekly, learning.monthly, leads.timezone_fill.
payloadbody, objectThe payload that type reads: params for a preview, mailbox_id for a poll, mailbox_id or domain for a deliverability scan, feed_id for a signals scan, force for a learning run, lead_id or lead_list_id for a timezone fill.
prioritybody, integerPriority.

Example

curl
curl -X POST "https://crm.ashwanth.dev/api/v1/jobs" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "noop",
  "payload": {},
  "priority": 0
}'
CLI
sales-engine jobs enqueue --type noop

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/jobs

Also in Jobs