> ## 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.
# moco-crm
> Moco CRM & Contacts
**Server path:** `/moco-crm` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| [`moco_crm_create_comments`](#moco_crm_create_comments) | Create comment |
| [`moco_crm_create_comments_bulk`](#moco_crm_create_comments_bulk) | Create comments in bulk |
| [`moco_crm_create_companies`](#moco_crm_create_companies) | Create company |
| [`moco_crm_create_contacts_people`](#moco_crm_create_contacts_people) | Create contact |
| [`moco_crm_create_deal_categories`](#moco_crm_create_deal_categories) | Create deal category |
| [`moco_crm_create_deals`](#moco_crm_create_deals) | Create deal |
| [`moco_crm_create_offers`](#moco_crm_create_offers) | Create offer |
| [`moco_crm_create_offers_attachments`](#moco_crm_create_offers_attachments) | Create offer attachment |
| [`moco_crm_create_offers_customer_approval_activate`](#moco_crm_create_offers_customer_approval_activate) | Activate customer approval |
| [`moco_crm_create_offers_customer_approval_deactivate`](#moco_crm_create_offers_customer_approval_deactivate) | Deactivate customer approval |
| [`moco_crm_create_offers_send_email`](#moco_crm_create_offers_send_email) | Send offer by email |
| [`moco_crm_delete_comments`](#moco_crm_delete_comments) | Delete comment |
| [`moco_crm_delete_companies`](#moco_crm_delete_companies) | Delete company |
| [`moco_crm_delete_contacts_people`](#moco_crm_delete_contacts_people) | Delete contact |
| [`moco_crm_delete_deal_categories`](#moco_crm_delete_deal_categories) | Delete deal category |
| [`moco_crm_delete_deals`](#moco_crm_delete_deals) | Delete deal |
| [`moco_crm_delete_offers_attachments`](#moco_crm_delete_offers_attachments) | Delete offer attachment |
| [`moco_crm_get_comments`](#moco_crm_get_comments) | Get comment |
| [`moco_crm_get_companies`](#moco_crm_get_companies) | Get company |
| [`moco_crm_get_contacts_people`](#moco_crm_get_contacts_people) | Get contact |
| [`moco_crm_get_deal_categories`](#moco_crm_get_deal_categories) | Get deal category |
| [`moco_crm_get_deals`](#moco_crm_get_deals) | Get deal |
| [`moco_crm_get_offers`](#moco_crm_get_offers) | Get offer |
| [`moco_crm_get_offers_attachments`](#moco_crm_get_offers_attachments) | List offer attachments |
| [`moco_crm_get_offers_customer_approval`](#moco_crm_get_offers_customer_approval) | Get customer approval state |
| [`moco_crm_get_offers_pdf`](#moco_crm_get_offers_pdf) | Download offer PDF |
| [`moco_crm_list_comments`](#moco_crm_list_comments) | List comments |
| [`moco_crm_list_companies`](#moco_crm_list_companies) | List companies |
| [`moco_crm_list_contacts_people`](#moco_crm_list_contacts_people) | List contacts |
| [`moco_crm_list_deal_categories`](#moco_crm_list_deal_categories) | List deal categories |
| [`moco_crm_list_deals`](#moco_crm_list_deals) | List deals |
| [`moco_crm_list_offers`](#moco_crm_list_offers) | List offers |
| [`moco_crm_update_comments`](#moco_crm_update_comments) | Update comment |
| [`moco_crm_update_comments_1`](#moco_crm_update_comments_1) | Update comment |
| [`moco_crm_update_companies`](#moco_crm_update_companies) | Update company |
| [`moco_crm_update_companies_1`](#moco_crm_update_companies_1) | Update company |
| [`moco_crm_update_companies_archive`](#moco_crm_update_companies_archive) | Archive company |
| [`moco_crm_update_companies_unarchive`](#moco_crm_update_companies_unarchive) | Unarchive company |
| [`moco_crm_update_contacts_people`](#moco_crm_update_contacts_people) | Update contact |
| [`moco_crm_update_contacts_people_1`](#moco_crm_update_contacts_people_1) | Update contact |
| [`moco_crm_update_deal_categories`](#moco_crm_update_deal_categories) | Update deal category |
| [`moco_crm_update_deal_categories_1`](#moco_crm_update_deal_categories_1) | Update deal category |
| [`moco_crm_update_deals`](#moco_crm_update_deals) | Update deal |
| [`moco_crm_update_deals_1`](#moco_crm_update_deals_1) | Update deal |
| [`moco_crm_update_offers_assign`](#moco_crm_update_offers_assign) | Assign offer to company/project/deal |
| [`moco_crm_update_status_offers`](#moco_crm_update_status_offers) | Update offer status |
***
## moco\_crm\_create\_comments
Create comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `attachment_content` | string | No | — | Attachment Content |
| `attachment_filename` | string | No | — | Attachment Filename |
| `commentable_id` | integer | Yes | — | Commentable Id |
| `commentable_type` | string | Yes | — | Public target type (for example `Project`, `Invoice`, `Purchase`). |
| `created_at` | string | No | — | Created At |
| `text` | string | Yes | — | The text value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"attachment_content": {
"type": "string",
"description": "Attachment Content"
},
"attachment_filename": {
"type": "string",
"description": "Attachment Filename"
},
"commentable_id": {
"type": "integer",
"description": "Commentable Id"
},
"commentable_type": {
"type": "string",
"description": "Public target type (for example `Project`, `Invoice`, `Purchase`).",
"enum": [
"Company",
"Contact",
"Deal",
"DeliveryNote",
"Expense",
"Invoice",
"InvoiceBookkeepingExport",
"InvoiceDeletion",
"InvoiceReminder",
"Offer",
"OfferConfirmation",
"Project",
"ProjectGroup",
"Purchase",
"PurchaseBookkeepingExport",
"PurchaseDraft",
"Receipt",
"ReceiptRefundRequest",
"RecurringExpense",
"Unit",
"User",
"UserHolidayRequest"
]
},
"created_at": {
"type": "string",
"description": "Created At"
},
"text": {
"type": "string",
"description": "The text value"
}
},
"required": [
"PCID",
"commentable_id",
"commentable_type",
"text"
]
}
```
***
## moco\_crm\_create\_comments\_bulk
Create comments in bulk
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ---------- | -------- | ------- | ---------------- |
| `commentable_ids` | integer\[] | Yes | — | Commentable Ids |
| `commentable_type` | string | Yes | — | Commentable Type |
| `created_at` | string | No | — | Created At |
| `text` | string | Yes | — | The text value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"commentable_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Commentable Ids"
},
"commentable_type": {
"type": "string",
"description": "Commentable Type",
"enum": [
"Company",
"Contact",
"Deal",
"DeliveryNote",
"Expense",
"Invoice",
"InvoiceBookkeepingExport",
"InvoiceDeletion",
"InvoiceReminder",
"Offer",
"OfferConfirmation",
"Project",
"ProjectGroup",
"Purchase",
"PurchaseBookkeepingExport",
"PurchaseDraft",
"Receipt",
"ReceiptRefundRequest",
"RecurringExpense",
"Unit",
"User",
"UserHolidayRequest"
]
},
"created_at": {
"type": "string",
"description": "Created At"
},
"text": {
"type": "string",
"description": "The text value"
}
},
"required": [
"PCID",
"commentable_ids",
"commentable_type",
"text"
]
}
```
***
## moco\_crm\_create\_companies
Create company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------------- | --------- | -------- | ------- | --------------------------------------------- |
| `address` | string | No | — | The address value |
| `alternative_correspondence_language` | string | No | — | Alternative Correspondence Language |
| `bank_bic` | string | No | — | Bank Bic |
| `bank_owner` | string | No | — | Bank Owner |
| `billing_email_cc` | string | No | — | Billing Email Cc |
| `billing_notes` | string | No | — | Billing Notes |
| `country_code` | string | No | — | Country Code |
| `credit_number` | string | No | — | Credit Number |
| `currency` | string | No | — | The currency value |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_tax` | number | No | — | Deprecated VAT shortcut for customer records. |
| `customer_vat_code_id` | integer | No | — | Customer Vat Code Id |
| `debit_number` | string | No | — | Debit Number |
| `default_invoice_due_days` | integer | No | — | Default Invoice Due Days |
| `default_payment_means` | string | No | — | Default Payment Means |
| `email` | string | No | — | The email value |
| `fax` | string | No | — | The fax value |
| `footer` | string | No | — | The footer value |
| `iban` | string | No | — | The iban value |
| `identifier` | string | No | — | The identifier value |
| `info` | string | No | — | The info value |
| `invoice_due_days` | integer | No | — | Invoice Due Days |
| `invoice_format` | string | No | — | Invoice Format |
| `labels` | string\[] | No | — | The labels value |
| `name` | string | Yes | — | The name value |
| `phone` | string | No | — | The phone value |
| `supplier_tax` | number | No | — | Deprecated VAT shortcut for supplier records. |
| `supplier_vat_code_id` | integer | No | — | Supplier Vat Code Id |
| `tags` | string\[] | No | — | The tags value |
| `type` | string | No | — | The type value |
| `user_id` | integer | No | — | User Id |
| `vat_identifier` | string | No | — | Vat Identifier |
| `website` | string | No | — | The website value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "string",
"description": "The address value"
},
"alternative_correspondence_language": {
"type": "string",
"description": "Alternative Correspondence Language"
},
"bank_bic": {
"type": "string",
"description": "Bank Bic"
},
"bank_owner": {
"type": "string",
"description": "Bank Owner"
},
"billing_email_cc": {
"type": "string",
"description": "Billing Email Cc"
},
"billing_notes": {
"type": "string",
"description": "Billing Notes"
},
"country_code": {
"type": "string",
"description": "Country Code"
},
"credit_number": {
"type": "string",
"description": "Credit Number"
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_tax": {
"type": "number",
"description": "Deprecated VAT shortcut for customer records."
},
"customer_vat_code_id": {
"type": "integer",
"description": "Customer Vat Code Id"
},
"debit_number": {
"type": "string",
"description": "Debit Number"
},
"default_invoice_due_days": {
"type": "integer",
"description": "Default Invoice Due Days"
},
"default_payment_means": {
"type": "string",
"description": "Default Payment Means",
"enum": [
"not_defined",
"credit_transfer"
]
},
"email": {
"type": "string",
"description": "The email value"
},
"fax": {
"type": "string",
"description": "The fax value"
},
"footer": {
"type": "string",
"description": "The footer value"
},
"iban": {
"type": "string",
"description": "The iban value"
},
"identifier": {
"type": "string",
"description": "The identifier value"
},
"info": {
"type": "string",
"description": "The info value"
},
"invoice_due_days": {
"type": "integer",
"description": "Invoice Due Days"
},
"invoice_format": {
"type": "string",
"description": "Invoice Format",
"enum": [
"regular_pdf",
"x_invoice",
"zugferd_x_invoice"
]
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "The labels value"
},
"name": {
"type": "string",
"description": "The name value"
},
"phone": {
"type": "string",
"description": "The phone value"
},
"supplier_tax": {
"type": "number",
"description": "Deprecated VAT shortcut for supplier records."
},
"supplier_vat_code_id": {
"type": "integer",
"description": "Supplier Vat Code Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"customer",
"supplier",
"organization"
]
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"vat_identifier": {
"type": "string",
"description": "Vat Identifier"
},
"website": {
"type": "string",
"description": "The website value"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## moco\_crm\_create\_contacts\_people
Create contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | -------------------- |
| `bday` | string | No | — | The bday value |
| `birthday` | string | No | — | The birthday value |
| `company_id` | integer | No | — | Company Id |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_id` | integer | No | — | Customer Id |
| `firstname` | string | No | — | The firstname value |
| `gender` | string | No | — | The gender value |
| `home_address` | string | No | — | Home Address |
| `home_email` | string | No | — | Home Email |
| `info` | string | No | — | The info value |
| `job_position` | string | No | — | Job Position |
| `lastname` | string | No | — | The lastname value |
| `mobile_phone` | string | No | — | Mobile Phone |
| `name` | string | No | — | The name value |
| `organization_id` | integer | No | — | Organization Id |
| `salutation` | string | No | — | The salutation value |
| `tags` | string\[] | No | — | The tags value |
| `title` | string | No | — | The title value |
| `user_id` | integer | No | — | User Id |
| `work_address` | string | No | — | Work Address |
| `work_email` | string | No | — | Work Email |
| `work_fax` | string | No | — | Work Fax |
| `work_phone` | string | No | — | Work Phone |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"bday": {
"type": "string",
"description": "The bday value"
},
"birthday": {
"type": "string",
"description": "The birthday value"
},
"company_id": {
"type": "integer",
"description": "Company Id"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"firstname": {
"type": "string",
"description": "The firstname value"
},
"gender": {
"type": "string",
"description": "The gender value"
},
"home_address": {
"type": "string",
"description": "Home Address"
},
"home_email": {
"type": "string",
"description": "Home Email"
},
"info": {
"type": "string",
"description": "The info value"
},
"job_position": {
"type": "string",
"description": "Job Position"
},
"lastname": {
"type": "string",
"description": "The lastname value"
},
"mobile_phone": {
"type": "string",
"description": "Mobile Phone"
},
"name": {
"type": "string",
"description": "The name value"
},
"organization_id": {
"type": "integer",
"description": "Organization Id"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"title": {
"type": "string",
"description": "The title value"
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"work_address": {
"type": "string",
"description": "Work Address"
},
"work_email": {
"type": "string",
"description": "Work Email"
},
"work_fax": {
"type": "string",
"description": "Work Fax"
},
"work_phone": {
"type": "string",
"description": "Work Phone"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_crm\_create\_deal\_categories
Create deal category
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------- |
| `name` | string | Yes | — | The name value |
| `probability` | integer | Yes | — | Probability in percent (0-100). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name value"
},
"probability": {
"type": "integer",
"description": "Probability in percent (0-100)."
}
},
"required": [
"PCID",
"name",
"probability"
]
}
```
***
## moco\_crm\_create\_deals
Create deal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------- |
| `closed_on` | string | No | — | Closed On |
| `company_id` | integer | No | — | Company/customer ID. |
| `currency` | string | No | — | The currency value |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_id` | integer | No | — | Deprecated alias for `company_id`. |
| `deal_category_id` | integer | No | — | Deal category ID. |
| `info` | string | No | — | The info value |
| `money` | number | No | — | Deal value in selected currency. |
| `name` | string | Yes | — | The name value |
| `person_id` | integer | No | — | Linked contact person ID. |
| `reminder_date` | string | No | — | Reminder Date |
| `service_period_from` | string | No | — | Service Period From |
| `service_period_to` | string | No | — | Service Period To |
| `status` | string | Yes | — | The status value |
| `tags` | string\[] | No | — | The tags value |
| `user_id` | integer | No | — | Responsible user ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"closed_on": {
"type": "string",
"description": "Closed On"
},
"company_id": {
"type": "integer",
"description": "Company/customer ID."
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_id": {
"type": "integer",
"description": "Deprecated alias for `company_id`."
},
"deal_category_id": {
"type": "integer",
"description": "Deal category ID."
},
"info": {
"type": "string",
"description": "The info value"
},
"money": {
"type": "number",
"description": "Deal value in selected currency."
},
"name": {
"type": "string",
"description": "The name value"
},
"person_id": {
"type": "integer",
"description": "Linked contact person ID."
},
"reminder_date": {
"type": "string",
"description": "Reminder Date"
},
"service_period_from": {
"type": "string",
"description": "Service Period From"
},
"service_period_to": {
"type": "string",
"description": "Service Period To"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"potential",
"pending",
"won",
"lost",
"dropped"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"user_id": {
"type": "integer",
"description": "Responsible user ID."
}
},
"required": [
"PCID",
"name",
"status"
]
}
```
***
## moco\_crm\_create\_offers
Create offer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ------------------------------------------------------ |
| `change_address` | string | No | — | Change Address |
| `company_id` | integer | No | — | Company Id |
| `contact_id` | integer | No | — | Contact Id |
| `currency` | string | No | — | The currency value |
| `custom_properties` | object | No | — | Custom Properties |
| `date` | string | No | — | The date value |
| `deal_id` | integer | No | — | Deal Id |
| `discount` | number | No | — | The discount value |
| `due_date` | string | No | — | Due Date |
| `footer` | string | No | — | The footer value |
| `identifier` | string | No | — | The identifier value |
| `internal_contact_id` | integer | No | — | Internal Contact Id |
| `items` | any\[] | Yes | — | The items value |
| `print_detail_columns` | boolean | No | — | Print Detail Columns |
| `project_id` | integer | No | — | Project Id |
| `recipient_address` | string | No | — | Recipient Address |
| `salutation` | string | No | — | The salutation value |
| `table_header_visible` | boolean | No | — | Table Header Visible |
| `tags` | string\[] | No | — | The tags value |
| `tax` | number | Yes | — | Must match an active sale VAT code tax in the account. |
| `title` | string | No | — | The title value |
| `totals_section_visible` | boolean | No | — | Totals Section Visible |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"change_address": {
"type": "string",
"description": "Change Address",
"enum": [
"offer",
"customer"
]
},
"company_id": {
"type": "integer",
"description": "Company Id"
},
"contact_id": {
"type": "integer",
"description": "Contact Id"
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"date": {
"type": "string",
"description": "The date value"
},
"deal_id": {
"type": "integer",
"description": "Deal Id"
},
"discount": {
"type": "number",
"description": "The discount value"
},
"due_date": {
"type": "string",
"description": "Due Date"
},
"footer": {
"type": "string",
"description": "The footer value"
},
"identifier": {
"type": "string",
"description": "The identifier value"
},
"internal_contact_id": {
"type": "integer",
"description": "Internal Contact Id"
},
"items": {
"type": "array",
"description": "The items value"
},
"print_detail_columns": {
"type": "boolean",
"description": "Print Detail Columns"
},
"project_id": {
"type": "integer",
"description": "Project Id"
},
"recipient_address": {
"type": "string",
"description": "Recipient Address"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"table_header_visible": {
"type": "boolean",
"description": "Table Header Visible"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"tax": {
"type": "number",
"description": "Must match an active sale VAT code tax in the account."
},
"title": {
"type": "string",
"description": "The title value"
},
"totals_section_visible": {
"type": "boolean",
"description": "Totals Section Visible"
}
},
"required": [
"PCID",
"items",
"tax"
]
}
```
***
## moco\_crm\_create\_offers\_attachments
Create offer attachment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `offer_id` | integer | Yes | — | Offer Id |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `attachment` | object | Yes | — | The attachment value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offer_id": {
"type": "integer",
"description": "Offer Id"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"attachment": {
"type": "object",
"description": "The attachment value",
"properties": {
"filename": {
"type": "string",
"description": "File name including extension."
},
"base64": {
"type": "string",
"description": "Base64-encoded file content."
}
},
"required": [
"filename",
"base64"
]
}
},
"required": [
"PCID",
"offer_id",
"attachment"
]
}
```
***
## moco\_crm\_create\_offers\_customer\_approval\_activate
Activate customer approval
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `offer_id` | integer | Yes | — | Offer Id |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offer_id": {
"type": "integer",
"description": "Offer Id"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"offer_id"
]
}
```
***
## moco\_crm\_create\_offers\_customer\_approval\_deactivate
Deactivate customer approval
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `offer_id` | integer | Yes | — | Offer Id |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offer_id": {
"type": "integer",
"description": "Offer Id"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"offer_id"
]
}
```
***
## moco\_crm\_create\_offers\_send\_email
Send offer by email
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `emails_bcc` | string | No | — | Semicolon-separated email list. |
| `emails_cc` | string | No | — | Semicolon-separated email list. |
| `emails_to` | string | No | — | Semicolon-separated email list. |
| `letter_paper_id` | integer | No | — | Letter Paper Id |
| `subject` | string | Yes | — | The subject value |
| `text` | string | Yes | — | The text value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"emails_bcc": {
"type": "string",
"description": "Semicolon-separated email list."
},
"emails_cc": {
"type": "string",
"description": "Semicolon-separated email list."
},
"emails_to": {
"type": "string",
"description": "Semicolon-separated email list."
},
"letter_paper_id": {
"type": "integer",
"description": "Letter Paper Id"
},
"subject": {
"type": "string",
"description": "The subject value"
},
"text": {
"type": "string",
"description": "The text value"
}
},
"required": [
"PCID",
"id",
"subject",
"text"
]
}
```
***
## moco\_crm\_delete\_comments
Delete comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_delete\_companies
Delete company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_delete\_contacts\_people
Delete contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_delete\_deal\_categories
Delete deal category
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_delete\_deals
Delete deal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_delete\_offers\_attachments
Delete offer attachment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `offer_id` | integer | Yes | — | Offer Id |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offer_id": {
"type": "integer",
"description": "Offer Id"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"offer_id",
"id"
]
}
```
***
## moco\_crm\_get\_comments
Get comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_get\_companies
Get company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_get\_contacts\_people
Get contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_get\_deal\_categories
Get deal category
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_get\_deals
Get deal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_get\_offers
Get offer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_get\_offers\_attachments
List offer attachments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `offer_id` | integer | Yes | — | Offer Id |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offer_id": {
"type": "integer",
"description": "Offer Id"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"offer_id"
]
}
```
***
## moco\_crm\_get\_offers\_customer\_approval
Get customer approval state
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `offer_id` | integer | Yes | — | Offer Id |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"offer_id": {
"type": "integer",
"description": "Offer Id"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"offer_id"
]
}
```
***
## moco\_crm\_get\_offers\_pdf
Download offer PDF
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `letter_paper_id` | integer | No | — | Letter paper ID. Defaults to account default when omitted. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"letter_paper_id": {
"type": "integer",
"description": "Letter paper ID. Defaults to account default when omitted."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_list\_comments
List comments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `commentable_type` | string | No | — | Comment target type (for example `Project`, `Invoice`, `Purchase`). |
| `commentable_id` | integer | No | — | Commentable Id |
| `user_id` | integer | No | — | User Id |
| `manual` | boolean | No | — | The manual value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"commentable_type": {
"type": "string",
"description": "Comment target type (for example `Project`, `Invoice`, `Purchase`).",
"enum": [
"Company",
"Contact",
"Deal",
"DeliveryNote",
"Expense",
"Invoice",
"InvoiceBookkeepingExport",
"InvoiceDeletion",
"InvoiceReminder",
"Offer",
"OfferConfirmation",
"Project",
"ProjectGroup",
"Purchase",
"PurchaseBookkeepingExport",
"PurchaseDraft",
"Receipt",
"ReceiptRefundRequest",
"RecurringExpense",
"Unit",
"User",
"UserHolidayRequest"
]
},
"commentable_id": {
"type": "integer",
"description": "Commentable Id"
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"manual": {
"type": "boolean",
"description": "The manual value"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_crm\_list\_companies
List companies
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `include_archived` | boolean | No | — | Include Archived |
| `type` | string | No | — | The type value |
| `tags` | string | No | — | Comma-separated list of tag names. |
| `identifier` | string | No | — | The identifier value |
| `term` | string | No | — | The term value |
| `custom_properties` | object | No | — | Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"include_archived": {
"type": "boolean",
"description": "Include Archived"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"customer",
"supplier",
"organization"
]
},
"tags": {
"type": "string",
"description": "Comma-separated list of tag names."
},
"identifier": {
"type": "string",
"description": "The identifier value"
},
"term": {
"type": "string",
"description": "The term value"
},
"custom_properties": {
"type": "object",
"description": "Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_crm\_list\_contacts\_people
List contacts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `tags` | string | No | — | Comma-separated list of tag names. |
| `term` | string | No | — | Full text search on name, email and company. |
| `phone` | string | No | — | Reverse lookup on work/mobile phone. |
| `custom_properties` | object | No | — | Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"tags": {
"type": "string",
"description": "Comma-separated list of tag names."
},
"term": {
"type": "string",
"description": "Full text search on name, email and company."
},
"phone": {
"type": "string",
"description": "Reverse lookup on work/mobile phone."
},
"custom_properties": {
"type": "object",
"description": "Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_crm\_list\_deal\_categories
List deal categories
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_crm\_list\_deals
List deals
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `custom_properties` | object | No | — | Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`. |
| `status` | string | No | — | The status value |
| `tags` | string | No | — | Comma-separated list of deal tag names. |
| `closed_from` | string | No | — | Closed date range start. Format: YYYY-MM-DD (e.g. `2026-01-01`). |
| `closed_to` | string | No | — | Closed date range end. Format: YYYY-MM-DD (e.g. `2026-01-31`). |
| `company_id` | integer | No | — | Company Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"custom_properties": {
"type": "object",
"description": "Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`."
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"potential",
"pending",
"won",
"lost",
"dropped"
]
},
"tags": {
"type": "string",
"description": "Comma-separated list of deal tag names."
},
"closed_from": {
"type": "string",
"description": "Closed date range start. Format: YYYY-MM-DD (e.g. `2026-01-01`)."
},
"closed_to": {
"type": "string",
"description": "Closed date range end. Format: YYYY-MM-DD (e.g. `2026-01-31`)."
},
"company_id": {
"type": "integer",
"description": "Company Id"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_crm\_list\_offers
List offers
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `sort_by` | string | No | — | Field and optional direction, e.g. `title desc`. |
| `status` | string | No | — | The status value |
| `from` | string | No | — | Offer date range start. Format: YYYY-MM-DD (e.g. `2026-01-01`). |
| `to` | string | No | — | Offer date range end. Format: YYYY-MM-DD (e.g. `2026-01-31`). |
| `identifier` | string | No | — | The identifier value |
| `deal_id` | string | No | — | Single ID or comma-separated list. |
| `project_id` | string | No | — | Single ID or comma-separated list. |
| `company_id` | string | No | — | Single ID or comma-separated list. |
| `tags` | string | No | — | Comma-separated list of tag names. |
| `custom_properties` | object | No | — | Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"sort_by": {
"type": "string",
"description": "Field and optional direction, e.g. `title desc`."
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"created",
"sent",
"accepted",
"partially_billed",
"billed",
"archived"
]
},
"from": {
"type": "string",
"description": "Offer date range start. Format: YYYY-MM-DD (e.g. `2026-01-01`)."
},
"to": {
"type": "string",
"description": "Offer date range end. Format: YYYY-MM-DD (e.g. `2026-01-31`)."
},
"identifier": {
"type": "string",
"description": "The identifier value"
},
"deal_id": {
"type": "string",
"description": "Single ID or comma-separated list."
},
"project_id": {
"type": "string",
"description": "Single ID or comma-separated list."
},
"company_id": {
"type": "string",
"description": "Single ID or comma-separated list."
},
"tags": {
"type": "string",
"description": "Comma-separated list of tag names."
},
"custom_properties": {
"type": "object",
"description": "Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_crm\_update\_comments
Update comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `attachment_content` | string | No | — | Attachment Content |
| `attachment_filename` | string | No | — | Attachment Filename |
| `commentable_id` | integer | No | — | Commentable Id |
| `commentable_type` | string | No | — | Public target type (for example `Project`, `Invoice`, `Purchase`). |
| `created_at` | string | No | — | Created At |
| `text` | string | No | — | The text value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"attachment_content": {
"type": "string",
"description": "Attachment Content"
},
"attachment_filename": {
"type": "string",
"description": "Attachment Filename"
},
"commentable_id": {
"type": "integer",
"description": "Commentable Id"
},
"commentable_type": {
"type": "string",
"description": "Public target type (for example `Project`, `Invoice`, `Purchase`).",
"enum": [
"Company",
"Contact",
"Deal",
"DeliveryNote",
"Expense",
"Invoice",
"InvoiceBookkeepingExport",
"InvoiceDeletion",
"InvoiceReminder",
"Offer",
"OfferConfirmation",
"Project",
"ProjectGroup",
"Purchase",
"PurchaseBookkeepingExport",
"PurchaseDraft",
"Receipt",
"ReceiptRefundRequest",
"RecurringExpense",
"Unit",
"User",
"UserHolidayRequest"
]
},
"created_at": {
"type": "string",
"description": "Created At"
},
"text": {
"type": "string",
"description": "The text value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_comments\_1
Update comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `attachment_content` | string | No | — | Attachment Content |
| `attachment_filename` | string | No | — | Attachment Filename |
| `commentable_id` | integer | No | — | Commentable Id |
| `commentable_type` | string | No | — | Public target type (for example `Project`, `Invoice`, `Purchase`). |
| `created_at` | string | No | — | Created At |
| `text` | string | No | — | The text value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"attachment_content": {
"type": "string",
"description": "Attachment Content"
},
"attachment_filename": {
"type": "string",
"description": "Attachment Filename"
},
"commentable_id": {
"type": "integer",
"description": "Commentable Id"
},
"commentable_type": {
"type": "string",
"description": "Public target type (for example `Project`, `Invoice`, `Purchase`).",
"enum": [
"Company",
"Contact",
"Deal",
"DeliveryNote",
"Expense",
"Invoice",
"InvoiceBookkeepingExport",
"InvoiceDeletion",
"InvoiceReminder",
"Offer",
"OfferConfirmation",
"Project",
"ProjectGroup",
"Purchase",
"PurchaseBookkeepingExport",
"PurchaseDraft",
"Receipt",
"ReceiptRefundRequest",
"RecurringExpense",
"Unit",
"User",
"UserHolidayRequest"
]
},
"created_at": {
"type": "string",
"description": "Created At"
},
"text": {
"type": "string",
"description": "The text value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_companies
Update company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `address` | string | No | — | The address value |
| `alternative_correspondence_language` | string | No | — | Alternative Correspondence Language |
| `bank_bic` | string | No | — | Bank Bic |
| `bank_owner` | string | No | — | Bank Owner |
| `billing_email_cc` | string | No | — | Billing Email Cc |
| `billing_notes` | string | No | — | Billing Notes |
| `country_code` | string | No | — | Country Code |
| `credit_number` | string | No | — | Credit Number |
| `currency` | string | No | — | The currency value |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_tax` | number | No | — | Deprecated VAT shortcut for customer records. |
| `customer_vat_code_id` | integer | No | — | Customer Vat Code Id |
| `debit_number` | string | No | — | Debit Number |
| `default_invoice_due_days` | integer | No | — | Default Invoice Due Days |
| `default_payment_means` | string | No | — | Default Payment Means |
| `email` | string | No | — | The email value |
| `fax` | string | No | — | The fax value |
| `footer` | string | No | — | The footer value |
| `iban` | string | No | — | The iban value |
| `identifier` | string | No | — | The identifier value |
| `info` | string | No | — | The info value |
| `invoice_due_days` | integer | No | — | Invoice Due Days |
| `invoice_format` | string | No | — | Invoice Format |
| `labels` | string\[] | No | — | The labels value |
| `name` | string | No | — | The name value |
| `phone` | string | No | — | The phone value |
| `supplier_tax` | number | No | — | Deprecated VAT shortcut for supplier records. |
| `supplier_vat_code_id` | integer | No | — | Supplier Vat Code Id |
| `tags` | string\[] | No | — | The tags value |
| `type` | string | No | — | The type value |
| `user_id` | integer | No | — | User Id |
| `vat_identifier` | string | No | — | Vat Identifier |
| `website` | string | No | — | The website value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"address": {
"type": "string",
"description": "The address value"
},
"alternative_correspondence_language": {
"type": "string",
"description": "Alternative Correspondence Language"
},
"bank_bic": {
"type": "string",
"description": "Bank Bic"
},
"bank_owner": {
"type": "string",
"description": "Bank Owner"
},
"billing_email_cc": {
"type": "string",
"description": "Billing Email Cc"
},
"billing_notes": {
"type": "string",
"description": "Billing Notes"
},
"country_code": {
"type": "string",
"description": "Country Code"
},
"credit_number": {
"type": "string",
"description": "Credit Number"
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_tax": {
"type": "number",
"description": "Deprecated VAT shortcut for customer records."
},
"customer_vat_code_id": {
"type": "integer",
"description": "Customer Vat Code Id"
},
"debit_number": {
"type": "string",
"description": "Debit Number"
},
"default_invoice_due_days": {
"type": "integer",
"description": "Default Invoice Due Days"
},
"default_payment_means": {
"type": "string",
"description": "Default Payment Means",
"enum": [
"not_defined",
"credit_transfer"
]
},
"email": {
"type": "string",
"description": "The email value"
},
"fax": {
"type": "string",
"description": "The fax value"
},
"footer": {
"type": "string",
"description": "The footer value"
},
"iban": {
"type": "string",
"description": "The iban value"
},
"identifier": {
"type": "string",
"description": "The identifier value"
},
"info": {
"type": "string",
"description": "The info value"
},
"invoice_due_days": {
"type": "integer",
"description": "Invoice Due Days"
},
"invoice_format": {
"type": "string",
"description": "Invoice Format",
"enum": [
"regular_pdf",
"x_invoice",
"zugferd_x_invoice"
]
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "The labels value"
},
"name": {
"type": "string",
"description": "The name value"
},
"phone": {
"type": "string",
"description": "The phone value"
},
"supplier_tax": {
"type": "number",
"description": "Deprecated VAT shortcut for supplier records."
},
"supplier_vat_code_id": {
"type": "integer",
"description": "Supplier Vat Code Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"customer",
"supplier",
"organization"
]
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"vat_identifier": {
"type": "string",
"description": "Vat Identifier"
},
"website": {
"type": "string",
"description": "The website value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_companies\_1
Update company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `address` | string | No | — | The address value |
| `alternative_correspondence_language` | string | No | — | Alternative Correspondence Language |
| `bank_bic` | string | No | — | Bank Bic |
| `bank_owner` | string | No | — | Bank Owner |
| `billing_email_cc` | string | No | — | Billing Email Cc |
| `billing_notes` | string | No | — | Billing Notes |
| `country_code` | string | No | — | Country Code |
| `credit_number` | string | No | — | Credit Number |
| `currency` | string | No | — | The currency value |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_tax` | number | No | — | Deprecated VAT shortcut for customer records. |
| `customer_vat_code_id` | integer | No | — | Customer Vat Code Id |
| `debit_number` | string | No | — | Debit Number |
| `default_invoice_due_days` | integer | No | — | Default Invoice Due Days |
| `default_payment_means` | string | No | — | Default Payment Means |
| `email` | string | No | — | The email value |
| `fax` | string | No | — | The fax value |
| `footer` | string | No | — | The footer value |
| `iban` | string | No | — | The iban value |
| `identifier` | string | No | — | The identifier value |
| `info` | string | No | — | The info value |
| `invoice_due_days` | integer | No | — | Invoice Due Days |
| `invoice_format` | string | No | — | Invoice Format |
| `labels` | string\[] | No | — | The labels value |
| `name` | string | No | — | The name value |
| `phone` | string | No | — | The phone value |
| `supplier_tax` | number | No | — | Deprecated VAT shortcut for supplier records. |
| `supplier_vat_code_id` | integer | No | — | Supplier Vat Code Id |
| `tags` | string\[] | No | — | The tags value |
| `type` | string | No | — | The type value |
| `user_id` | integer | No | — | User Id |
| `vat_identifier` | string | No | — | Vat Identifier |
| `website` | string | No | — | The website value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"address": {
"type": "string",
"description": "The address value"
},
"alternative_correspondence_language": {
"type": "string",
"description": "Alternative Correspondence Language"
},
"bank_bic": {
"type": "string",
"description": "Bank Bic"
},
"bank_owner": {
"type": "string",
"description": "Bank Owner"
},
"billing_email_cc": {
"type": "string",
"description": "Billing Email Cc"
},
"billing_notes": {
"type": "string",
"description": "Billing Notes"
},
"country_code": {
"type": "string",
"description": "Country Code"
},
"credit_number": {
"type": "string",
"description": "Credit Number"
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_tax": {
"type": "number",
"description": "Deprecated VAT shortcut for customer records."
},
"customer_vat_code_id": {
"type": "integer",
"description": "Customer Vat Code Id"
},
"debit_number": {
"type": "string",
"description": "Debit Number"
},
"default_invoice_due_days": {
"type": "integer",
"description": "Default Invoice Due Days"
},
"default_payment_means": {
"type": "string",
"description": "Default Payment Means",
"enum": [
"not_defined",
"credit_transfer"
]
},
"email": {
"type": "string",
"description": "The email value"
},
"fax": {
"type": "string",
"description": "The fax value"
},
"footer": {
"type": "string",
"description": "The footer value"
},
"iban": {
"type": "string",
"description": "The iban value"
},
"identifier": {
"type": "string",
"description": "The identifier value"
},
"info": {
"type": "string",
"description": "The info value"
},
"invoice_due_days": {
"type": "integer",
"description": "Invoice Due Days"
},
"invoice_format": {
"type": "string",
"description": "Invoice Format",
"enum": [
"regular_pdf",
"x_invoice",
"zugferd_x_invoice"
]
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "The labels value"
},
"name": {
"type": "string",
"description": "The name value"
},
"phone": {
"type": "string",
"description": "The phone value"
},
"supplier_tax": {
"type": "number",
"description": "Deprecated VAT shortcut for supplier records."
},
"supplier_vat_code_id": {
"type": "integer",
"description": "Supplier Vat Code Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"customer",
"supplier",
"organization"
]
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"vat_identifier": {
"type": "string",
"description": "Vat Identifier"
},
"website": {
"type": "string",
"description": "The website value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_companies\_archive
Archive company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_companies\_unarchive
Unarchive company
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_contacts\_people
Update contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `bday` | string | No | — | The bday value |
| `birthday` | string | No | — | The birthday value |
| `company_id` | integer | No | — | Company Id |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_id` | integer | No | — | Customer Id |
| `firstname` | string | No | — | The firstname value |
| `gender` | string | No | — | The gender value |
| `home_address` | string | No | — | Home Address |
| `home_email` | string | No | — | Home Email |
| `info` | string | No | — | The info value |
| `job_position` | string | No | — | Job Position |
| `lastname` | string | No | — | The lastname value |
| `mobile_phone` | string | No | — | Mobile Phone |
| `name` | string | No | — | The name value |
| `organization_id` | integer | No | — | Organization Id |
| `salutation` | string | No | — | The salutation value |
| `tags` | string\[] | No | — | The tags value |
| `title` | string | No | — | The title value |
| `user_id` | integer | No | — | User Id |
| `work_address` | string | No | — | Work Address |
| `work_email` | string | No | — | Work Email |
| `work_fax` | string | No | — | Work Fax |
| `work_phone` | string | No | — | Work Phone |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"bday": {
"type": "string",
"description": "The bday value"
},
"birthday": {
"type": "string",
"description": "The birthday value"
},
"company_id": {
"type": "integer",
"description": "Company Id"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"firstname": {
"type": "string",
"description": "The firstname value"
},
"gender": {
"type": "string",
"description": "The gender value"
},
"home_address": {
"type": "string",
"description": "Home Address"
},
"home_email": {
"type": "string",
"description": "Home Email"
},
"info": {
"type": "string",
"description": "The info value"
},
"job_position": {
"type": "string",
"description": "Job Position"
},
"lastname": {
"type": "string",
"description": "The lastname value"
},
"mobile_phone": {
"type": "string",
"description": "Mobile Phone"
},
"name": {
"type": "string",
"description": "The name value"
},
"organization_id": {
"type": "integer",
"description": "Organization Id"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"title": {
"type": "string",
"description": "The title value"
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"work_address": {
"type": "string",
"description": "Work Address"
},
"work_email": {
"type": "string",
"description": "Work Email"
},
"work_fax": {
"type": "string",
"description": "Work Fax"
},
"work_phone": {
"type": "string",
"description": "Work Phone"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_contacts\_people\_1
Update contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `bday` | string | No | — | The bday value |
| `birthday` | string | No | — | The birthday value |
| `company_id` | integer | No | — | Company Id |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_id` | integer | No | — | Customer Id |
| `firstname` | string | No | — | The firstname value |
| `gender` | string | No | — | The gender value |
| `home_address` | string | No | — | Home Address |
| `home_email` | string | No | — | Home Email |
| `info` | string | No | — | The info value |
| `job_position` | string | No | — | Job Position |
| `lastname` | string | No | — | The lastname value |
| `mobile_phone` | string | No | — | Mobile Phone |
| `name` | string | No | — | The name value |
| `organization_id` | integer | No | — | Organization Id |
| `salutation` | string | No | — | The salutation value |
| `tags` | string\[] | No | — | The tags value |
| `title` | string | No | — | The title value |
| `user_id` | integer | No | — | User Id |
| `work_address` | string | No | — | Work Address |
| `work_email` | string | No | — | Work Email |
| `work_fax` | string | No | — | Work Fax |
| `work_phone` | string | No | — | Work Phone |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"bday": {
"type": "string",
"description": "The bday value"
},
"birthday": {
"type": "string",
"description": "The birthday value"
},
"company_id": {
"type": "integer",
"description": "Company Id"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"firstname": {
"type": "string",
"description": "The firstname value"
},
"gender": {
"type": "string",
"description": "The gender value"
},
"home_address": {
"type": "string",
"description": "Home Address"
},
"home_email": {
"type": "string",
"description": "Home Email"
},
"info": {
"type": "string",
"description": "The info value"
},
"job_position": {
"type": "string",
"description": "Job Position"
},
"lastname": {
"type": "string",
"description": "The lastname value"
},
"mobile_phone": {
"type": "string",
"description": "Mobile Phone"
},
"name": {
"type": "string",
"description": "The name value"
},
"organization_id": {
"type": "integer",
"description": "Organization Id"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"title": {
"type": "string",
"description": "The title value"
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"work_address": {
"type": "string",
"description": "Work Address"
},
"work_email": {
"type": "string",
"description": "Work Email"
},
"work_fax": {
"type": "string",
"description": "Work Fax"
},
"work_phone": {
"type": "string",
"description": "Work Phone"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_deal\_categories
Update deal category
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `name` | string | No | — | The name value |
| `probability` | integer | No | — | Probability in percent (0-100). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"name": {
"type": "string",
"description": "The name value"
},
"probability": {
"type": "integer",
"description": "Probability in percent (0-100)."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_deal\_categories\_1
Update deal category
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `name` | string | No | — | The name value |
| `probability` | integer | No | — | Probability in percent (0-100). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"name": {
"type": "string",
"description": "The name value"
},
"probability": {
"type": "integer",
"description": "Probability in percent (0-100)."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_deals
Update deal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `closed_on` | string | No | — | Closed On |
| `company_id` | integer | No | — | Company/customer ID. |
| `currency` | string | No | — | The currency value |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_id` | integer | No | — | Deprecated alias for `company_id`. |
| `deal_category_id` | integer | No | — | Deal category ID. |
| `info` | string | No | — | The info value |
| `money` | number | No | — | Deal value in selected currency. |
| `name` | string | No | — | The name value |
| `person_id` | integer | No | — | Linked contact person ID. |
| `reminder_date` | string | No | — | Reminder Date |
| `service_period_from` | string | No | — | Service Period From |
| `service_period_to` | string | No | — | Service Period To |
| `status` | string | No | — | The status value |
| `tags` | string\[] | No | — | The tags value |
| `user_id` | integer | No | — | Responsible user ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"closed_on": {
"type": "string",
"description": "Closed On"
},
"company_id": {
"type": "integer",
"description": "Company/customer ID."
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_id": {
"type": "integer",
"description": "Deprecated alias for `company_id`."
},
"deal_category_id": {
"type": "integer",
"description": "Deal category ID."
},
"info": {
"type": "string",
"description": "The info value"
},
"money": {
"type": "number",
"description": "Deal value in selected currency."
},
"name": {
"type": "string",
"description": "The name value"
},
"person_id": {
"type": "integer",
"description": "Linked contact person ID."
},
"reminder_date": {
"type": "string",
"description": "Reminder Date"
},
"service_period_from": {
"type": "string",
"description": "Service Period From"
},
"service_period_to": {
"type": "string",
"description": "Service Period To"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"potential",
"pending",
"won",
"lost",
"dropped"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"user_id": {
"type": "integer",
"description": "Responsible user ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_deals\_1
Update deal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `closed_on` | string | No | — | Closed On |
| `company_id` | integer | No | — | Company/customer ID. |
| `currency` | string | No | — | The currency value |
| `custom_properties` | object | No | — | Custom Properties |
| `customer_id` | integer | No | — | Deprecated alias for `company_id`. |
| `deal_category_id` | integer | No | — | Deal category ID. |
| `info` | string | No | — | The info value |
| `money` | number | No | — | Deal value in selected currency. |
| `name` | string | No | — | The name value |
| `person_id` | integer | No | — | Linked contact person ID. |
| `reminder_date` | string | No | — | Reminder Date |
| `service_period_from` | string | No | — | Service Period From |
| `service_period_to` | string | No | — | Service Period To |
| `status` | string | No | — | The status value |
| `tags` | string\[] | No | — | The tags value |
| `user_id` | integer | No | — | Responsible user ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"closed_on": {
"type": "string",
"description": "Closed On"
},
"company_id": {
"type": "integer",
"description": "Company/customer ID."
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"customer_id": {
"type": "integer",
"description": "Deprecated alias for `company_id`."
},
"deal_category_id": {
"type": "integer",
"description": "Deal category ID."
},
"info": {
"type": "string",
"description": "The info value"
},
"money": {
"type": "number",
"description": "Deal value in selected currency."
},
"name": {
"type": "string",
"description": "The name value"
},
"person_id": {
"type": "integer",
"description": "Linked contact person ID."
},
"reminder_date": {
"type": "string",
"description": "Reminder Date"
},
"service_period_from": {
"type": "string",
"description": "Service Period From"
},
"service_period_to": {
"type": "string",
"description": "Service Period To"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"potential",
"pending",
"won",
"lost",
"dropped"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"user_id": {
"type": "integer",
"description": "Responsible user ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_offers\_assign
Assign offer to company/project/deal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `company_id` | integer | No | — | Company Id |
| `deal_id` | integer | No | — | Deal Id |
| `project_id` | integer | No | — | Project Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"company_id": {
"type": "integer",
"description": "Company Id"
},
"deal_id": {
"type": "integer",
"description": "Deal Id"
},
"project_id": {
"type": "integer",
"description": "Project Id"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_crm\_update\_status\_offers
Update offer status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `status` | string | Yes | — | The status value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"created",
"sent",
"accepted",
"partially_billed",
"billed",
"archived"
]
}
},
"required": [
"PCID",
"id",
"status"
]
}
```