Workflows

A workflow automates a sequence of steps for every contact enrolled in it. You build and publish workflows in the SMBcrm UI; the API’s role is narrower. List the workflows in your account, then enroll a contact in one to trigger it.

Base URL: https://services.smbcrm.com · Version header: v3 · Scopes: workflows.readonly (list), contacts.write (enroll a contact). See Scopes.

Note

There’s no API to create, edit, or delete workflows. Build and publish the workflow in the SMBcrm UI first, then use the API to find its id and enroll contacts in it.

List workflows

GET/workflows/

List the workflows in your SMBcrm account.

scope workflows.readonlyauth Location token or PIT

locationId is required as a query parameter and scopes the results to your account.

curl "https://services.smbcrm.com/workflows/?locationId=<location_id>" \
  -H "Authorization: Bearer <token>" \
  -H "Version: v3"

200 OK

{
  "workflows": [
    { "id": "<workflow_id>", "name": "New Lead Nurture", "status": "published" },
    { "id": "<workflow_id>", "name": "Missed Call Follow-Up", "status": "draft" }
  ]
}

Save the id of the workflow you want. You’ll need it to enroll contacts.

Enroll a contact in a workflow

Once you have a workflow’s id, add a contact to it with the same endpoint documented on the Contacts page:

POST/contacts/{contactId}/workflow/{workflowId}

Enroll a contact in a workflow, starting it from the first step.

scope contacts.writeauth Location token or PIT

curl -X POST https://services.smbcrm.com/contacts/<contact_id>/workflow/<workflow_id> \
  -H "Authorization: Bearer <token>" \
  -H "Version: v3"

Enrolling a contact this way starts the workflow for them just as if they had met one of its enrollment triggers in the SMBcrm UI.

Related

• Contacts — enroll a contact in a workflow or campaign, tag contacts, and manage everything else about a contact record.
• Locations — look up the locationId for your account.