Add Tag to Lead

Add a tag to a lead for organization, segmentation, and workflow triggers. Tags are useful for tracking lead status, campaign source, or custom categories.

Use underscores for multi-word tags (e.g., High_Priority, not High Priority).

PATCH /lead/tag

Add Tag to Lead

cURL

curl --request PATCH \
  --url https://api.plura.ai/v1/lead/tag \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lead_id": "307fc241-8398-4740-8122-cf6a59f3b86e",
  "tag": "High_Priority"
}
'

import requests

url = "https://api.plura.ai/v1/lead/tag"

payload = {
    "lead_id": "307fc241-8398-4740-8122-cf6a59f3b86e",
    "tag": "High_Priority"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({lead_id: '307fc241-8398-4740-8122-cf6a59f3b86e', tag: 'High_Priority'})
};

fetch('https://api.plura.ai/v1/lead/tag', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.plura.ai/v1/lead/tag",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'lead_id' => '307fc241-8398-4740-8122-cf6a59f3b86e',
    'tag' => 'High_Priority'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plura.ai/v1/lead/tag"

	payload := strings.NewReader("{\n  \"lead_id\": \"307fc241-8398-4740-8122-cf6a59f3b86e\",\n  \"tag\": \"High_Priority\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.plura.ai/v1/lead/tag")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lead_id\": \"307fc241-8398-4740-8122-cf6a59f3b86e\",\n  \"tag\": \"High_Priority\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.plura.ai/v1/lead/tag")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lead_id\": \"307fc241-8398-4740-8122-cf6a59f3b86e\",\n  \"tag\": \"High_Priority\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "lead_id": "<string>",
  "tag": "<string>",
  "message": "Tag added successfully"
}

{
  "status": "failed",
  "message": "Human-readable error description"
}

{
  "status": "failed",
  "message": "Human-readable error description"
}

Authorizations

Authorization · string · header · required

API key from Settings → API Keys in your workspace

Body

application/json

lead_id · string · required

UUID of the lead to tag

Example:

"307fc241-8398-4740-8122-cf6a59f3b86e"

tag · string · required

Tag name. Use underscores for multi-word tags.

Example:

"High_Priority"

Response

200

application/json

Tag added successfully

status · string

Example:

"success"

lead_id · string

tag · string

message · string

Example:

"Tag added successfully"