cats-contacts

CATS Contacts - manage contacts, emails, phones, and custom fields

Server path: /cats-contacts | Type: Application | PCID required: Yes

Tools

Tool	Description
cats_contacts_attach_contact_tags	Attach contact tags
cats_contacts_change_a_contact_thumbnail	Change a contact thumbnail
cats_contacts_change_contact_status	Change contact status
cats_contacts_create_a_contact	Create a contact
cats_contacts_create_a_contact_activity	Create a contact activity
cats_contacts_create_a_contact_email	Create a contact email
cats_contacts_create_a_contact_list	Create a contact list
cats_contacts_create_a_contact_phone	Create a contact phone
cats_contacts_create_contact_list_items	Create contact list items
cats_contacts_delete_a_contact	Delete a contact
cats_contacts_delete_a_contact_email	Delete a contact email
cats_contacts_delete_a_contact_list	Delete a contact list
cats_contacts_delete_a_contact_list_item	Delete a contact list item
cats_contacts_delete_a_contact_phone	Delete a contact phone
cats_contacts_delete_contact_tag	Delete contact tag
cats_contacts_filter_contacts	Filter contacts
cats_contacts_get_a_contact	Get a contact
cats_contacts_get_a_contact_custom_field	Get a contact custom field
cats_contacts_get_a_contact_custom_field_value	Get a contact custom field value
cats_contacts_get_a_contact_email	Get a contact email
cats_contacts_get_a_contact_list	Get a contact list
cats_contacts_get_a_contact_list_item	Get a contact list item
cats_contacts_get_a_contact_phone	Get a contact phone
cats_contacts_get_a_contact_thumbnail	Get a contact thumbnail
cats_contacts_get_contact_status	Get contact status
cats_contacts_lis_contact_phones	Lis contact phones
cats_contacts_list_all_contact_list_items	List all contact list items
cats_contacts_list_all_contact_lists	List all contact lists
cats_contacts_list_all_contact_tags	List all contact tags
cats_contacts_list_all_contacts	List all contacts
cats_contacts_list_contact_activities	List contact activities
cats_contacts_list_contact_attachments	List contact attachments
cats_contacts_list_contact_custom_field_values	List contact custom field values
cats_contacts_list_contact_custom_fields	List contact custom fields
cats_contacts_list_contact_emails	List contact emails
cats_contacts_list_contact_statuses	List contact statuses
cats_contacts_list_contact_tasks	List contact tasks
cats_contacts_replace_contact_tags	Replace contact tags
cats_contacts_search_contacts	Search contacts
cats_contacts_update_a_contact	Update a contact
cats_contacts_update_a_contact_custom_field	Update a contact custom field
cats_contacts_update_a_contact_email	Update a contact email
cats_contacts_update_a_contact_phone	Update a contact phone
cats_contacts_upload_a_contact_attachment	Upload a contact attachment

---

cats_contacts_attach_contact_tags

Attach contact tags

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The ID of the contact to attach tags to.
tags	any[]	No	—	The tags value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact to attach tags to."
    },
    "tags": {
      "type": "array",
      "description": "The tags value"
    }
  },
  "required": [
    "PCID",
    "contact_id"
  ]
}

---

cats_contacts_change_a_contact_thumbnail

Change a contact thumbnail

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to change the thumbnail of.
attachment_id	number	No	—	Only required if source is set to attachment (must be an attachment belonging to the data item)
source	string	No	—	One of attachment, gravatar, or disabled.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to change the thumbnail of."
    },
    "attachment_id": {
      "type": "number",
      "description": "Only required if source is set to `attachment` (must be an attachment belonging to the data item)"
    },
    "source": {
      "type": "string",
      "description": "One of `attachment`, `gravatar`, or `disabled`."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_change_contact_status

Change contact status

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact that the status is being attached to.
create_activity	boolean	Yes	—	Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false.
status_id	number	Yes	—	The ID of the status to attach.
triggers	any[]	No	—	An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger. If the triggers parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire. If the triggers parameter is specified, all triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire. Example: [ { "id": <trigger ID>, "fire": <boolean> } ]

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact that the status is being attached to."
    },
    "create_activity": {
      "type": "boolean",
      "description": "Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false."
    },
    "status_id": {
      "type": "number",
      "description": "The ID of the status to attach."
    },
    "triggers": {
      "type": "array",
      "description": "An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger.  If the `triggers` parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire.  If the `triggers` parameter is specified, *all* triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire.  Example:  ``` [     {       \"id\": <trigger ID>,       \"fire\": <boolean>     } ] ```"
    }
  },
  "required": [
    "PCID",
    "id",
    "create_activity",
    "status_id"
  ]
}

