Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /smartlead | Type: Application | PCID required: Yes
smartlead_add_domain_block_list
Add domains to block list
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
domains | string[] | Yes | — | List of domains to block |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of domains to block"
}
},
"required": [
"PCID",
"domains"
]
}
smartlead_add_email_account_to_campaign
Add email account to a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
email_account_id | integer | Yes | — | The email account ID to add |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"email_account_id": {
"type": "integer",
"description": "The email account ID to add"
}
},
"required": [
"PCID",
"campaign_id",
"email_account_id"
]
}
smartlead_add_leads_to_campaign
Add leads to a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_list | object[] | Yes | — | Array of lead objects to add |
settings | object | No | — | Import settings |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"lead_list": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of lead objects to add"
},
"settings": {
"type": "object",
"description": "Import settings",
"properties": {
"ignore_global_block_list": {
"type": "boolean",
"description": "Whether to ignore the global block list"
},
"ignore_unsubscribe_list": {
"type": "boolean",
"description": "Whether to ignore the unsubscribe list"
}
}
}
},
"required": [
"PCID",
"campaign_id",
"lead_list"
]
}
Configure email warmup
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email_account_id | integer | Yes | — | The email account ID |
daily_rampup | integer | Yes | — | Additional warmup emails added per day |
reply_rate_percentage | integer | Yes | — | Percentage of warmup emails to reply to |
total_warmup_per_day | integer | Yes | — | Total warmup emails per day |
warmup_enabled | boolean | Yes | — | Whether warmup is enabled |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email_account_id": {
"type": "integer",
"description": "The email account ID"
},
"daily_rampup": {
"type": "integer",
"description": "Additional warmup emails added per day"
},
"reply_rate_percentage": {
"type": "integer",
"description": "Percentage of warmup emails to reply to"
},
"total_warmup_per_day": {
"type": "integer",
"description": "Total warmup emails per day"
},
"warmup_enabled": {
"type": "boolean",
"description": "Whether warmup is enabled"
}
},
"required": [
"PCID",
"email_account_id",
"daily_rampup",
"reply_rate_percentage",
"total_warmup_per_day",
"warmup_enabled"
]
}
smartlead_create_campaign
Create a new campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
client_id | integer | No | — | Client ID to associate the campaign with |
name | string | No | — | Campaign name. Defaults to “Untitled Campaign” if not provided. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"client_id": {
"type": "integer",
"description": "Client ID to associate the campaign with"
},
"name": {
"type": "string",
"description": "Campaign name. Defaults to \"Untitled Campaign\" if not provided."
}
},
"required": [
"PCID"
]
}
smartlead_create_email_account
Create a new email account
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
bcc | string | No | — | BCC email address |
custom_tracking_url | string | No | — | Custom tracking domain URL |
from_email | string | Yes | — | Email address to send from |
from_name | string | Yes | — | Display name for the sender |
imap_host | string | Yes | — | IMAP server hostname (e.g., imap.gmail.com) |
imap_port | integer | Yes | — | IMAP port (typically 993) |
max_email_per_day | integer | No | — | Maximum emails to send per day |
password | string | Yes | — | App password for SMTP/IMAP |
signature | string | No | — | HTML email signature |
smtp_host | string | Yes | — | SMTP server hostname (e.g., smtp.gmail.com) |
smtp_port | integer | Yes | — | SMTP port (587 for TLS, 465 for SSL) |
smtp_port_type | string | Yes | — | SMTP encryption type |
username | string | Yes | — | SMTP/IMAP login username |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"bcc": {
"type": "string",
"description": "BCC email address"
},
"custom_tracking_url": {
"type": "string",
"description": "Custom tracking domain URL"
},
"from_email": {
"type": "string",
"description": "Email address to send from"
},
"from_name": {
"type": "string",
"description": "Display name for the sender"
},
"imap_host": {
"type": "string",
"description": "IMAP server hostname (e.g., imap.gmail.com)"
},
"imap_port": {
"type": "integer",
"description": "IMAP port (typically 993)"
},
"max_email_per_day": {
"type": "integer",
"description": "Maximum emails to send per day"
},
"password": {
"type": "string",
"description": "App password for SMTP/IMAP"
},
"signature": {
"type": "string",
"description": "HTML email signature"
},
"smtp_host": {
"type": "string",
"description": "SMTP server hostname (e.g., smtp.gmail.com)"
},
"smtp_port": {
"type": "integer",
"description": "SMTP port (587 for TLS, 465 for SSL)"
},
"smtp_port_type": {
"type": "string",
"description": "SMTP encryption type",
"enum": [
"TLS",
"SSL"
]
},
"username": {
"type": "string",
"description": "SMTP/IMAP login username"
}
},
"required": [
"PCID",
"from_email",
"from_name",
"imap_host",
"imap_port",
"password",
"smtp_host",
"smtp_port",
"smtp_port_type",
"username"
]
}
smartlead_delete_campaign
Delete a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_delete_lead_from_campaign
Delete a lead from a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
}
},
"required": [
"PCID",
"campaign_id",
"lead_id"
]
}
smartlead_export_campaign_leads
Export campaign leads to CSV
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_get_analytics_overview
Get global analytics overview
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
smartlead_get_campaign
Get a campaign by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_get_campaign_analytics
Get top-level campaign analytics
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_get_campaign_analytics_by_date
Get campaign analytics by date range
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
start_date | string | No | — | Start date (YYYY-MM-DD format) |
end_date | string | No | — | End date (YYYY-MM-DD format) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"start_date": {
"type": "string",
"description": "Start date (YYYY-MM-DD format)"
},
"end_date": {
"type": "string",
"description": "End date (YYYY-MM-DD format)"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_get_campaign_sequences
Get campaign email sequences
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_get_campaign_statistics
Get campaign statistics
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_get_email_account
Get an email account by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email_account_id | integer | Yes | — | The email account ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email_account_id": {
"type": "integer",
"description": "The email account ID"
}
},
"required": [
"PCID",
"email_account_id"
]
}
smartlead_get_email_warmup_stats
Get email warmup statistics
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email_account_id | integer | Yes | — | The email account ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email_account_id": {
"type": "integer",
"description": "The email account ID"
}
},
"required": [
"PCID",
"email_account_id"
]
}
smartlead_get_lead_by_email
Get a lead by email address
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email | string | Yes | — | The lead’s email address |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "The lead's email address"
}
},
"required": [
"PCID",
"email"
]
}
smartlead_get_lead_campaigns
Get campaigns for a lead
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
lead_id | integer | Yes | — | The lead ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
}
},
"required": [
"PCID",
"lead_id"
]
}
smartlead_get_lead_categories
Get lead categories
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
smartlead_get_lead_message_history
Get message history for a lead
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
}
},
"required": [
"PCID",
"campaign_id",
"lead_id"
]
}
smartlead_list_campaign_email_accounts
List email accounts assigned to a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_list_campaign_leads
List leads in a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
offset | integer | No | — | Pagination offset |
limit | integer | No | — | Number of results to return (max 100) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_list_campaigns
List all campaigns
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
client_id | integer | No | — | Filter campaigns by client ID |
include_tags | boolean | No | — | Include campaign tags in the response |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"client_id": {
"type": "integer",
"description": "Filter campaigns by client ID"
},
"include_tags": {
"type": "boolean",
"description": "Include campaign tags in the response"
}
},
"required": [
"PCID"
]
}
smartlead_list_email_accounts
List all email accounts
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
offset | integer | No | — | Pagination offset |
limit | integer | No | — | Number of results to return (max 100) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
}
},
"required": [
"PCID"
]
}
smartlead_pause_lead
Pause a lead in a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
}
},
"required": [
"PCID",
"campaign_id",
"lead_id"
]
}
smartlead_remove_email_account_from_campaign
Remove email account from a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
email_account_id | integer | Yes | — | The email account ID to remove |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"email_account_id": {
"type": "integer",
"description": "The email account ID to remove"
}
},
"required": [
"PCID",
"campaign_id",
"email_account_id"
]
}
smartlead_reply_to_email_thread
Reply to a lead’s email thread
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
email_body | string | Yes | — | The reply email body in HTML |
lead_id | integer | Yes | — | The lead ID to reply to |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"email_body": {
"type": "string",
"description": "The reply email body in HTML"
},
"lead_id": {
"type": "integer",
"description": "The lead ID to reply to"
}
},
"required": [
"PCID",
"campaign_id",
"email_body",
"lead_id"
]
}
smartlead_resume_lead
Resume a lead in a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
}
},
"required": [
"PCID",
"campaign_id",
"lead_id"
]
}
smartlead_save_campaign_sequences
Save campaign email sequences
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
body | object[] | Yes | — | Request body |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"body": {
"type": "array",
"items": {
"type": "object"
},
"description": "Request body"
}
},
"required": [
"PCID",
"campaign_id",
"body"
]
}
smartlead_unsubscribe_lead_from_campaign
Unsubscribe a lead from a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
}
},
"required": [
"PCID",
"campaign_id",
"lead_id"
]
}
smartlead_unsubscribe_lead_globally
Unsubscribe a lead globally
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
lead_id | integer | Yes | — | The lead ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
}
},
"required": [
"PCID",
"lead_id"
]
}
smartlead_update_campaign_schedule
Update campaign sending schedule
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
days_of_the_week | integer[] | Yes | — | Active days (0=Sunday through 6=Saturday) |
end_hour | string | Yes | — | End hour in 24-hour format (e.g., 19:00) |
max_leads_per_day | integer | Yes | — | Maximum number of leads to contact per day |
min_time_btw_emails | integer | Yes | — | Minimum minutes between emails |
start_hour | string | Yes | — | Start hour in 24-hour format (e.g., 09:00) |
timezone | string | Yes | — | IANA timezone format (e.g., America/New_York) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"days_of_the_week": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Active days (0=Sunday through 6=Saturday)"
},
"end_hour": {
"type": "string",
"description": "End hour in 24-hour format (e.g., 19:00)"
},
"max_leads_per_day": {
"type": "integer",
"description": "Maximum number of leads to contact per day"
},
"min_time_btw_emails": {
"type": "integer",
"description": "Minimum minutes between emails"
},
"start_hour": {
"type": "string",
"description": "Start hour in 24-hour format (e.g., 09:00)"
},
"timezone": {
"type": "string",
"description": "IANA timezone format (e.g., America/New_York)"
}
},
"required": [
"PCID",
"campaign_id",
"days_of_the_week",
"end_hour",
"max_leads_per_day",
"min_time_btw_emails",
"start_hour",
"timezone"
]
}
smartlead_update_campaign_settings
Update campaign general settings
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
client_id | integer | No | — | Client ID to associate (null to remove) |
enable_ai_esp_matching | boolean | No | — | Enable AI ESP matching |
follow_up_percentage | number | No | — | Follow-up percentage (0-100) |
send_as_plain_text | boolean | No | — | Send emails as plain text instead of HTML |
stop_lead_settings | string | No | — | When to stop sending to a lead |
track_settings | string[] | No | — | Tracking flags to disable |
unsubscribe_text | string | No | — | Custom unsubscribe text |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"client_id": {
"type": "integer",
"description": "Client ID to associate (null to remove)"
},
"enable_ai_esp_matching": {
"type": "boolean",
"description": "Enable AI ESP matching"
},
"follow_up_percentage": {
"type": "number",
"description": "Follow-up percentage (0-100)"
},
"send_as_plain_text": {
"type": "boolean",
"description": "Send emails as plain text instead of HTML"
},
"stop_lead_settings": {
"type": "string",
"description": "When to stop sending to a lead",
"enum": [
"REPLY_TO_AN_EMAIL",
"OPENED_EMAIL",
"CLICKED_LINK",
"NEVER"
]
},
"track_settings": {
"type": "array",
"items": {
"type": "string",
"enum": [
"DONT_EMAIL_OPEN",
"DONT_LINK_CLICK"
]
},
"description": "Tracking flags to disable"
},
"unsubscribe_text": {
"type": "string",
"description": "Custom unsubscribe text"
}
},
"required": [
"PCID",
"campaign_id"
]
}
smartlead_update_campaign_status
Update campaign status
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
status | string | Yes | — | New campaign status: START, PAUSED, or STOPPED |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"status": {
"type": "string",
"description": "New campaign status: START, PAUSED, or STOPPED",
"enum": [
"START",
"PAUSED",
"STOPPED"
]
}
},
"required": [
"PCID",
"campaign_id",
"status"
]
}
smartlead_update_email_account
Update an email account
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email_account_id | integer | Yes | — | The email account ID |
bcc | string | No | — | BCC email address |
custom_tracking_url | string | No | — | Custom tracking domain URL |
from_email | string | No | — | Email address to send from |
from_name | string | No | — | Display name for the sender |
max_email_per_day | integer | No | — | Maximum emails to send per day |
signature | string | No | — | HTML email signature |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email_account_id": {
"type": "integer",
"description": "The email account ID"
},
"bcc": {
"type": "string",
"description": "BCC email address"
},
"custom_tracking_url": {
"type": "string",
"description": "Custom tracking domain URL"
},
"from_email": {
"type": "string",
"description": "Email address to send from"
},
"from_name": {
"type": "string",
"description": "Display name for the sender"
},
"max_email_per_day": {
"type": "integer",
"description": "Maximum emails to send per day"
},
"signature": {
"type": "string",
"description": "HTML email signature"
}
},
"required": [
"PCID",
"email_account_id"
]
}
smartlead_update_lead
Update a lead in a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
campaign_id | integer | Yes | — | The campaign ID |
lead_id | integer | Yes | — | The lead ID |
company | string | No | — | The company value |
custom_fields | object | No | — | Custom Fields |
first_name | string | No | — | First Name |
last_name | string | No | — | Last Name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "integer",
"description": "The campaign ID"
},
"lead_id": {
"type": "integer",
"description": "The lead ID"
},
"company": {
"type": "string",
"description": "The company value"
},
"custom_fields": {
"type": "object",
"description": "Custom Fields"
},
"first_name": {
"type": "string",
"description": "First Name"
},
"last_name": {
"type": "string",
"description": "Last Name"
}
},
"required": [
"PCID",
"campaign_id",
"lead_id"
]
}