/follow-up-boss | Type: Application | PCID required: Yes
Tools
follow_up_boss_create_appointment
Create an appointment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Appointment description |
end | string | Yes | — | End date and time (ISO 8601) |
personId | integer | Yes | — | Person ID |
start | string | Yes | — | Start date and time (ISO 8601) |
title | string | Yes | — | Appointment title |
typeId | integer | No | — | Appointment type ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Appointment description"
},
"end": {
"type": "string",
"description": "End date and time (ISO 8601)"
},
"personId": {
"type": "integer",
"description": "Person ID"
},
"start": {
"type": "string",
"description": "Start date and time (ISO 8601)"
},
"title": {
"type": "string",
"description": "Appointment title"
},
"typeId": {
"type": "integer",
"description": "Appointment type ID"
}
},
"required": [
"PCID",
"end",
"personId",
"start",
"title"
]
}
follow_up_boss_create_call
Log a call record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
duration | integer | No | — | Call duration in seconds |
incoming | boolean | No | — | Whether this was an incoming call |
note | string | No | — | Call notes |
outcome | string | No | — | Call outcome |
personId | integer | Yes | — | Person ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"duration": {
"type": "integer",
"description": "Call duration in seconds"
},
"incoming": {
"type": "boolean",
"description": "Whether this was an incoming call"
},
"note": {
"type": "string",
"description": "Call notes"
},
"outcome": {
"type": "string",
"description": "Call outcome"
},
"personId": {
"type": "integer",
"description": "Person ID"
}
},
"required": [
"PCID",
"personId"
]
}
follow_up_boss_create_deal
Create a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Deal description |
name | string | Yes | — | Deal name |
people | object[] | No | — | Person IDs to associate with the deal |
pipelineId | integer | No | — | Pipeline ID |
price | integer | No | — | Deal value |
projectedCloseDate | string | No | — | Projected close date (YYYY-MM-DD) |
stageId | integer | Yes | — | Stage ID (required — must be a stage that belongs to the specified pipeline) |
users | object[] | No | — | User IDs to assign to the deal |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Deal description"
},
"name": {
"type": "string",
"description": "Deal name"
},
"people": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"id"
]
},
"description": "Person IDs to associate with the deal"
},
"pipelineId": {
"type": "integer",
"description": "Pipeline ID"
},
"price": {
"type": "integer",
"description": "Deal value"
},
"projectedCloseDate": {
"type": "string",
"description": "Projected close date (YYYY-MM-DD)"
},
"stageId": {
"type": "integer",
"description": "Stage ID (required — must be a stage that belongs to the specified pipeline)"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"id"
]
},
"description": "User IDs to assign to the deal"
}
},
"required": [
"PCID",
"name",
"stageId"
]
}
follow_up_boss_create_event
Create an event (import a lead) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message | string | No | — | Event message / description |
person | object | Yes | — | Person data to create or match (required for lead import). Provide id to link to an existing contact, or provide name/email/phone to create or match. |
property | object | No | — | Property details (for real estate events) |
source | string | Yes | — | Event source system name |
system | string | No | — | System identifier |
type | string | Yes | — | Event type (e.g., Registration, Inquiry, Property Inquiry) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"message": {
"type": "string",
"description": "Event message / description"
},
"person": {
"type": "object",
"description": "Person data to create or match (required for lead import). Provide id to link to an existing contact, or provide name/email/phone to create or match.",
"properties": {
"id": {
"type": "integer",
"description": "Existing person ID to link event to (prevents duplicate creation)"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"emails": {
"type": "array",
"items": {
"type": "object"
},
"description": "The emails value"
},
"phones": {
"type": "array",
"items": {
"type": "object"
},
"description": "The phones value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"source": {
"type": "string",
"description": "The source value"
},
"sourceUrl": {
"type": "string",
"description": "Source Url"
}
}
},
"property": {
"type": "object",
"description": "Property details (for real estate events)",
"properties": {
"street": {
"type": "string",
"description": "The street value"
},
"city": {
"type": "string",
"description": "The city value"
},
"state": {
"type": "string",
"description": "The state value"
},
"code": {
"type": "string",
"description": "The code value"
},
"mlsNumber": {
"type": "string",
"description": "Mls Number"
},
"price": {
"type": "integer",
"description": "The price value"
},
"forRent": {
"type": "boolean",
"description": "For Rent"
},
"url": {
"type": "string",
"description": "The url value"
},
"type": {
"type": "string",
"description": "The type value"
}
}
},
"source": {
"type": "string",
"description": "Event source system name"
},
"system": {
"type": "string",
"description": "System identifier"
},
"type": {
"type": "string",
"description": "Event type (e.g., Registration, Inquiry, Property Inquiry)"
}
},
"required": [
"PCID",
"person",
"source",
"type"
]
}
follow_up_boss_create_note
Create a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | Yes | — | Note body content (HTML supported) |
isHtml | boolean | No | — | Whether body contains HTML |
personId | integer | Yes | — | Person ID to attach note to |
subject | string | No | — | Note subject |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "string",
"description": "Note body content (HTML supported)"
},
"isHtml": {
"type": "boolean",
"description": "Whether body contains HTML"
},
"personId": {
"type": "integer",
"description": "Person ID to attach note to"
},
"subject": {
"type": "string",
"description": "Note subject"
}
},
"required": [
"PCID",
"body",
"personId"
]
}
follow_up_boss_create_person
Create a new person (contact) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deduplicate | boolean | No | — | If true, checks for existing contacts with matching email/phone before creating. Returns existing contact if found. |
addresses | object[] | No | — | Mailing addresses |
assignedUserId | integer | No | — | Assigned user ID |
background | string | No | — | Background notes (multiline) |
collaborators | integer[] | No | — | Collaborator user IDs |
emails | object[] | No | — | Email addresses |
firstName | string | No | — | First name |
lastName | string | No | — | Last name |
phones | object[] | No | — | Phone numbers |
price | integer | No | — | Deal price / property value |
source | string | No | — | Lead source |
sourceUrl | string | No | — | URL where the lead originated |
stage | string | No | — | Pipeline stage (e.g., Lead, Prospect, Active Client) |
tags | string[] | No | — | Tags to assign |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deduplicate": {
"type": "boolean",
"description": "If true, checks for existing contacts with matching email/phone before creating. Returns existing contact if found."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"street": {
"type": "string",
"description": "The street value"
},
"city": {
"type": "string",
"description": "The city value"
},
"state": {
"type": "string",
"description": "The state value"
},
"code": {
"type": "string",
"description": "The code value"
},
"country": {
"type": "string",
"description": "The country value"
},
"type": {
"type": "string",
"enum": [
"home",
"work",
"other"
],
"description": "The type value"
}
}
},
"description": "Mailing addresses"
},
"assignedUserId": {
"type": "integer",
"description": "Assigned user ID"
},
"background": {
"type": "string",
"description": "Background notes (multiline)"
},
"collaborators": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Collaborator user IDs"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value value"
},
"type": {
"type": "string",
"enum": [
"home",
"work",
"other"
],
"description": "The type value"
},
"isPrimary": {
"type": "boolean",
"description": "Is Primary"
}
},
"required": [
"value"
]
},
"description": "Email addresses"
},
"firstName": {
"type": "string",
"description": "First name"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value value"
},
"type": {
"type": "string",
"enum": [
"home",
"work",
"mobile",
"fax",
"other"
],
"description": "The type value"
},
"isPrimary": {
"type": "boolean",
"description": "Is Primary"
}
},
"required": [
"value"
]
},
"description": "Phone numbers"
},
"price": {
"type": "integer",
"description": "Deal price / property value"
},
"source": {
"type": "string",
"description": "Lead source"
},
"sourceUrl": {
"type": "string",
"description": "URL where the lead originated"
},
"stage": {
"type": "string",
"description": "Pipeline stage (e.g., Lead, Prospect, Active Client)"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to assign"
}
},
"required": [
"PCID"
]
}
follow_up_boss_create_task
Create a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assignedTo | string | No | — | Assigned user name |
assignedUserId | integer | No | — | Assigned user ID |
dueDate | string | No | — | Due date (YYYY-MM-DD) |
dueDateTime | string | No | — | Due date and time (ISO 8601) |
name | string | Yes | — | Task name |
personId | integer | No | — | Person ID to link task to |
type | string | No | — | Task type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assignedTo": {
"type": "string",
"description": "Assigned user name"
},
"assignedUserId": {
"type": "integer",
"description": "Assigned user ID"
},
"dueDate": {
"type": "string",
"description": "Due date (YYYY-MM-DD)"
},
"dueDateTime": {
"type": "string",
"description": "Due date and time (ISO 8601)"
},
"name": {
"type": "string",
"description": "Task name"
},
"personId": {
"type": "integer",
"description": "Person ID to link task to"
},
"type": {
"type": "string",
"description": "Task type",
"enum": [
"Follow Up",
"Call",
"Email",
"Text",
"Appointment",
"Other"
]
}
},
"required": [
"PCID",
"name"
]
}
follow_up_boss_create_text_message
Log a text message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromNumber | string | Yes | — | Sender phone number |
isIncoming | boolean | No | — | Whether this was an incoming message (true) or outgoing (false) |
message | string | Yes | — | Text message content |
personId | integer | Yes | — | Person ID |
toNumber | string | Yes | — | Recipient phone number |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fromNumber": {
"type": "string",
"description": "Sender phone number"
},
"isIncoming": {
"type": "boolean",
"description": "Whether this was an incoming message (true) or outgoing (false)"
},
"message": {
"type": "string",
"description": "Text message content"
},
"personId": {
"type": "integer",
"description": "Person ID"
},
"toNumber": {
"type": "string",
"description": "Recipient phone number"
}
},
"required": [
"PCID",
"fromNumber",
"message",
"personId",
"toNumber"
]
}
follow_up_boss_create_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event | string | Yes | — | Event type to subscribe to (e.g., peopleCreated, peopleUpdated, peopleStageUpdated, callsCreated, tasksCreated) |
system | string | Yes | — | System identifier for this webhook (must match the system value used when listing webhooks) |
url | string | Yes | — | Webhook URL to receive notifications |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event": {
"type": "string",
"description": "Event type to subscribe to (e.g., peopleCreated, peopleUpdated, peopleStageUpdated, callsCreated, tasksCreated)"
},
"system": {
"type": "string",
"description": "System identifier for this webhook (must match the system value used when listing webhooks)"
},
"url": {
"type": "string",
"description": "Webhook URL to receive notifications"
}
},
"required": [
"PCID",
"event",
"system",
"url"
]
}
follow_up_boss_delete_appointment
Delete an appointment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Appointment ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Appointment ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_delete_deal
Delete a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Deal ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Deal ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_delete_person
Delete a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Person ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Person ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_delete_task
Delete a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Task ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Task ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Webhook ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Webhook ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_appointment
Get an appointment by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Appointment ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Appointment ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_call
Get a call record by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Call record ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Call record ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_deal
Get a deal by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Deal ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Deal ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_event
Get an event by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Event ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Event ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_identity
Get current account and user identityShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
follow_up_boss_get_me
Get current user profileShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
follow_up_boss_get_note
Get a note by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Note ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Note ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_person
Get a person by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Person ID |
fields | string | No | — | Comma-separated list of fields to return |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Person ID"
},
"fields": {
"type": "string",
"description": "Comma-separated list of fields to return"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_pipeline
Get a pipeline by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Pipeline ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Pipeline ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_task
Get a task by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Task ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Task ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_text_message
Get a text message by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Text message ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Text message ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_user
Get a user by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_get_webhook
Get a webhook by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Webhook ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Webhook ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_list_action_plans
List action plans Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_appointments
List appointments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
personId | integer | No | — | Filter by person ID |
userId | integer | No | — | Filter by user ID |
sort | string | No | — | Sort field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
},
"personId": {
"type": "integer",
"description": "Filter by person ID"
},
"userId": {
"type": "integer",
"description": "Filter by user ID"
},
"sort": {
"type": "string",
"description": "Sort field"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_calls
List call records Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
personId | integer | No | — | Filter by person ID |
userId | integer | No | — | Filter by user ID |
incoming | boolean | No | — | Filter by direction (true for incoming, false for outgoing) |
sort | string | No | — | Sort field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
},
"personId": {
"type": "integer",
"description": "Filter by person ID"
},
"userId": {
"type": "integer",
"description": "Filter by user ID"
},
"incoming": {
"type": "boolean",
"description": "Filter by direction (true for incoming, false for outgoing)"
},
"sort": {
"type": "string",
"description": "Sort field"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_custom_fields
List custom fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_deal_custom_fields
List deal custom fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_deals
List deals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
next | string | No | — | Cursor for keyset pagination |
sort | string | No | — | Sort field |
pipelineId | integer | No | — | Filter by pipeline ID |
personId | integer | No | — | Filter by associated person ID |
userId | integer | No | — | Filter by assigned user ID |
status | string | No | — | Filter by status |
includeArchived | boolean | No | — | Include archived deals |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
},
"next": {
"type": "string",
"description": "Cursor for keyset pagination"
},
"sort": {
"type": "string",
"description": "Sort field"
},
"pipelineId": {
"type": "integer",
"description": "Filter by pipeline ID"
},
"personId": {
"type": "integer",
"description": "Filter by associated person ID"
},
"userId": {
"type": "integer",
"description": "Filter by assigned user ID"
},
"status": {
"type": "string",
"description": "Filter by status",
"enum": [
"Active",
"Archived",
"Deleted"
]
},
"includeArchived": {
"type": "boolean",
"description": "Include archived deals"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_groups
List user groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_notes
List notes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
personId | integer | No | — | Filter notes by person ID |
sort | string | No | — | Sort field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
},
"personId": {
"type": "integer",
"description": "Filter notes by person ID"
},
"sort": {
"type": "string",
"description": "Sort field"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_people
Search and list people (contacts) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
next | string | No | — | Cursor for keyset pagination (recommended for deep pagination) |
sort | string | No | — | Sort field (e.g., id, created, updated, lastActivity, name) |
fields | string | No | — | Comma-separated list of fields to return. Use ‘allFields’ for all or ‘allCustom’ for all custom fields. |
name | string | No | — | Search by name (fuzzy matching) |
email | string | No | — | Filter by email address |
phone | string | No | — | Filter by phone number |
tag | string | No | — | Filter by tag name |
stage | string | No | — | Filter by pipeline stage |
source | string | No | — | Filter by lead source |
assignedUserId | integer | No | — | Filter by assigned user ID |
lastActivityAfter | string | No | — | Filter by last activity after this date (ISO 8601) |
lastActivityBefore | string | No | — | Filter by last activity before this date (ISO 8601) |
includeTrash | boolean | No | — | Include contacts in trash stage |
includeDeleted | boolean | No | — | Include deleted contacts |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
},
"next": {
"type": "string",
"description": "Cursor for keyset pagination (recommended for deep pagination)"
},
"sort": {
"type": "string",
"description": "Sort field (e.g., id, created, updated, lastActivity, name)"
},
"fields": {
"type": "string",
"description": "Comma-separated list of fields to return. Use 'allFields' for all or 'allCustom' for all custom fields."
},
"name": {
"type": "string",
"description": "Search by name (fuzzy matching)"
},
"email": {
"type": "string",
"description": "Filter by email address"
},
"phone": {
"type": "string",
"description": "Filter by phone number"
},
"tag": {
"type": "string",
"description": "Filter by tag name"
},
"stage": {
"type": "string",
"description": "Filter by pipeline stage"
},
"source": {
"type": "string",
"description": "Filter by lead source"
},
"assignedUserId": {
"type": "integer",
"description": "Filter by assigned user ID"
},
"lastActivityAfter": {
"type": "string",
"description": "Filter by last activity after this date (ISO 8601)"
},
"lastActivityBefore": {
"type": "string",
"description": "Filter by last activity before this date (ISO 8601)"
},
"includeTrash": {
"type": "boolean",
"description": "Include contacts in trash stage"
},
"includeDeleted": {
"type": "boolean",
"description": "Include deleted contacts"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_pipelines
List pipelines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_smart_lists
List smart lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_stages
List pipeline stages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_tasks
List tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
personId | integer | No | — | Filter tasks by person ID |
assignedUserId | integer | No | — | Filter by assigned user ID |
assignedTo | string | No | — | Filter by assigned user name |
type | string | No | — | Filter by task type (e.g., Follow Up, Call, Email, Text, Appointment, Other) |
isCompleted | boolean | No | — | Filter by completion status |
due | string | No | — | Filter by due status: today, overdue, upcoming |
dueStart | string | No | — | Filter tasks due on or after this date (YYYY-MM-DD) |
dueEnd | string | No | — | Filter tasks due on or before this date (YYYY-MM-DD) |
sort | string | No | — | Sort field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
},
"personId": {
"type": "integer",
"description": "Filter tasks by person ID"
},
"assignedUserId": {
"type": "integer",
"description": "Filter by assigned user ID"
},
"assignedTo": {
"type": "string",
"description": "Filter by assigned user name"
},
"type": {
"type": "string",
"description": "Filter by task type (e.g., Follow Up, Call, Email, Text, Appointment, Other)"
},
"isCompleted": {
"type": "boolean",
"description": "Filter by completion status"
},
"due": {
"type": "string",
"description": "Filter by due status: today, overdue, upcoming",
"enum": [
"today",
"overdue",
"upcoming"
]
},
"dueStart": {
"type": "string",
"description": "Filter tasks due on or after this date (YYYY-MM-DD)"
},
"dueEnd": {
"type": "string",
"description": "Filter tasks due on or before this date (YYYY-MM-DD)"
},
"sort": {
"type": "string",
"description": "Sort field"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_text_messages
List text messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
personId | integer | Yes | — | Filter by person ID (required — unfiltered calls return HTTP 400) |
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
sort | string | No | — | Sort field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"personId": {
"type": "integer",
"description": "Filter by person ID (required — unfiltered calls return HTTP 400)"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
},
"sort": {
"type": "string",
"description": "Sort field"
}
},
"required": [
"PCID",
"personId"
]
}
follow_up_boss_list_users
List all users in the account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID"
]
}
follow_up_boss_list_webhooks
List webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
system | string | Yes | — | System identifier to filter webhooks by (required by the API) |
limit | integer | No | — | Number of results to return (max 100) |
offset | integer | No | — | Number of results to skip |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"system": {
"type": "string",
"description": "System identifier to filter webhooks by (required by the API)"
},
"limit": {
"type": "integer",
"description": "Number of results to return (max 100)"
},
"offset": {
"type": "integer",
"description": "Number of results to skip"
}
},
"required": [
"PCID",
"system"
]
}
follow_up_boss_update_appointment
Update an appointment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Appointment ID |
description | string | No | — | Appointment description |
end | string | No | — | End date and time (ISO 8601) |
outcome | string | No | — | Appointment outcome |
start | string | No | — | Start date and time (ISO 8601) |
title | string | No | — | Appointment title |
typeId | integer | No | — | Appointment type ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Appointment ID"
},
"description": {
"type": "string",
"description": "Appointment description"
},
"end": {
"type": "string",
"description": "End date and time (ISO 8601)"
},
"outcome": {
"type": "string",
"description": "Appointment outcome"
},
"start": {
"type": "string",
"description": "Start date and time (ISO 8601)"
},
"title": {
"type": "string",
"description": "Appointment title"
},
"typeId": {
"type": "integer",
"description": "Appointment type ID"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_update_deal
Update a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Deal ID |
description | string | No | — | Deal description |
name | string | No | — | Deal name |
people | object[] | No | — | Person IDs to associate |
pipelineId | integer | No | — | Pipeline ID |
price | integer | No | — | Deal value |
projectedCloseDate | string | No | — | Projected close date (YYYY-MM-DD) |
stageId | integer | No | — | Stage ID |
status | string | No | — | Deal status |
users | object[] | No | — | User IDs to assign |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Deal ID"
},
"description": {
"type": "string",
"description": "Deal description"
},
"name": {
"type": "string",
"description": "Deal name"
},
"people": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"id"
]
},
"description": "Person IDs to associate"
},
"pipelineId": {
"type": "integer",
"description": "Pipeline ID"
},
"price": {
"type": "integer",
"description": "Deal value"
},
"projectedCloseDate": {
"type": "string",
"description": "Projected close date (YYYY-MM-DD)"
},
"stageId": {
"type": "integer",
"description": "Stage ID"
},
"status": {
"type": "string",
"description": "Deal status",
"enum": [
"Active",
"Archived",
"Deleted"
]
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"id"
]
},
"description": "User IDs to assign"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_update_note
Update a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Note ID |
body | string | No | — | Note body content (HTML supported) |
subject | string | No | — | Note subject |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Note ID"
},
"body": {
"type": "string",
"description": "Note body content (HTML supported)"
},
"subject": {
"type": "string",
"description": "Note subject"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_update_person
Update a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Person ID |
addresses | object[] | No | — | Addresses (replaces existing list) |
assignedUserId | integer | No | — | Assigned user ID |
background | string | No | — | Background notes |
collaborators | integer[] | No | — | Collaborator user IDs |
emails | object[] | No | — | Email addresses (replaces existing list) |
firstName | string | No | — | First name |
lastName | string | No | — | Last name |
phones | object[] | No | — | Phone numbers (replaces existing list) |
price | integer | No | — | Deal price / property value |
stage | string | No | — | Pipeline stage |
tags | string[] | No | — | Tags to assign |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Person ID"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"street": {
"type": "string",
"description": "The street value"
},
"city": {
"type": "string",
"description": "The city value"
},
"state": {
"type": "string",
"description": "The state value"
},
"code": {
"type": "string",
"description": "The code value"
},
"country": {
"type": "string",
"description": "The country value"
},
"type": {
"type": "string",
"description": "The type value"
}
}
},
"description": "Addresses (replaces existing list)"
},
"assignedUserId": {
"type": "integer",
"description": "Assigned user ID"
},
"background": {
"type": "string",
"description": "Background notes"
},
"collaborators": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Collaborator user IDs"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value value"
},
"type": {
"type": "string",
"description": "The type value"
},
"isPrimary": {
"type": "boolean",
"description": "Is Primary"
}
},
"required": [
"value"
]
},
"description": "Email addresses (replaces existing list)"
},
"firstName": {
"type": "string",
"description": "First name"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value value"
},
"type": {
"type": "string",
"description": "The type value"
},
"isPrimary": {
"type": "boolean",
"description": "Is Primary"
}
},
"required": [
"value"
]
},
"description": "Phone numbers (replaces existing list)"
},
"price": {
"type": "integer",
"description": "Deal price / property value"
},
"stage": {
"type": "string",
"description": "Pipeline stage"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to assign"
}
},
"required": [
"PCID",
"id"
]
}
follow_up_boss_update_task
Update a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Task ID |
assignedUserId | integer | No | — | Assigned user ID |
dueDate | string | No | — | Due date (YYYY-MM-DD) |
dueDateTime | string | No | — | Due date and time (ISO 8601) |
isCompleted | boolean | No | — | Whether the task is completed |
name | string | No | — | Task name |
type | string | No | — | Task type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Task ID"
},
"assignedUserId": {
"type": "integer",
"description": "Assigned user ID"
},
"dueDate": {
"type": "string",
"description": "Due date (YYYY-MM-DD)"
},
"dueDateTime": {
"type": "string",
"description": "Due date and time (ISO 8601)"
},
"isCompleted": {
"type": "boolean",
"description": "Whether the task is completed"
},
"name": {
"type": "string",
"description": "Task name"
},
"type": {
"type": "string",
"description": "Task type"
}
},
"required": [
"PCID",
"id"
]
}