---

cats_contacts_create_a_contact

Create a contact

Parameters:

Parameter	Type	Required	Default	Description
check_duplicate	boolean	Yes	—	When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record. Defaults to false.
address	object	No	—	An object containing the address for the contact with the following structure: { "street": "<street>", "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }
company_id	number	Yes	—	The ID of the company this contact belongs to.
country_code	string	No	—	Country Code
custom_fields	any[]	No	—	An array of custom field objects. Each custom field object should contain two keys: id and value. id is the id of a custom field definition, and value is the value to be set to that custom field for this contact. [ { "id": <custom field definition id>, "value": "<custom field value>" } ]
emails	any[]	No	—	An array of email objects. Each email object should contain two keys: email and is_primary, as described here [ { "email": <email>, "is_primary": "<is this the primary email?>" } ]
first_name	string	Yes	—	First Name
has_left_company	boolean	No	—	Has Left Company
is_hot	boolean	No	—	Is Hot
last_name	string	Yes	—	Last Name
notes	string	No	—	The notes value
owner_id	number	Yes	—	The ID of the user that owns this contact record.
phones	any[]	No	—	An array of phone objects. Each phone object should contain three keys: number, extension, and type, as described here [ { "number": <phone number with country code>, "extension": "<optional extension>", "type": "<phone number type>", } ]
reports_to_id	number	No	—	The ID of the contact that this contact reports to.
social_media_urls	any[]	No	—	Social Media Urls
title	string	No	—	The contact’s job title.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "check_duplicate": {
      "type": "boolean",
      "description": "When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record. Defaults to false."
    },
    "address": {
      "type": "object",
      "description": "An object containing the address for the contact with the following structure:  ``` {   \"street\": \"<street>\",   \"city\": \"<city>\",   \"state\": \"<state>\",   \"postal_code\": \"<postal code>\" } ```",
      "properties": {
        "street": {
          "type": "string",
          "description": "The street value"
        },
        "city": {
          "type": "string",
          "description": "The city value"
        },
        "state": {
          "type": "string",
          "description": "The state value"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal Code"
        }
      }
    },
    "company_id": {
      "type": "number",
      "description": "The ID of the company this contact belongs to."
    },
    "country_code": {
      "type": "string",
      "description": "Country Code"
    },
    "custom_fields": {
      "type": "array",
      "description": "An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this contact.  ``` [     {         \"id\": <custom field definition id>,         \"value\": \"<custom field value>\"     } ] ```"
    },
    "emails": {
      "type": "array",
      "description": "An array of email objects. Each email object should contain two keys: `email` and `is_primary`, as described [here](#contacts-create-an-email)  ``` [     {         \"email\": <email>,         \"is_primary\": \"<is this the primary email?>\"     } ] ```"
    },
    "first_name": {
      "type": "string",
      "description": "First Name"
    },
    "has_left_company": {
      "type": "boolean",
      "description": "Has Left Company"
    },
    "is_hot": {
      "type": "boolean",
      "description": "Is Hot"
    },
    "last_name": {
      "type": "string",
      "description": "Last Name"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "owner_id": {
      "type": "number",
      "description": "The ID of the user that owns this contact record."
    },
    "phones": {
      "type": "array",
      "description": "An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described [here](#contacts-create-a-phone)  ``` [     {         \"number\": <phone number with country code>,         \"extension\": \"<optional extension>\",         \"type\": \"<phone number type>\",     } ] ```"
    },
    "reports_to_id": {
      "type": "number",
      "description": "The ID of the contact that this contact reports to."
    },
    "social_media_urls": {
      "type": "array",
      "description": "Social Media Urls"
    },
    "title": {
      "type": "string",
      "description": "The contact's job title."
    }
  },
  "required": [
    "PCID",
    "check_duplicate",
    "company_id",
    "first_name",
    "last_name",
    "owner_id"
  ]
}

