Skip to main content

leads

7 operation(s). All run through POST /syteops/v1/manage/dispatch (reads may use the documented GET form).

delete

Permanently delete a lead and its events (best-effort moves its RingTonic contact to "lost").

🔴 Destructive — requires confirm: true.
Capability: manage_options

Parameters

ParameterTypeRequiredDescription
idintegeryes
confirmbooleanno

Returns

data: {id, deleted: true}

Request

{
"resource": "leads",
"action": "delete",
"params": {
"id": 0,
"confirm": true
},
"confirm": true
}

export

Export the lead ledger as structured rows (optionally since a datetime).

Capability: manage_options

Parameters

ParameterTypeRequiredDescription
sincestringno

Returns

data: {rows[], count}

Request

{
"resource": "leads",
"action": "export",
"params": {
"since": "string"
}
}

get

Get one lead with attribution, event timeline, and chain status.

Capability: manage_options

Parameters

ParameterTypeRequiredDescription
idintegeryes

Returns

data: {id,ref,attribution,events[],chain:{ok,count,broken_at}}

Request

{
"resource": "leads",
"action": "get",
"params": {
"id": 0
}
}

Store the RingTonic contact id on a lead (the reconcile calls this after matching by phone/email).

Capability: manage_options

Parameters

ParameterTypeRequiredDescription
idintegeryes
rt_contact_idstringyes

Returns

data: {id, rt_contact_id}

Request

{
"resource": "leads",
"action": "link_rt_contact",
"params": {
"id": 0,
"rt_contact_id": "string"
}
}

list

List captured leads (paginated; filter by source/since).

Capability: manage_options

Parameters

ParameterTypeRequiredDescription
per_pageintegerno
pageintegerno
sourcestringno
sincestringno

Returns

data: {items[]: {id,ref,source,campaign,status,event_count,first_seen}, total, page, per_page}

Request

{
"resource": "leads",
"action": "list",
"params": {
"per_page": 0,
"page": 0,
"source": "string",
"since": "string"
}
}

set_status

Set a lead's pipeline status (New/Contacted/Qualified/Unqualified/Customer). Used by the RingTonic inbound reconcile; recorded as inbound so it does not echo back to RingTonic.

Capability: manage_options

Parameters

ParameterTypeRequiredDescription
idintegeryes
statusstringyes

Returns

data: {id, status, label}

Request

{
"resource": "leads",
"action": "set_status",
"params": {
"id": 0,
"status": "string"
}
}

verify

Verify the tamper-evident integrity chain for a lead.

Capability: manage_options

Parameters

ParameterTypeRequiredDescription
idintegeryes

Returns

data: {id, chain:{ok,count,broken_at}}

Request

{
"resource": "leads",
"action": "verify",
"params": {
"id": 0
}
}