> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# suitedash
> SuiteDash CRM
**Server path:** `/suitedash` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------- | ----------------------------------------- |
| [`suitedash_create_company`](#suitedash_create_company) | Create a new Company |
| [`suitedash_create_contact`](#suitedash_create_contact) | Create a new Contact |
| [`suitedash_get_company`](#suitedash_get_company) | Find a Company |
| [`suitedash_get_company_meta`](#suitedash_get_company_meta) | CRM Company : Meta Attributes Information |
| [`suitedash_get_contact`](#suitedash_get_contact) | Find a Contact |
| [`suitedash_get_contact_meta`](#suitedash_get_contact_meta) | CRM Contact : Meta Attributes Information |
| [`suitedash_get_project`](#suitedash_get_project) | Find a Project |
| [`suitedash_get_project_meta`](#suitedash_get_project_meta) | Project : Meta Attributes Information |
| [`suitedash_list_companies`](#suitedash_list_companies) | Get all existing Companies |
| [`suitedash_list_contacts`](#suitedash_list_contacts) | Get all existing Contacts |
| [`suitedash_list_projects`](#suitedash_list_projects) | Get all existing Projects |
| [`suitedash_list_worlds`](#suitedash_list_worlds) | Get all existing Worlds |
| [`suitedash_subscribe_marketing`](#suitedash_subscribe_marketing) | Subscribe contacts to marketing audiences |
| [`suitedash_update_company`](#suitedash_update_company) | Update a Company |
| [`suitedash_update_contact`](#suitedash_update_contact) | Update a Contact |
| [`suitedash_update_project`](#suitedash_update_project) | Update a Project |
***
## suitedash\_create\_company
Create a new Company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ------------------- |
| `name` | string | Yes | — | Company name |
| `primaryContact` | object | No | — | Primary Contact |
| `role` | string | Yes | — | Role of the Company |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Company name"
},
"primaryContact": {
"type": "object",
"description": "Primary Contact",
"properties": {
"first_name": {
"type": "string",
"description": "Required when 'create_primary_contact_if_not_exists' is true"
},
"last_name": {
"type": "string",
"description": "Required when 'create_primary_contact_if_not_exists' is true"
},
"email": {
"type": "string",
"description": "The email value"
},
"send_welcome_email": {
"type": "boolean",
"description": "Send welcome email to the primary contact in case was not already sent"
},
"create_primary_contact_if_not_exists": {
"type": "boolean",
"description": "Create a Primary Contact with all provided data if the email does not exists"
},
"prevent_individual_mode": {
"type": "boolean",
"description": "Prevent this Primary Contact from switching into 'Individual Mode'"
},
"worlds": {
"type": "object",
"description": "Add/Remove Entity to/from the Worlds"
}
}
},
"role": {
"type": "string",
"description": "Role of the Company",
"enum": [
"Lead",
"Client",
"Prospect"
]
}
},
"required": [
"PCID",
"name",
"role"
]
}
```
***
## suitedash\_create\_contact
Create a new Contact
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------- | ------- | -------- | ------- | ------------------------------ | ---------------------------------------------------- |
| `email` | string | null | No | — | Contact email (required except for the role of Lead) |
| `first_name` | string | No | — | Contact first name | |
| `last_name` | string | No | — | Contact last name | |
| `role` | string | No | — | Role of the Contact | |
| `send_welcome_email` | boolean | No | — | Send Portal Access Invitation? | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": [
"string",
"null"
],
"description": "Contact email (required except for the role of Lead)"
},
"first_name": {
"type": "string",
"description": "Contact first name"
},
"last_name": {
"type": "string",
"description": "Contact last name"
},
"role": {
"type": "string",
"description": "Role of the Contact",
"enum": [
"Lead",
"Client",
"Prospect"
]
},
"send_welcome_email": {
"type": "boolean",
"description": "Send Portal Access Invitation?"
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_get\_company
Find a Company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- |
| `identifier` | string | Yes | — | Company UID or Name |
| `meta` | object | No | — | Select if you want to receive information in the "meta" object about all the attributes |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"identifier": {
"type": "string",
"description": "Company UID or Name"
},
"meta": {
"description": "Select if you want to receive information in the \"meta\" object about all the attributes",
"enum": [
"yes"
]
}
},
"required": [
"PCID",
"identifier"
]
}
```
***
## suitedash\_get\_company\_meta
CRM Company : Meta Attributes Information
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_get\_contact
Find a Contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- |
| `identifier` | string | Yes | — | Contact UID or Email |
| `meta` | object | No | — | Select if you want to receive information in the "meta" object about all the attributes |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"identifier": {
"type": "string",
"description": "Contact UID or Email"
},
"meta": {
"description": "Select if you want to receive information in the \"meta\" object about all the attributes",
"enum": [
"yes"
]
}
},
"required": [
"PCID",
"identifier"
]
}
```
***
## suitedash\_get\_contact\_meta
CRM Contact : Meta Attributes Information
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_get\_project
Find a Project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | Yes | — | Specifies the type of filter to apply.\
\
\\uid\\ - the 'identifier' should be the Project UID (example: 2ff558c3-3eb0-48e1-a3bc-4c7f59dfb02f)\
\\name\\ - the 'identifier' should be the exact name of the Project\
\\contains\_the\_following\\ - the 'identifier' should be a string that is contained in a Project name\
\\most\_recent\\ - the 'identifier' accept only 'true' value |
| `identifier` | string | Yes | — | The identifier for the selected type. Required for 'uid', 'name' and 'contains\_the\_following'. Send 'true' for 'most\_recent'. |
| `meta` | object | No | — | Select if you want to receive information in the "meta" object about all the attributes |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "string",
"description": "Specifies the type of filter to apply.
uid - the 'identifier' should be the Project UID (example: 2ff558c3-3eb0-48e1-a3bc-4c7f59dfb02f)
name - the 'identifier' should be the exact name of the Project
contains_the_following - the 'identifier' should be a string that is contained in a Project name
most_recent - the 'identifier' accept only 'true' value",
"enum": [
"uid",
"name",
"contains_the_following",
"most_recent"
]
},
"identifier": {
"type": "string",
"description": "The identifier for the selected type. Required for 'uid', 'name' and 'contains_the_following'. Send 'true' for 'most_recent'."
},
"meta": {
"description": "Select if you want to receive information in the \"meta\" object about all the attributes",
"enum": [
"yes"
]
}
},
"required": [
"PCID",
"type",
"identifier"
]
}
```
***
## suitedash\_get\_project\_meta
Project : Meta Attributes Information
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_list\_companies
Get all existing Companies
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `page` | integer | No | — | Page number |
| `createdMin` | string | No | — | Lower bound (exclusive) for filtering by a company's creation date-time. If \createdMax\ is set, \createdMin\ must be smaller than \createdMax\. Must be an RFC3339 timestamp with mandatory time zone offset, for example: \2024-07-14T09:00:00+00:00\. |
| `createdMax` | string | No | — | Upper bound (exclusive) for filtering by a company's creation date-time. If \createdMin\ is set, \createdMax\ must be greater than \createdMin\. Must be an RFC3339 timestamp with mandatory time zone offset, for example: \2024-10-30T11:55:16-04:00\. |
| `orderBy` | string | No | — | The order of the companies returned in the result. |
| `meta` | object | No | — | Select if you want to receive information in the "meta" object about all the attributes |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"createdMin": {
"type": "string",
"description": "Lower bound (exclusive) for filtering by a company's creation date-time. If createdMax is set, createdMin must be smaller than createdMax. Must be an RFC3339 timestamp with mandatory time zone offset, for example: 2024-07-14T09:00:00+00:00."
},
"createdMax": {
"type": "string",
"description": "Upper bound (exclusive) for filtering by a company's creation date-time. If createdMin is set, createdMax must be greater than createdMin. Must be an RFC3339 timestamp with mandatory time zone offset, for example: 2024-10-30T11:55:16-04:00."
},
"orderBy": {
"type": "string",
"description": "The order of the companies returned in the result.",
"enum": [
"created",
"created.desc",
"name",
"name.desc"
]
},
"meta": {
"description": "Select if you want to receive information in the \"meta\" object about all the attributes",
"enum": [
"yes"
]
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_list\_contacts
Get all existing Contacts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `page` | integer | No | — | Page number |
| `createdMin` | string | No | — | Lower bound (exclusive) for filtering by a contact's creation date-time. If \createdMax\ is set, \createdMin\ must be smaller than \createdMax\. Must be an RFC3339 timestamp with mandatory time zone offset, for example: \2024-07-14T09:00:00+00:00\. |
| `createdMax` | string | No | — | Upper bound (exclusive) for filtering by a contact's creation date-time. If \createdMin\ is set, \createdMax\ must be greater than \createdMin\. Must be an RFC3339 timestamp with mandatory time zone offset, for example: \2024-10-30T11:55:16-04:00\. |
| `orderBy` | string | No | — | The order of the contacts returned in the result. |
| `meta` | object | No | — | Select if you want to receive information in the "meta" object about all the attributes |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"createdMin": {
"type": "string",
"description": "Lower bound (exclusive) for filtering by a contact's creation date-time. If createdMax is set, createdMin must be smaller than createdMax. Must be an RFC3339 timestamp with mandatory time zone offset, for example: 2024-07-14T09:00:00+00:00."
},
"createdMax": {
"type": "string",
"description": "Upper bound (exclusive) for filtering by a contact's creation date-time. If createdMin is set, createdMax must be greater than createdMin. Must be an RFC3339 timestamp with mandatory time zone offset, for example: 2024-10-30T11:55:16-04:00."
},
"orderBy": {
"type": "string",
"description": "The order of the contacts returned in the result.",
"enum": [
"created",
"created.desc",
"name",
"name.desc"
]
},
"meta": {
"description": "Select if you want to receive information in the \"meta\" object about all the attributes",
"enum": [
"yes"
]
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_list\_projects
Get all existing Projects
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `page` | integer | No | — | Page number |
| `createdMin` | string | No | — | Lower bound (exclusive) for filtering by a Project's creation date-time. If \createdMax\ is set, \createdMin\ must be smaller than \createdMax\. Must be an RFC3339 timestamp with mandatory time zone offset, for example: \2024-07-14T09:00:00+00:00\. |
| `createdMax` | string | No | — | Upper bound (exclusive) for filtering by a Project's creation date-time. If \createdMin\ is set, \createdMax\ must be greater than \createdMin\. Must be an RFC3339 timestamp with mandatory time zone offset, for example: \2024-10-30T11:55:16-04:00\. |
| `orderBy` | string | No | — | The order of the Projects returned in the result. |
| `meta` | object | No | — | Select if you want to receive information in the "meta" object about all the attributes |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"createdMin": {
"type": "string",
"description": "Lower bound (exclusive) for filtering by a Project's creation date-time. If createdMax is set, createdMin must be smaller than createdMax. Must be an RFC3339 timestamp with mandatory time zone offset, for example: 2024-07-14T09:00:00+00:00."
},
"createdMax": {
"type": "string",
"description": "Upper bound (exclusive) for filtering by a Project's creation date-time. If createdMin is set, createdMax must be greater than createdMin. Must be an RFC3339 timestamp with mandatory time zone offset, for example: 2024-10-30T11:55:16-04:00."
},
"orderBy": {
"type": "string",
"description": "The order of the Projects returned in the result.",
"enum": [
"name",
"name.desc",
"created",
"created.desc",
"start_date",
"start_date.desc",
"end_date",
"end_date.desc"
]
},
"meta": {
"description": "Select if you want to receive information in the \"meta\" object about all the attributes",
"enum": [
"yes"
]
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_list\_worlds
Get all existing Worlds
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------------------------------------- |
| `page` | integer | No | — | Page number |
| `orderBy` | string | No | — | The order of the Worlds returned in the result. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"orderBy": {
"type": "string",
"description": "The order of the Worlds returned in the result.",
"enum": [
"key",
"key.desc",
"title",
"title.desc",
"created",
"created.desc"
]
}
},
"required": [
"PCID"
]
}
```
***
## suitedash\_subscribe\_marketing
Subscribe contacts to marketing audiences
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ----------------------------------------- |
| `body` | object\[] | Yes | — | Subscribe contacts to marketing audiences |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Contact email (required except for the role of Lead)"
},
"first_name": {
"type": "string",
"description": "Contact first name"
},
"last_name": {
"type": "string",
"description": "Contact last name"
},
"audiences": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The audiences value"
}
},
"required": [
"email",
"audiences"
]
},
"description": "Subscribe contacts to marketing audiences"
}
},
"required": [
"PCID",
"body"
]
}
```
***
## suitedash\_update\_company
Update a Company
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | --------- | -------- | ------- | ------------------------------------ | ------------------------- |
| `identifier` | string | Yes | — | Company UID or Name | |
| `add_to_communities` | any\[] | No | — | Add To Communities | |
| `address` | object | No | — | The address value | |
| `background_info` | string | null | No | — | Contact background info |
| `category` | object | No | — | Company category | |
| `full_address` | string | No | — | Company full address | |
| `home_phone` | string | null | No | — | Company home phone number |
| `name` | string | No | — | Company name | |
| `phone` | string | null | No | — | Company phone number |
| `private_custom_fields` | object | No | — | Private Custom Fields | |
| `public_custom_fields` | object | No | — | Public Custom Fields | |
| `remove_from_communities` | any\[] | No | — | Remove From Communities | |
| `shop_phone` | string | null | No | — | Company shop phone number |
| `tags` | string\[] | No | — | Company tags | |
| `target_custom_fields` | object | No | — | Target Custom Fields | |
| `website` | string | null | No | — | Company website |
| `work_phone` | string | null | No | — | Company work phone number |
| `worlds` | object | No | — | Add/Remove Entity to/from the Worlds | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"identifier": {
"type": "string",
"description": "Company UID or Name"
},
"add_to_communities": {
"type": "array",
"description": "Add To Communities"
},
"address": {
"type": "object",
"description": "The address value",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address first line"
},
"address_line_2": {
"type": "string",
"description": "Street address second line"
},
"city": {
"type": "string",
"description": "City address"
},
"state": {
"type": "string",
"description": "State/Province address"
},
"country": {
"type": "string",
"description": "Country address"
},
"zip": {
"type": "string",
"description": "Zip/Postal Code address"
}
}
},
"background_info": {
"type": [
"string",
"null"
],
"description": "Contact background info"
},
"category": {
"type": "object",
"description": "Company category",
"properties": {
"name": {
"type": "string",
"description": "Category name"
},
"color": {
"type": "string",
"description": "Category hex color"
},
"isDefault": {
"type": "boolean",
"description": "Category hex color"
}
},
"required": [
"name"
]
},
"full_address": {
"type": "string",
"description": "Company full address"
},
"home_phone": {
"type": [
"string",
"null"
],
"description": "Company home phone number"
},
"name": {
"type": "string",
"description": "Company name"
},
"phone": {
"type": [
"string",
"null"
],
"description": "Company phone number"
},
"private_custom_fields": {
"type": "object",
"description": "Private Custom Fields",
"properties": {
"97fbcc81-4ebc-4703-9fd4-e60af8f0ec95": {
"type": "string",
"description": "Content of a text custom field value"
},
"46fd6533-0c79-4a62-b75e-c0b98321d6cb": {
"type": "array",
"description": "Content of a dropdown custom field multiselect value"
},
"36a7dee5-f9a9-4a41-840f-5f2f11fe1cc7": {
"type": "string",
"description": "Content of a date custom field value"
}
}
},
"public_custom_fields": {
"type": "object",
"description": "Public Custom Fields",
"properties": {
"97fbcc81-4ebc-4703-9fd4-e60af8f0ec95": {
"type": "string",
"description": "Content of a text custom field value"
},
"46fd6533-0c79-4a62-b75e-c0b98321d6cb": {
"type": "array",
"description": "Content of a dropdown custom field multiselect value"
},
"36a7dee5-f9a9-4a41-840f-5f2f11fe1cc7": {
"type": "string",
"description": "Content of a date custom field value"
}
}
},
"remove_from_communities": {
"type": "array",
"description": "Remove From Communities"
},
"shop_phone": {
"type": [
"string",
"null"
],
"description": "Company shop phone number"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Company tags"
},
"target_custom_fields": {
"type": "object",
"description": "Target Custom Fields",
"properties": {
"97fbcc81-4ebc-4703-9fd4-e60af8f0ec95": {
"type": "string",
"description": "Content of a text custom field value"
},
"46fd6533-0c79-4a62-b75e-c0b98321d6cb": {
"type": "array",
"description": "Content of a dropdown custom field multiselect value"
},
"36a7dee5-f9a9-4a41-840f-5f2f11fe1cc7": {
"type": "string",
"description": "Content of a date custom field value"
}
}
},
"website": {
"type": [
"string",
"null"
],
"description": "Company website"
},
"work_phone": {
"type": [
"string",
"null"
],
"description": "Company work phone number"
},
"worlds": {
"type": "object",
"description": "Add/Remove Entity to/from the Worlds",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "Assign Entity to the Worlds (World UID or Key is accepted)"
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "Remove(Unassign) Entity from the Worlds (World UID or Key is accepted)"
}
}
}
},
"required": [
"PCID",
"identifier"
]
}
```
***
## suitedash\_update\_contact
Update a Contact
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------ | ---------------------------------------------------- |
| `identifier` | string | Yes | — | Contact UID or Email | |
| `add_to_communities` | any\[] | No | — | Add To Communities | |
| `address` | object | No | — | The address value | |
| `background_info` | string | null | No | — | Contact background info |
| `circles` | object | No | — | Contact circles management | |
| `company` | object | No | — | Contact CRM company | |
| `custom_fields` | object | No | — | Custom Fields | |
| `email` | string | null | No | — | Contact email (required except for the role of Lead) |
| `first_name` | string | No | — | Contact first name | |
| `full_address` | string | No | — | Contact full address | |
| `home_email` | string | null | No | — | Contact home email |
| `home_phone` | string | null | No | — | Contact home phone number |
| `last_name` | string | No | — | Contact last name | |
| `name_prefix` | string | No | — | Contact name prefix | |
| `notes` | object\[] | No | — | Contact notes to be added | |
| `phone` | string | null | No | — | Contact phone number |
| `remove_from_communities` | any\[] | No | — | Remove From Communities | |
| `send_welcome_email` | boolean | No | — | Send the welcome email if the email has not been sent before | |
| `shop_phone` | string | null | No | — | Contact shop phone number |
| `tags` | string\[] | No | — | Contact tags | |
| `target_custom_fields` | object | No | — | Target Custom Fields | |
| `title` | string | null | No | — | Contact title |
| `website` | string | null | No | — | Contact website |
| `work_email` | string | null | No | — | Contact work email |
| `work_phone` | string | null | No | — | Contact work phone number |
| `worlds` | object | No | — | Add/Remove Entity to/from the Worlds | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"identifier": {
"type": "string",
"description": "Contact UID or Email"
},
"add_to_communities": {
"type": "array",
"description": "Add To Communities"
},
"address": {
"type": "object",
"description": "The address value",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address first line"
},
"address_line_2": {
"type": "string",
"description": "Street address second line"
},
"city": {
"type": "string",
"description": "City address"
},
"state": {
"type": "string",
"description": "State/Province address"
},
"country": {
"type": "string",
"description": "Country address"
},
"zip": {
"type": "string",
"description": "Zip/Postal Code address"
}
}
},
"background_info": {
"type": [
"string",
"null"
],
"description": "Contact background info"
},
"circles": {
"type": "object",
"description": "Contact circles management",
"properties": {
"add": {
"type": "array",
"description": "List of circle names to add to the contact"
},
"remove": {
"type": "array",
"description": "List of circle names to remove from the contact"
}
}
},
"company": {
"type": "object",
"description": "Contact CRM company",
"properties": {
"name": {
"type": "string",
"description": "Name of the CRM company"
},
"create_company_if_not_exists": {
"type": "boolean",
"description": "Create a new CRM company if the one from the 'name' field not matching"
}
}
},
"custom_fields": {
"type": "object",
"description": "Custom Fields",
"properties": {
"97fbcc81-4ebc-4703-9fd4-e60af8f0ec95": {
"type": "string",
"description": "Content of a text custom field value"
},
"46fd6533-0c79-4a62-b75e-c0b98321d6cb": {
"type": "array",
"description": "Content of a dropdown custom field multiselect value"
},
"36a7dee5-f9a9-4a41-840f-5f2f11fe1cc7": {
"type": "string",
"description": "Content of a date custom field value"
}
}
},
"email": {
"type": [
"string",
"null"
],
"description": "Contact email (required except for the role of Lead)"
},
"first_name": {
"type": "string",
"description": "Contact first name"
},
"full_address": {
"type": "string",
"description": "Contact full address"
},
"home_email": {
"type": [
"string",
"null"
],
"description": "Contact home email"
},
"home_phone": {
"type": [
"string",
"null"
],
"description": "Contact home phone number"
},
"last_name": {
"type": "string",
"description": "Contact last name"
},
"name_prefix": {
"type": "string",
"description": "Contact name prefix",
"enum": [
"Mr.",
"Ms.",
"Mrs.",
"Miss",
"Mx.",
"Dr.",
"Prof.",
"Rev."
]
},
"notes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Note title"
},
"note": {
"type": "string",
"description": "Note text (description)"
},
"date": {
"type": "string",
"format": "yyyy-mm-dd",
"description": "Note date"
}
}
},
"description": "Contact notes to be added"
},
"phone": {
"type": [
"string",
"null"
],
"description": "Contact phone number"
},
"remove_from_communities": {
"type": "array",
"description": "Remove From Communities"
},
"send_welcome_email": {
"type": "boolean",
"description": "Send the welcome email if the email has not been sent before"
},
"shop_phone": {
"type": [
"string",
"null"
],
"description": "Contact shop phone number"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contact tags"
},
"target_custom_fields": {
"type": "object",
"description": "Target Custom Fields",
"properties": {
"97fbcc81-4ebc-4703-9fd4-e60af8f0ec95": {
"type": "string",
"description": "Content of a text custom field value"
},
"46fd6533-0c79-4a62-b75e-c0b98321d6cb": {
"type": "array",
"description": "Content of a dropdown custom field multiselect value"
},
"36a7dee5-f9a9-4a41-840f-5f2f11fe1cc7": {
"type": "string",
"description": "Content of a date custom field value"
}
}
},
"title": {
"type": [
"string",
"null"
],
"description": "Contact title"
},
"website": {
"type": [
"string",
"null"
],
"description": "Contact website"
},
"work_email": {
"type": [
"string",
"null"
],
"description": "Contact work email"
},
"work_phone": {
"type": [
"string",
"null"
],
"description": "Contact work phone number"
},
"worlds": {
"type": "object",
"description": "Add/Remove Entity to/from the Worlds",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "Assign Entity to the Worlds (World UID or Key is accepted)"
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "Remove(Unassign) Entity from the Worlds (World UID or Key is accepted)"
}
}
}
},
"required": [
"PCID",
"identifier"
]
}
```
***
## suitedash\_update\_project
Update a Project
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | Yes | — | Specifies the type of filter to apply.\
\
\\uid\\ - the 'identifier' should be the Project UID (example: 2ff558c3-3eb0-48e1-a3bc-4c7f59dfb02f)\
\\name\\ - the 'identifier' should be the exact name of the Project\
\\contains\_the\_following\\ - the 'identifier' should be a string that is contained in a Project name\
\\most\_recent\\ - the 'identifier' accept only 'true' value | |
| `identifier` | string | Yes | — | The identifier for the selected type. Required for 'uid', 'name' and 'contains\_the\_following'. Send 'true' for 'most\_recent'. | |
| `business_sector` | string | null | No | — | Project Economics - Business Sector Name (only the name of the sector added in Settings > Business Sectors is allowed) |
| `due_time` | string | null | No | — | Project Target Time on the Estimated Completion Date (minutes can only be 00 or 30) |
| `end_date` | string | null | No | — | Project estimated Completion Date |
| `estimated_value` | number | null | No | — | Project Economics - Estimated Value of Project (integer or decimal is allowed) |
| `estimated_value_currency` | string | null | No | — | Project Economics - Currency Name of the Estimated Value of Project (only the name of the currency added in the Currencies page is allowed) |
| `info_description` | string | null | No | — | Project Information (Visible only to Staff) |
| `info_description_client` | string | null | No | — | Project Information Description (Visible only to Client) |
| `info_title_client` | string | null | No | — | Project Information Title (Visible only to Client) |
| `name` | string | Yes | — | Project Name | |
| `project_custom_fields` | object | No | — | Project Custom Fields | |
| `require_time_spend` | boolean | No | — | Project Economics - Set Estimated Time/Time Spent as required | |
| `start_date` | string | null | No | — | Project Start Date |
| `status` | string | Yes | — | Project Status (values are those from Categories > Project Statuses) | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "string",
"description": "Specifies the type of filter to apply.
uid - the 'identifier' should be the Project UID (example: 2ff558c3-3eb0-48e1-a3bc-4c7f59dfb02f)
name - the 'identifier' should be the exact name of the Project
contains_the_following - the 'identifier' should be a string that is contained in a Project name
most_recent - the 'identifier' accept only 'true' value",
"enum": [
"uid",
"name",
"contains_the_following",
"most_recent"
]
},
"identifier": {
"type": "string",
"description": "The identifier for the selected type. Required for 'uid', 'name' and 'contains_the_following'. Send 'true' for 'most_recent'."
},
"business_sector": {
"type": [
"string",
"null"
],
"description": "Project Economics - Business Sector Name (only the name of the sector added in Settings > Business Sectors is allowed)"
},
"due_time": {
"type": [
"string",
"null"
],
"description": "Project Target Time on the Estimated Completion Date (minutes can only be 00 or 30)"
},
"end_date": {
"type": [
"string",
"null"
],
"description": "Project estimated Completion Date"
},
"estimated_value": {
"type": [
"number",
"null"
],
"description": "Project Economics - Estimated Value of Project (integer or decimal is allowed)"
},
"estimated_value_currency": {
"type": [
"string",
"null"
],
"description": "Project Economics - Currency Name of the Estimated Value of Project (only the name of the currency added in the Currencies page is allowed)"
},
"info_description": {
"type": [
"string",
"null"
],
"description": "Project Information (Visible only to Staff)"
},
"info_description_client": {
"type": [
"string",
"null"
],
"description": "Project Information Description (Visible only to Client)"
},
"info_title_client": {
"type": [
"string",
"null"
],
"description": "Project Information Title (Visible only to Client)"
},
"name": {
"type": "string",
"description": "Project Name"
},
"project_custom_fields": {
"type": "object",
"description": "Project Custom Fields",
"properties": {
"97fbcc81-4ebc-4703-9fd4-e60af8f0ec95": {
"type": "string",
"description": "Content of a text custom field value"
},
"46fd6533-0c79-4a62-b75e-c0b98321d6cb": {
"type": "array",
"description": "Content of a dropdown custom field multiselect value"
},
"36a7dee5-f9a9-4a41-840f-5f2f11fe1cc7": {
"type": "string",
"description": "Content of a date custom field value"
}
}
},
"require_time_spend": {
"type": "boolean",
"description": "Project Economics - Set Estimated Time/Time Spent as required"
},
"start_date": {
"type": [
"string",
"null"
],
"description": "Project Start Date"
},
"status": {
"type": "string",
"description": "Project Status (values are those from Categories > Project Statuses)"
}
},
"required": [
"PCID",
"type",
"identifier",
"name",
"status"
]
}
```