---

cats_contacts_create_a_contact_activity

Create a contact activity

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to create an activity for.
date	string	No	—	The datetime the activity took place. If not specified it defaults to the current date and time.
notes	string	No	—	The notes value
regarding_id	number	No	—	The ID of the job order that this activity is regarding. Leave null for a general activity.
type	string	Yes	—	One of the following activity types: email, meeting, call_talked, call_lvm, call_missed, text_message or other.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to create an activity for."
    },
    "date": {
      "type": "string",
      "description": "The datetime the activity took place. If not specified it defaults to the current date and time."
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "regarding_id": {
      "type": "number",
      "description": "The ID of the job order that this activity is regarding. Leave `null` for a general activity."
    },
    "type": {
      "type": "string",
      "description": "One of the following activity types: `email`, `meeting`, `call_talked`, `call_lvm`, `call_missed`, `text_message` or `other`."
    }
  },
  "required": [
    "PCID",
    "id",
    "type"
  ]
}

---

cats_contacts_create_a_contact_email

Create a contact email

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to create the email for.
email	string	Yes	—	The email value
is_primary	boolean	No	—	If a record has any number of emails, exactly one of them must be marked as primary.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to create the email for."
    },
    "email": {
      "type": "string",
      "description": "The email value"
    },
    "is_primary": {
      "type": "boolean",
      "description": "If a record has any number of emails, exactly one of them must be marked as primary."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "email"
  ]
}

---

cats_contacts_create_a_contact_list

Create a contact list

Parameters:

Parameter	Type	Required	Default	Description
name	string	Yes	—	The name value
notes	string	No	—	The notes value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

---

cats_contacts_create_a_contact_phone

Create a contact phone

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to create the phone for.
extension	string	No	—	The extension value
number	string	Yes	—	This number MUST begin with the country code. It will not be parsed correctly otherwise.
type	string	Yes	—	One of mobile, home, work, fax, main, or other.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to create the phone for."
    },
    "extension": {
      "type": "string",
      "description": "The extension value"
    },
    "number": {
      "type": "string",
      "description": "This number MUST begin with the country code. It will not be parsed correctly otherwise."
    },
    "type": {
      "type": "string",
      "description": "One of `mobile`, `home`, `work`, `fax`, `main`, or `other`."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "number",
    "type"
  ]
}

---

cats_contacts_create_contact_list_items

Create contact list items

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact list.
items	any[]	No	—	The items value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact list."
    },
    "items": {
      "type": "array",
      "description": "The items value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_delete_a_contact

Delete a contact

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_delete_a_contact_email

Delete a contact email

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to delete the email from.
id	number	Yes	—	The ID of the email to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to delete the email from."
    },
    "id": {
      "type": "number",
      "description": "The ID of the email to delete."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "id"
  ]
}

---

cats_contacts_delete_a_contact_list

Delete a contact list

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact list to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact list to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_delete_a_contact_list_item

Delete a contact list item

Parameters:

Parameter	Type	Required	Default	Description
list_id	number	Yes	—	The ID of the contact list.
item_id	number	Yes	—	The ID of the list item to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "list_id": {
      "type": "number",
      "description": "The ID of the contact list."
    },
    "item_id": {
      "type": "number",
      "description": "The ID of the list item to delete."
    }
  },
  "required": [
    "PCID",
    "list_id",
    "item_id"
  ]
}

---

cats_contacts_delete_a_contact_phone

Delete a contact phone

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to delete the phone from.
id	number	Yes	—	The ID of the phone to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to delete the phone from."
    },
    "id": {
      "type": "number",
      "description": "The ID of the phone to delete."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "id"
  ]
}

---

cats_contacts_delete_contact_tag

