Lead Company Campaigns

Reference for the lead_company_campaigns resource. Requests follow the conventions in Requests and Responses; fields you receive and may write are filtered by your user's permissions, so responses can contain a subset of the fields below.

Operations

Not available as a standard REST operation for this resource: create, update, delete — such requests return 402 feature_not_enabled or 403 permission_denied.

How it works

lead_company_campaigns is the read-only catalog of Source Campaigns — campaigns under a Source. Labeled "Source Campaign" in the UI; the customer field is lead_company_campaign_id. These are the valid lead_company_campaign_id values for a customer/lead.

Filter by lead_company_id to get the campaigns for one Source (the usual lookup after picking a Source). Gated by the Customer Sale Info permission.

# Campaigns for Source #42
curl "https://portal.securitytrax.com/acme/user/v4/lead_company_campaigns?lead_company_id=42" \
  -H "Authorization: Bearer stx_acme_..."

Also filter by name; sort by id or name; GET /{id} fetches one.

Fields

Fields are grouped by the permission that gates them. A group you may not view is absent from responses; a group you may not write is rejected with 422 when sent in a write.

Lead Company Campaign

View: Customer Sale Info.

Pagination

The list endpoint uses client-controlled offset pagination: ?page= (1-based) and ?per_page= (default 25, max 100). The response mirrors meta.pagination (page, per_page, total, last_page) and sends an RFC5988 Link header; follow rel="next" to walk pages. See Pagination.

Filters

The list endpoint accepts these query-param filters: name, lead_company_id. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

GET .../lead_company_campaigns?sort= orders the list by: id, name. Prefix a field with - for descending; comma-separate for tie-breakers. An unsupported field returns 422. See Sorting collections.

Related

• Requests and Responses — envelope, errors, pagination, and rate limits.
• Authentication — tokens and the Authorization header.