Lead Groups

Get a Lead Group

get

Query parameters

lead_group_idintegerRequired

The ID of the lead group to retrieve

company_idintegerOptional

The ID of the company associated with the group (at least one of company_id or user_id is required)

user_idintegerOptional

The ID of the user associated with the group (at least one of company_id or user_id is required)

send_lead_objectsbooleanOptional

Whether to include lead objects in the group response (optional)

Responses

200

Successful retrieval of the lead group.

application/json

get

/lead/group

HTTPcURLJavaScriptPython

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

200

Successful retrieval of the lead group.

{
  "status": "success",
  "group": {
    "members": [
      {
        "id": 3178,
        "user_id": 21140,
        "profile_id": null,
        "company_id": 385,
        "device_id": null,
        "contact_group_id": null,
        "name": "Test Auto Sync",
        "job": "",
        "company": "TESTAUTOSYNC INC.",
        "phone": "",
        "email": "[email protected]",
        "url": "",
        "address": "",
        "image": null,
        "description": "",
        "type": "lead",
        "file": null,
        "fav": null,
        "timestamp": 1723185083,
        "data_consent_given": 1,
        "token": "3178-GFw2anHV5ziTODhWmQEmDHTf4cyr5O0o",
        "profile_name": null,
        "image_profile": null,
        "profile_job": null,
        "device_description": null,
        "device_profile_id": null,
        "device_redirect": null,
        "labels": [
          "test1"
        ],
        "connected_device": [
          {}
        ],
        "connected_profile": null
      }
    ]
  }
}

Create a Lead Group

post

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successful creation of the lead group.

application/json

post

/lead/group

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "company_id": 1,
  "user_id": 1
}

200

Successful creation of the lead group.

{
  "status": "success",
  "group": {
    "id": 1,
    "name": "Group 1",
    "company_id": 1,
    "user_id": 1,
    "profile_id": 1,
    "timestamp": 1723185083
  }
}

Update a Lead Group

put

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successful update of the lead group.

application/json

put

/lead/group

HTTPcURLJavaScriptPython

PUT /lead/group HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "lead_group_id": 1,
  "name": "text",
  "company_id": 1,
  "user_id": 1
}

200

Successful update of the lead group.

{
  "status": "success",
  "group": {
    "id": 1,
    "name": "Group 1",
    "company_id": 1,
    "user_id": 1,
    "profile_id": 1,
    "timestamp": 1723185083
  }
}

Delete a Lead Group

delete

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successful deletion of the lead group.

application/json

delete

/lead/group

HTTPcURLJavaScriptPython

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

{
  "lead_group_id": 1,
  "company_id": 1,
  "user_id": 1
}

200

Successful deletion of the lead group.

{
  "status": "success"
}

Get Lead Groups

get

Query parameters

company_idintegerOptional

The ID of the company associated with the groups (at least one of company_id or user_id is required)

user_idintegerOptional

The ID of the user associated with the groups (at least one of company_id or user_id is required)

Responses

200

Successful retrieval of lead groups.

application/json

get

/lead/groups

HTTPcURLJavaScriptPython

GET /lead/groups HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful retrieval of lead groups.

{
  "status": "success",
  "groups": [
    {
      "id": 1,
      "name": "Group 1",
      "company_id": 1,
      "user_id": 1,
      "profile_id": 1,
      "timestamp": 1723185083
    }
  ]
}

Add Members to Lead Group

post

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successful addition of members to the lead group.

application/json

post

/lead/group/members

HTTPcURLJavaScriptPython

POST /lead/group/members HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "lead_group_id": 1,
  "lead_ids": [
    1
  ],
  "company_id": 1,
  "user_id": 1
}

200

Successful addition of members to the lead group.

{
  "status": "success",
  "group": {
    "id": 1,
    "name": "Group 1",
    "company_id": 1,
    "user_id": 1,
    "profile_id": 1,
    "timestamp": 1723185083
  }
}

Remove Members from Lead Group

post

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successful removal of members from the lead group.

application/json

post

/lead/group/remove

HTTPcURLJavaScriptPython

POST /lead/group/remove HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "lead_group_id": 1,
  "lead_ids": [
    1
  ],
  "company_id": 1,
  "user_id": 1
}

200

Successful removal of members from the lead group.

{
  "status": "success"
}

Search Lead Groups

get

Query parameters

querystringRequired

The search query string

company_idintegerOptional

The ID of the company associated with the groups (optional, but required if user_id is not provided)

user_idintegerOptional

The ID of the user associated with the groups (optional, but required if company_id is not provided)

Responses

200

Successful search of lead groups.

application/json

get

/lead/groups/search

HTTPcURLJavaScriptPython

GET /lead/groups/search?query=text HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful search of lead groups.

{
  "status": "success",
  "groups": [
    {
      "id": 1,
      "name": "Group 1",
      "company_id": 1,
      "user_id": 1,
      "profile_id": 1,
      "timestamp": 1723185083
    }
  ]
}