Delete contact tag

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The ID of the contact to detach the tag from.
tag_id	number	Yes	—	The ID of the tag to detach.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact to detach the tag from."
    },
    "tag_id": {
      "type": "number",
      "description": "The ID of the tag to detach."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "tag_id"
  ]
}

---

cats_contacts_filter_contacts

Filter contacts

Parameters:

Parameter	Type	Required	Default	Description
query	string	Yes	—	The optional string to search within contacts for.
page	number	Yes	—	The current page number of contacts to return.
per_page	number	Yes	—	The number of contacts to return per page.
field	string	Yes	—	The field to filter on. See the above list to determine which fields can be filtered.
filter	string	Yes	—	The filter to use. See the above list to determine which fields allow what filters.
value	string	Yes	—	The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "query": {
      "type": "string",
      "description": "The optional string to search within contacts for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of contacts to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of contacts to return per page."
    },
    "field": {
      "type": "string",
      "description": "The field to filter on. See the above list to determine which fields can be filtered."
    },
    "filter": {
      "type": "string",
      "description": "The filter to use. See the above list to determine which fields allow what filters."
    },
    "value": {
      "type": "string",
      "description": "The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts."
    }
  },
  "required": [
    "PCID",
    "query",
    "page",
    "per_page",
    "field",
    "filter",
    "value"
  ]
}

---

cats_contacts_get_a_contact

Get a contact

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_get_a_contact_custom_field

Get a contact custom field

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the custom field definition to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the custom field definition to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_get_a_contact_custom_field_value

Get a contact custom field value

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The ID of the contact that the custom field belongs to.
custom_field_id	number	Yes	—	The ID of the custom field to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact that the custom field belongs to."
    },
    "custom_field_id": {
      "type": "number",
      "description": "The ID of the custom field to return."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "custom_field_id"
  ]
}

---

cats_contacts_get_a_contact_email

Get a contact email

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to return the email for.
id	number	Yes	—	The ID of the email to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to return the email for."
    },
    "id": {
      "type": "number",
      "description": "The ID of the email to return."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "id"
  ]
}

---

cats_contacts_get_a_contact_list

Get a contact list

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact list to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact list to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_get_a_contact_list_item

Get a contact list item

Parameters:

Parameter	Type	Required	Default	Description
list_id	number	Yes	—	The ID of the contact list the item belongs to.
item_id	number	Yes	—	The ID of the contact list item to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "list_id": {
      "type": "number",
      "description": "The ID of the contact list the item belongs to."
    },
    "item_id": {
      "type": "number",
      "description": "The ID of the contact list item to return."
    }
  },
  "required": [
    "PCID",
    "list_id",
    "item_id"
  ]
}

---

cats_contacts_get_a_contact_phone

Get a contact phone

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to return the phone for.
id	number	Yes	—	The ID of the phone to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to return the phone for."
    },
    "id": {
      "type": "number",
      "description": "The ID of the phone to return."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "id"
  ]
}

---

cats_contacts_get_a_contact_thumbnail

Get a contact thumbnail

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to get the thumbnail of.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to get the thumbnail of."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_get_contact_status

Get contact status

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the status to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the status to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_lis_contact_phones

Lis contact phones

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to return phones for.
page	number	Yes	—	The current page number of phones to return.
per_page	number	Yes	—	The number of phones to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to return phones for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of phones to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of phones to return per page."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_all_contact_list_items

List all contact list items

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact list to return items for.
page	number	Yes	—	The current page number of list items to return.
per_page	number	Yes	—	The number of list items to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact list to return items for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of list items to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of list items to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_all_contact_lists

List all contact lists

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of lists to return.
per_page	number	Yes	—	The number of lists to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of lists to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of lists to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_all_contact_tags

List all contact tags

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The ID of the contact to return tags for.
page	number	Yes	—	The current page number of tags to return.
per_page	number	Yes	—	The number of tags to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact to return tags for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of tags to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of tags to return per page."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_all_contacts

List all contacts

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of contacts to return.
per_page	number	Yes	—	The number of contacts to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of contacts to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of contacts to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_contact_activities

