API reference
Campaigns
Which campaign, ad set and ad each lead came from.
GET/campaigns
List campaigns
Every campaign leads came from, per platform, with its lead count and, for agencies, who owns it.
Needs the permission leads:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
platform | query | one of meta, google, bing, linkedin, tiktok, other | |
q | query | string | up to 100 characters |
days | query | integer | at least 1. up to 365 |
curl -X GET https://crm.anibrosdesign.com/api/v1/campaigns \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
GET/campaigns/lead/{id}
Get lead (campaign)
Needs the permission leads:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/campaigns/lead/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
GET/campaigns/{id}
Get a campaign
Needs the permission leads:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/campaigns/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
PATCH/campaigns/{id}
Change a campaign
Needs the permission integrations:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
name | string or null |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/campaigns/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text"}'Responses:
200 400 401 402 403 404 412 429
Something missing or unclear? Tell us.