Lead

Get a Lead

get

Query parameters

lead_idintegerRequired

The ID of the lead to retrieve

Responses

200

Successful retrieval of the lead.

application/json

get

/lead

HTTPcURLJavaScriptPython

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

200

Successful retrieval of the lead.

{
  "status": "success",
  "lead": {
    "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

post

Body

application/json

emailstringRequired

The email address of the lead

user_idintegerOptional

The ID of the user creating the lead (optional)

company_idintegerOptional

The ID of the company associated with the lead (optional)

profile_idintegerOptional

The ID of the profile associated with the lead (optional)

namestringOptional

The name of the lead (optional)

jobstringOptional

The job title of the lead (optional)

companystringOptional

The company name of the lead (optional)

phonestringOptional

The phone number of the lead (optional)

urlstringOptional

The URL associated with the lead (optional)

addressstringOptional

The address of the lead (optional)

imagestringOptional

The image URL of the lead (optional)

descriptionstringOptional

Additional description for the lead (optional)

Responses

200

Successful creation of the lead.

application/json

post

/lead

HTTPcURLJavaScriptPython

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

{
  "email": "text",
  "user_id": 1,
  "company_id": 1,
  "profile_id": 1,
  "name": "text",
  "job": "text",
  "company": "text",
  "phone": "text",
  "url": "text",
  "address": "text",
  "image": "text",
  "description": "text"
}

200

Successful creation of the lead.

{
  "status": "success",
  "lead": {
    "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
  }
}

Update a Lead

put

Body

application/json

lead_idintegerRequired

The ID of the lead to update

descriptionstringOptional

The description of the lead

imagestringOptional

The image URL of the lead

addressstringOptional

The address of the lead

urlstringOptional

The URL associated with the lead

emailstringOptional

The email address of the lead

phonestringOptional

The phone number of the lead

companystringOptional

The company name of the lead

jobstringOptional

The job title of the lead

namestringOptional

The name of the lead

company_idintegerOptional

The ID of the company associated with the lead

profile_idintegerOptional

The ID of the profile associated with the lead

user_idintegerOptional

The ID of the user associated with the lead

favbooleanOptional

Whether the lead is marked as a favorite

labelsstring[]Optional

An array of labels associated with the lead

Responses

200

Successful update of the lead.

application/json

put

/lead

HTTPcURLJavaScriptPython

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

{
  "lead_id": 1,
  "description": "text",
  "image": "text",
  "address": "text",
  "url": "text",
  "email": "text",
  "phone": "text",
  "company": "text",
  "job": "text",
  "name": "text",
  "company_id": 1,
  "profile_id": 1,
  "user_id": 1,
  "fav": true,
  "labels": [
    "text"
  ]
}

200

Successful update of the lead.

{
  "status": "success",
  "lead": {
    "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
  }
}

Update Lead Profile

put

Body

application/json

lead_idintegerRequired

The ID of the lead to update

company_idintegerRequired

The ID of the company associated with the lead

profile_idintegerOptional

The ID of the new profile to associate with the lead

Responses

200

Successful update of the lead profile.

application/json

put

/lead/profile

HTTPcURLJavaScriptPython

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

{
  "lead_id": 1,
  "company_id": 1,
  "profile_id": 1
}

200

Successful update of the lead profile.

{
  "status": "success",
  "lead": {
    "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
  }
}

Delete a Lead

delete

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successful deletion of the lead.

application/json

delete

/lead

HTTPcURLJavaScriptPython

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

{
  "lead_id": 1,
  "lead_token": "text",
  "language": "text"
}

200

Successful deletion of the lead.

{
  "status": "success"
}