List contact activities

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to return activities for.
page	number	Yes	—	The current page number of activities to return.
per_page	number	Yes	—	The number of activities to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to return activities for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of activities to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of activities to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_contact_attachments

List contact attachments

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to return attachments for.
page	number	Yes	—	The current page number of attachments to return.
per_page	number	Yes	—	The number of attachments to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to return attachments for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of attachments to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of attachments to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_contact_custom_field_values

List contact custom field values

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to return custom fields for.
page	number	Yes	—	The current page number of custom fields to return.
per_page	number	Yes	—	The number of custom fields to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to return custom fields for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of custom fields to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of custom fields to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_contact_custom_fields

List contact custom fields

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of custom field definitions to return.
per_page	number	Yes	—	The number of custom field definitions to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of custom field definitions to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of custom field definitions to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_contact_emails

List contact emails

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to return emails for.
page	number	Yes	—	The current page number of emails to return.
per_page	number	Yes	—	The number of emails to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to return emails for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of emails to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of emails to return per page."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_contact_statuses

List contact statuses

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of statuses to return.
per_page	number	Yes	—	The number of statuses to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of statuses to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of statuses to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_contacts_list_contact_tasks

List contact tasks

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to fetch tasks concerning.
page	number	Yes	—	The current page number of tasks to return.
per_page	number	Yes	—	The number of task items to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to fetch tasks concerning."
    },
    "page": {
      "type": "number",
      "description": "The current page number of tasks to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of task items to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_contacts_replace_contact_tags

Replace contact tags

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The ID of the contact to replace tags on.
tags	any[]	No	—	The tags value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact to replace tags on."
    },
    "tags": {
      "type": "array",
      "description": "The tags value"
    }
  },
  "required": [
    "PCID",
    "contact_id"
  ]
}

---

cats_contacts_search_contacts

Search contacts

Parameters:

Parameter	Type	Required	Default	Description
query	string	Yes	—	The string to search within contacts for.
page	number	Yes	—	The current page number of contacts to return.
per_page	number	Yes	—	The number of contacts to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "query": {
      "type": "string",
      "description": "The string to search within contacts for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of contacts to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of contacts to return per page."
    }
  },
  "required": [
    "PCID",
    "query",
    "page",
    "per_page"
  ]
}

---

cats_contacts_update_a_contact

