Lead Campaigns

Get Lead Campaigns

get

Query parameters

company_idintegerRequired

The ID of the company whose lead campaigns will be retrieved

Responses

200

Successful retrieval of lead campaigns.

application/json

get

/lead/campaigns

HTTPcURLJavaScriptPython

GET /lead/campaigns?company_id=1 HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful retrieval of lead campaigns.

{
  "status": "success",
  "campaigns": [
    {
      "id": 1,
      "name": "text",
      "start_date": "2025-12-14",
      "end_date": "2025-12-14",
      "description": "text"
    }
  ]
}

Create a Lead Campaign

post

Body

application/json

company_idintegerRequired

The ID of the company associated with the lead campaign

namestringRequired

The name of the lead campaign

start_datestring · dateRequired

The start date of the lead campaign

end_datestring · dateRequired

The end date of the lead campaign

descriptionstringOptional

A description of the lead campaign (optional)

profile_idsinteger[]Optional

An array of profile IDs associated with the lead campaign (optional)

Responses

200

Successful creation of the lead campaign.

application/json

post

/lead/campaigns

HTTPcURLJavaScriptPython

POST /lead/campaigns HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "company_id": 1,
  "name": "text",
  "start_date": "2025-12-14",
  "end_date": "2025-12-14",
  "description": "text",
  "profile_ids": [
    1
  ]
}

200

Successful creation of the lead campaign.

{
  "status": "success",
  "campaign_id": 1
}

Get a Lead Campaign

get

Query parameters

campaign_idintegerRequired

The ID of the lead campaign to retrieve

Responses

200

Successful retrieval of the lead campaign.

application/json

get

/lead/campaign

HTTPcURLJavaScriptPython

GET /lead/campaign?campaign_id=1 HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful retrieval of the lead campaign.

{
  "status": "success",
  "campaign": {
    "id": 1,
    "name": "text",
    "start_date": "2025-12-14",
    "end_date": "2025-12-14",
    "description": "text",
    "profiles": [
      1
    ]
  }
}

Delete a Lead Campaign

delete

Body

application/json

campaign_idintegerRequired

The ID of the lead campaign to delete

company_idintegerRequired

The ID of the company associated with the lead campaign

Responses

200

Successful deletion of the lead campaign.

application/json

delete

/lead/campaign

HTTPcURLJavaScriptPython

DELETE /lead/campaign HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "campaign_id": 1,
  "company_id": 1
}

200

Successful deletion of the lead campaign.

{
  "status": "success"
}

Update Lead Campaign Profiles

put

Body

application/json

company_idintegerRequired

The ID of the company associated with the lead campaign

campaign_idintegerRequired

The ID of the lead campaign to update

profile_idsinteger[]Required

An array of profile IDs to associate with the lead campaign

Responses

200

Successful update of lead campaign profiles.

application/json

put

/lead/campaign/profiles

HTTPcURLJavaScriptPython

PUT /lead/campaign/profiles HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "company_id": 1,
  "campaign_id": 1,
  "profile_ids": [
    1
  ]
}

200

Successful update of lead campaign profiles.

{
  "status": "success"
}