Update a contact

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact to update.
address	object	No	—	An object containing the address for the contact with the following structure: { "street": "<street>", "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }
company_id	number	No	—	The ID of the company this contact belongs to.
country_code	string	No	—	Country Code
custom_fields	any[]	No	—	An array of custom field objects. Each custom field object should contain two keys: id and value. id is the id of a custom field definition, and value is the value to be set to that custom field for this contact. [ { "id": <custom field definition id>, "value": "<custom field value>" } ]
emails	any[]	No	—	An array of email objects. Each email object should contain two keys: email and is_primary, as described here [ { "email": <email>, "is_primary": "<is this the primary email?>" } ]
first_name	string	No	—	First Name
has_left_company	boolean	No	—	Has Left Company
is_hot	boolean	No	—	Is Hot
last_name	string	No	—	Last Name
notes	string	No	—	The notes value
owner_id	number	No	—	The ID of the user that owns this contact record.
phones	any[]	No	—	An array of phone objects. Each phone object should contain three keys: number, extension, and type, as described here [ { "number": <phone number with country code>, "extension": "<optional extension>", "type": "<phone number type>", } ]
reports_to_id	number	No	—	The ID of the contact that this contact reports to.
social_media_urls	any[]	No	—	Social Media Urls
title	string	No	—	The contact’s job title.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact to update."
    },
    "address": {
      "type": "object",
      "description": "An object containing the address for the contact with the following structure:  ``` {   \"street\": \"<street>\",   \"city\": \"<city>\",   \"state\": \"<state>\",   \"postal_code\": \"<postal code>\" } ```",
      "properties": {
        "street": {
          "type": "string",
          "description": "The street value"
        },
        "city": {
          "type": "string",
          "description": "The city value"
        },
        "state": {
          "type": "string",
          "description": "The state value"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal Code"
        }
      }
    },
    "company_id": {
      "type": "number",
      "description": "The ID of the company this contact belongs to."
    },
    "country_code": {
      "type": "string",
      "description": "Country Code"
    },
    "custom_fields": {
      "type": "array",
      "description": "An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this contact.  ``` [     {         \"id\": <custom field definition id>,         \"value\": \"<custom field value>\"     } ] ```"
    },
    "emails": {
      "type": "array",
      "description": "An array of email objects. Each email object should contain two keys: `email` and `is_primary`, as described [here](#contacts-create-an-email)  ``` [     {         \"email\": <email>,         \"is_primary\": \"<is this the primary email?>\"     } ] ```"
    },
    "first_name": {
      "type": "string",
      "description": "First Name"
    },
    "has_left_company": {
      "type": "boolean",
      "description": "Has Left Company"
    },
    "is_hot": {
      "type": "boolean",
      "description": "Is Hot"
    },
    "last_name": {
      "type": "string",
      "description": "Last Name"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "owner_id": {
      "type": "number",
      "description": "The ID of the user that owns this contact record."
    },
    "phones": {
      "type": "array",
      "description": "An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described [here](#contacts-create-a-phone)  ``` [     {         \"number\": <phone number with country code>,         \"extension\": \"<optional extension>\",         \"type\": \"<phone number type>\",     } ] ```"
    },
    "reports_to_id": {
      "type": "number",
      "description": "The ID of the contact that this contact reports to."
    },
    "social_media_urls": {
      "type": "array",
      "description": "Social Media Urls"
    },
    "title": {
      "type": "string",
      "description": "The contact's job title."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_contacts_update_a_contact_custom_field

Update a contact custom field

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The ID of the contact that the custom field belongs to.
custom_field_id	number	Yes	—	The ID of the custom field to update.
value	string	No	—	The value value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact that the custom field belongs to."
    },
    "custom_field_id": {
      "type": "number",
      "description": "The ID of the custom field to update."
    },
    "value": {
      "type": "string",
      "description": "The value value"
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "custom_field_id"
  ]
}

---

cats_contacts_update_a_contact_email

Update a contact email

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to update the email for.
id	number	Yes	—	The ID of the email to update.
email	string	No	—	The email value
is_primary	boolean	No	—	If a record has any number of emails, exactly one of them must be marked as primary.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to update the email for."
    },
    "id": {
      "type": "number",
      "description": "The ID of the email to update."
    },
    "email": {
      "type": "string",
      "description": "The email value"
    },
    "is_primary": {
      "type": "boolean",
      "description": "If a record has any number of emails, exactly one of them must be marked as primary."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "id"
  ]
}

---

cats_contacts_update_a_contact_phone

Update a contact phone

Parameters:

Parameter	Type	Required	Default	Description
contact_id	number	Yes	—	The contact to update the phone for.
id	number	Yes	—	The ID of the phone to update.
extension	string	No	—	The extension value
number	string	No	—	This number MUST begin with the country code. It will not be parsed correctly otherwise.
type	string	No	—	One of mobile, home, work, fax, main, or other.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contact_id": {
      "type": "number",
      "description": "The contact to update the phone for."
    },
    "id": {
      "type": "number",
      "description": "The ID of the phone to update."
    },
    "extension": {
      "type": "string",
      "description": "The extension value"
    },
    "number": {
      "type": "string",
      "description": "This number MUST begin with the country code. It will not be parsed correctly otherwise."
    },
    "type": {
      "type": "string",
      "description": "One of `mobile`, `home`, `work`, `fax`, `main`, or `other`."
    }
  },
  "required": [
    "PCID",
    "contact_id",
    "id"
  ]
}

---

cats_contacts_upload_a_contact_attachment

Upload a contact attachment

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the contact that the attachment is being attached to.
filename	string	Yes	—	The name to save the file being uploaded as.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the contact that the attachment is being attached to."
    },
    "filename": {
      "type": "string",
      "description": "The name to save the file being uploaded as."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename"
  ]
}