centralstationcrm-companies

Server path: /centralstationcrm-companies | Type: Application | PCID required: Yes

Tools

Tool	Description
`centralstationcrm_companies_delete_api_companies_by_company_id_addrs_by_id`	Destroy a addrs
`centralstationcrm_companies_delete_api_companies_by_company_id_avatars_by_id`	delete avatar
`centralstationcrm_companies_delete_api_companies_by_company_id_contact_details_by_id`	Destroy a contact_detail
`centralstationcrm_companies_delete_api_companies_by_id`	Destroy a company
`centralstationcrm_companies_get_api_companies`	Retrieves all companies
`centralstationcrm_companies_get_api_companies_by_company_id_addrs`	Retrieves all addrs of the company
`centralstationcrm_companies_get_api_companies_by_company_id_addrs_by_id`	Retrieves the addr
`centralstationcrm_companies_get_api_companies_by_company_id_avatars`	Retrieves all avatars
`centralstationcrm_companies_get_api_companies_by_company_id_avatars_by_id`	retrieve avatar
`centralstationcrm_companies_get_api_companies_by_company_id_contact_details`	Retrieves all contact_details of the company
`centralstationcrm_companies_get_api_companies_by_company_id_contact_details_by_id`	Retrieves the tel
`centralstationcrm_companies_get_api_companies_by_company_id_external_emails`	Retrieves all external_emails
`centralstationcrm_companies_get_api_companies_by_company_id_external_emails_count`	Retrieves total amount of external_emails
`centralstationcrm_companies_get_api_companies_by_id`	Retrieves a company
`centralstationcrm_companies_get_api_companies_count`	Retrieves total amount of companies
`centralstationcrm_companies_get_api_companies_search`	Retrieves companies matching the search
`centralstationcrm_companies_get_api_companies_stats`	Retrieves key information of companies
`centralstationcrm_companies_post_api_companies`	Creates a basic company
`centralstationcrm_companies_post_api_companies_by_company_id_addrs`	Creates a basic Addr
`centralstationcrm_companies_post_api_companies_by_company_id_avatars`	create avatar
`centralstationcrm_companies_post_api_companies_by_company_id_contact_details`	Creates a basic tel
`centralstationcrm_companies_post_api_companies_by_id_merge`	merge another company
`centralstationcrm_companies_put_api_companies_by_company_id_addrs_by_id`	Update a addr
`centralstationcrm_companies_put_api_companies_by_company_id_contact_details_by_id`	Update a contact_detail
`centralstationcrm_companies_put_api_companies_by_id`	Update a company

centralstationcrm_companies_delete_api_companies_by_company_id_addrs_by_id

Destroy a addrs Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the addr belong to
`id`	integer	Yes	—	ID of the contact detail

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the addr belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    }
  },
  "required": [
    "PCID",
    "company_id",
    "id"
  ]
}

centralstationcrm_companies_delete_api_companies_by_company_id_avatars_by_id

delete avatar Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	id
`company_id`	string	Yes	—	company_id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "id"
    },
    "company_id": {
      "type": "string",
      "description": "company_id"
    }
  },
  "required": [
    "PCID",
    "id",
    "company_id"
  ]
}

centralstationcrm_companies_delete_api_companies_by_company_id_contact_details_by_id

Destroy a contact_detail Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the contact details belong to
`id`	integer	Yes	—	ID of the contact detail

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the contact details belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    }
  },
  "required": [
    "PCID",
    "company_id",
    "id"
  ]
}

centralstationcrm_companies_delete_api_companies_by_id

Destroy a company Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	id
`no_log`	boolean	No	—	Set to true if you don’t want to generate a activity for the stream.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "id"
    },
    "no_log": {
      "type": "boolean",
      "description": "Set to true if you don't want to generate a activity for the stream."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

centralstationcrm_companies_get_api_companies

Retrieves all companies Parameters:

Parameter	Type	Required	Default	Description
`perpage`	integer	No	—	Elements per page, maximum of 250
`page`	integer	No	—	Retrieve records of the given page
`order`	string	No	—	Ordering of records using one of the following order options: `abc-asc`, `abc-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`
`includes`	string	No	—	possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the ‘all’ value.
`methods`	string	No	—	Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the ‘all’ value.
`tag_id`	integer	No	—	Optionally submit a tag ID in order to only see companies tagged with the submitted tag
`tag_name`	string	No	—	Optionally submit a tag name in order to only see companies tagged with the submitted tag
`stream_updated_at_before`	string	No	—	Optionally submit a date or timestamp (ISO 8601) in order to only see companies with activities within the stream earlier than the submitted point in time.
`stream_updated_at_after`	string	No	—	Optionally submit a date or timestamp (ISO 8601) in order to only see companies with activities within the stream later than the submitted point in time.
`filter`	object	No	—	Optionally submit one of the companies attributes in order to filter by them (e.g. { ‘user_id’: { ‘equal’: ‘your-value’ } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "perpage": {
      "type": "integer",
      "description": "Elements per page, maximum of 250"
    },
    "page": {
      "type": "integer",
      "description": "Retrieve records of the given page"
    },
    "order": {
      "type": "string",
      "description": "Ordering of records using one of the following order options: `abc-asc`, `abc-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the 'all' value."
    },
    "tag_id": {
      "type": "integer",
      "description": "Optionally submit a tag ID in order to only see companies tagged with the submitted tag"
    },
    "tag_name": {
      "type": "string",
      "description": "Optionally submit a tag name in order to only see companies tagged with the submitted tag"
    },
    "stream_updated_at_before": {
      "type": "string",
      "description": "Optionally submit a date or timestamp (ISO 8601) in order to only see companies with activities within the stream earlier than the submitted point in time."
    },
    "stream_updated_at_after": {
      "type": "string",
      "description": "Optionally submit a date or timestamp (ISO 8601) in order to only see companies with activities within the stream later than the submitted point in time."
    },
    "filter": {
      "type": "object",
      "description": "Optionally submit one of the companies attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)."
    }
  },
  "required": [
    "PCID"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_addrs

Retrieves all addrs of the company Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the contact details belong to
`perpage`	integer	No	—	Elements per page, maximum of 250
`page`	integer	No	—	Retrieve records of the given page
`order`	string	No	—	Ordering of records using one of the following order options: `id-asc`, `id-desc`

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the contact details belong to"
    },
    "perpage": {
      "type": "integer",
      "description": "Elements per page, maximum of 250"
    },
    "page": {
      "type": "integer",
      "description": "Retrieve records of the given page"
    },
    "order": {
      "type": "string",
      "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_addrs_by_id

Retrieves the addr Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the addr belong to
`id`	integer	Yes	—	ID of the addr

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the addr belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the addr"
    }
  },
  "required": [
    "PCID",
    "company_id",
    "id"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_avatars

Retrieves all avatars Parameters:

Parameter	Type	Required	Default	Description
`perpage`	integer	No	—	Elements per page, maximum of 250
`page`	integer	No	—	Retrieve records of the given page
`company_id`	string	Yes	—	company_id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "perpage": {
      "type": "integer",
      "description": "Elements per page, maximum of 250"
    },
    "page": {
      "type": "integer",
      "description": "Retrieve records of the given page"
    },
    "company_id": {
      "type": "string",
      "description": "company_id"
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_avatars_by_id

retrieve avatar Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	id
`company_id`	string	Yes	—	company_id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "id"
    },
    "company_id": {
      "type": "string",
      "description": "company_id"
    }
  },
  "required": [
    "PCID",
    "id",
    "company_id"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_contact_details

Retrieves all contact_details of the company Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the contact details belong to
`order`	string	No	—	Ordering of records using one of the following order options: `id-asc`, `id-desc`
`perpage`	integer	No	—	Elements per page, maximum of 250
`page`	integer	No	—	Retrieve records of the given page

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the contact details belong to"
    },
    "order": {
      "type": "string",
      "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
    },
    "perpage": {
      "type": "integer",
      "description": "Elements per page, maximum of 250"
    },
    "page": {
      "type": "integer",
      "description": "Retrieve records of the given page"
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_contact_details_by_id

Retrieves the tel Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the contact details belong to
`id`	integer	Yes	—	ID of the contact detail

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the contact details belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    }
  },
  "required": [
    "PCID",
    "company_id",
    "id"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_external_emails

Retrieves all external_emails Parameters:

Parameter	Type	Required	Default	Description
`perpage`	integer	No	—	Elements per page, maximum of 250
`page`	integer	No	—	Retrieve records of the given page
`includes`	string	No	—	possible option: comments
`company_id`	integer	Yes	—	ID of the external_emails of the desired company

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "perpage": {
      "type": "integer",
      "description": "Elements per page, maximum of 250"
    },
    "page": {
      "type": "integer",
      "description": "Retrieve records of the given page"
    },
    "includes": {
      "type": "string",
      "description": "possible option: comments"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the external_emails of the desired company"
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_get_api_companies_by_company_id_external_emails_count

Retrieves total amount of external_emails Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the external_emails of the desired company

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the external_emails of the desired company"
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_get_api_companies_by_id

Retrieves a company Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	id
`includes`	string	No	—	possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the ‘all’ value.
`methods`	string	No	—	Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the ‘all’ value.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "id"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the 'all' value."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

centralstationcrm_companies_get_api_companies_count

Retrieves total amount of companies Parameters:

Parameter	Type	Required	Default	Description
`tag_id`	integer	No	—	Optionally submit a tag ID in order to only see companies tagged with the submitted tag
`tag_name`	string	No	—	Optionally submit a tag name in order to only see companies tagged with the submitted tag
`filter`	object	No	—	Optionally submit one of the companies attributes in order to filter by them (e.g. { ‘user_id’: { ‘equal’: ‘your-value’ } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tag_id": {
      "type": "integer",
      "description": "Optionally submit a tag ID in order to only see companies tagged with the submitted tag"
    },
    "tag_name": {
      "type": "string",
      "description": "Optionally submit a tag name in order to only see companies tagged with the submitted tag"
    },
    "filter": {
      "type": "object",
      "description": "Optionally submit one of the companies attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)."
    }
  },
  "required": [
    "PCID"
  ]
}

centralstationcrm_companies_get_api_companies_search

Retrieves companies matching the search Parameters:

Parameter	Type	Required	Default	Description
`perpage`	integer	No	—	Elements per page, maximum of 250
`page`	integer	No	—	Retrieve records of the given page
`name`	string	No	—	Retrieve companies by their name
`includes`	string	No	—	possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the ‘all’ value.
`methods`	string	No	—	Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the ‘all’ value.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "perpage": {
      "type": "integer",
      "description": "Elements per page, maximum of 250"
    },
    "page": {
      "type": "integer",
      "description": "Retrieve records of the given page"
    },
    "name": {
      "type": "string",
      "description": "Retrieve companies by their name"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the 'all' value."
    }
  },
  "required": [
    "PCID"
  ]
}

centralstationcrm_companies_get_api_companies_stats

Retrieves key information of companies Parameters:

Parameter	Type	Required	Default	Description
`tag_id`	integer	No	—	Optionally submit a tag ID in order to only see companies tagged with the submitted tag
`tag_name`	string	No	—	Optionally submit a tag name in order to only see companies tagged with the submitted tag
`filter`	object	No	—	Optionally submit one of the companies attributes in order to filter by them (e.g. { ‘user_id’: { ‘equal’: ‘your-value’ } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tag_id": {
      "type": "integer",
      "description": "Optionally submit a tag ID in order to only see companies tagged with the submitted tag"
    },
    "tag_name": {
      "type": "string",
      "description": "Optionally submit a tag name in order to only see companies tagged with the submitted tag"
    },
    "filter": {
      "type": "object",
      "description": "Optionally submit one of the companies attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)."
    }
  },
  "required": [
    "PCID"
  ]
}

centralstationcrm_companies_post_api_companies

Creates a basic company Parameters:

Parameter	Type	Required	Default	Description
`includes`	string	No	—	possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the ‘all’ value.
`methods`	string	No	—	Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the ‘all’ value.
`no_log`	boolean	No	—	Set to true if you don’t want to generate a activity for the stream.
`company`	object	No	—	company

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url separated by space. Receive all methods using the 'all' value."
    },
    "no_log": {
      "type": "boolean",
      "description": "Set to true if you don't want to generate a activity for the stream."
    },
    "company": {
      "type": "object",
      "description": "company",
      "properties": {
        "group_id": {
          "type": "integer"
        },
        "user_id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "background": {
          "type": "string",
          "description": "details about the company e.g. history"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

centralstationcrm_companies_post_api_companies_by_company_id_addrs

Creates a basic Addr Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the contact details belong to
`addr`	object	No	—	addr

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the contact details belong to"
    },
    "addr": {
      "type": "object",
      "description": "addr",
      "properties": {
        "attachable_type": {
          "type": "string",
          "description": "The record type the address belongs to. Must be either Person or Company. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "attachable_id": {
          "type": "integer",
          "description": "The ID of the record the address belongs to. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "street": {
          "type": "string",
          "description": "The street including the house number or other details (building, c/o)."
        },
        "zip": {
          "type": "string",
          "description": "The zip code."
        },
        "city": {
          "type": "string",
          "description": "The city name. Either the city or the country_code is mandatory."
        },
        "state_code": {
          "type": "string",
          "description": "The state code (e.g. NW, BY). Must match the county code."
        },
        "country_code": {
          "type": "string",
          "description": "The country code (e.g. DE, AT)."
        },
        "primary": {
          "type": "boolean",
          "description": "Decides about the order of addresses when the attachable (Person or Company) has multiple addrs."
        },
        "atype": {
          "type": "string",
          "description": "Must be one of work_hq, work, invoice, delivery, private or other."
        },
        "api_input": {
          "type": "boolean",
          "description": "States weather or not the addr has been added via the API or some sort of integration."
        }
      },
      "required": [
        "attachable_id",
        "attachable_type",
        "city"
      ]
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_post_api_companies_by_company_id_avatars

create avatar Parameters:

Parameter	Type	Required	Default	Description
`company_id`	string	Yes	—	company_id
`avatar`	object	No	—	avatar

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "string",
      "description": "company_id"
    },
    "avatar": {
      "description": "avatar"
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_post_api_companies_by_company_id_contact_details

Creates a basic tel Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the contact details belong to
`tel`	object	No	—	tel

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the contact details belong to"
    },
    "tel": {
      "type": "object",
      "description": "tel",
      "properties": {
        "attachable_type": {
          "type": "string",
          "description": "The record type the contact detail belongs to. Must be either Person or Company. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "attachable_id": {
          "type": "integer",
          "description": "The ID of the record the contact detail belongs to. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "atype": {
          "type": "string",
          "description": "Must be one of office, office_hq, mobile, fax, private, voip, skype or other."
        },
        "name": {
          "type": "string",
          "description": "The value of the contact detail according to the selected type."
        }
      },
      "required": [
        "attachable_type",
        "attachable_id",
        "atype",
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "company_id"
  ]
}

centralstationcrm_companies_post_api_companies_by_id_merge

merge another company Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	id
`no_log`	boolean	No	—	Set to true if you don’t want to generate a activity for the stream.
`body`	object	No	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "id"
    },
    "no_log": {
      "type": "boolean",
      "description": "Set to true if you don't want to generate a activity for the stream."
    },
    "body": {
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

centralstationcrm_companies_put_api_companies_by_company_id_addrs_by_id

Update a addr Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the addr belong to
`id`	integer	Yes	—	ID of the addr
`addr`	object	No	—	addr

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the addr belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the addr"
    },
    "addr": {
      "type": "object",
      "description": "addr",
      "properties": {
        "attachable_type": {
          "type": "string",
          "description": "The record type the address belongs to. Must be either Person or Company. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "attachable_id": {
          "type": "integer",
          "description": "The ID of the record the address belongs to. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "street": {
          "type": "string",
          "description": "The street including the house number or other details (building, c/o)."
        },
        "zip": {
          "type": "string",
          "description": "The zip code."
        },
        "city": {
          "type": "string",
          "description": "The city name. Either the city or the country_code is mandatory."
        },
        "state_code": {
          "type": "string",
          "description": "The state code (e.g. NW, BY). Must match the county code."
        },
        "country_code": {
          "type": "string",
          "description": "The country code (e.g. DE, AT)."
        },
        "primary": {
          "type": "boolean",
          "description": "Decides about the order of addresses when the attachable (Person or Company) has multiple addrs."
        },
        "atype": {
          "type": "string",
          "description": "Must be one of work_hq, work, invoice, delivery, private or other."
        },
        "api_input": {
          "type": "boolean",
          "description": "States weather or not the addr has been added via the API or some sort of integration."
        }
      },
      "required": [
        "attachable_id",
        "attachable_type",
        "city"
      ]
    }
  },
  "required": [
    "PCID",
    "company_id",
    "id"
  ]
}

centralstationcrm_companies_put_api_companies_by_company_id_contact_details_by_id

Update a contact_detail Parameters:

Parameter	Type	Required	Default	Description
`company_id`	integer	Yes	—	ID of the company the contact details belong to
`id`	integer	Yes	—	ID of the contact detail
`tel`	object	No	—	tel

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_id": {
      "type": "integer",
      "description": "ID of the company the contact details belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    },
    "tel": {
      "type": "object",
      "description": "tel",
      "properties": {
        "attachable_type": {
          "type": "string",
          "description": "The record type the contact detail belongs to. Must be either Person or Company. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "attachable_id": {
          "type": "integer",
          "description": "The ID of the record the contact detail belongs to. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "atype": {
          "type": "string",
          "description": "Must be one of office, office_hq, mobile, fax, private, voip, skype or other."
        },
        "name": {
          "type": "string",
          "description": "The value of the contact detail according to the selected type."
        }
      },
      "required": [
        "attachable_type",
        "attachable_id",
        "atype",
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "company_id",
    "id"
  ]
}

centralstationcrm_companies_put_api_companies_by_id

Update a company Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	id
`no_log`	boolean	No	—	Set to true if you don’t want to generate a activity for the stream.
`company`	object	No	—	company

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "id"
    },
    "no_log": {
      "type": "boolean",
      "description": "Set to true if you don't want to generate a activity for the stream."
    },
    "company": {
      "type": "object",
      "description": "company",
      "properties": {
        "group_id": {
          "type": "integer"
        },
        "user_id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "background": {
          "type": "string",
          "description": "details about the company e.g. history"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Tools

centralstationcrm_companies_delete_api_companies_by_company_id_addrs_by_id

centralstationcrm_companies_delete_api_companies_by_company_id_avatars_by_id

centralstationcrm_companies_delete_api_companies_by_company_id_contact_details_by_id

centralstationcrm_companies_delete_api_companies_by_id

centralstationcrm_companies_get_api_companies

centralstationcrm_companies_get_api_companies_by_company_id_addrs

centralstationcrm_companies_get_api_companies_by_company_id_addrs_by_id

centralstationcrm_companies_get_api_companies_by_company_id_avatars

centralstationcrm_companies_get_api_companies_by_company_id_avatars_by_id

centralstationcrm_companies_get_api_companies_by_company_id_contact_details

centralstationcrm_companies_get_api_companies_by_company_id_contact_details_by_id

centralstationcrm_companies_get_api_companies_by_company_id_external_emails

centralstationcrm_companies_get_api_companies_by_company_id_external_emails_count

centralstationcrm_companies_get_api_companies_by_id

centralstationcrm_companies_get_api_companies_count

centralstationcrm_companies_get_api_companies_search

centralstationcrm_companies_get_api_companies_stats

centralstationcrm_companies_post_api_companies

centralstationcrm_companies_post_api_companies_by_company_id_addrs

centralstationcrm_companies_post_api_companies_by_company_id_avatars

centralstationcrm_companies_post_api_companies_by_company_id_contact_details

centralstationcrm_companies_post_api_companies_by_id_merge

centralstationcrm_companies_put_api_companies_by_company_id_addrs_by_id

centralstationcrm_companies_put_api_companies_by_company_id_contact_details_by_id

centralstationcrm_companies_put_api_companies_by_id

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​centralstationcrm_companies_delete_api_companies_by_company_id_addrs_by_id

​centralstationcrm_companies_delete_api_companies_by_company_id_avatars_by_id

​centralstationcrm_companies_delete_api_companies_by_company_id_contact_details_by_id

​centralstationcrm_companies_delete_api_companies_by_id

​centralstationcrm_companies_get_api_companies

​centralstationcrm_companies_get_api_companies_by_company_id_addrs

​centralstationcrm_companies_get_api_companies_by_company_id_addrs_by_id

​centralstationcrm_companies_get_api_companies_by_company_id_avatars

​centralstationcrm_companies_get_api_companies_by_company_id_avatars_by_id

​centralstationcrm_companies_get_api_companies_by_company_id_contact_details

​centralstationcrm_companies_get_api_companies_by_company_id_contact_details_by_id

​centralstationcrm_companies_get_api_companies_by_company_id_external_emails

​centralstationcrm_companies_get_api_companies_by_company_id_external_emails_count

​centralstationcrm_companies_get_api_companies_by_id

​centralstationcrm_companies_get_api_companies_count

​centralstationcrm_companies_get_api_companies_search

​centralstationcrm_companies_get_api_companies_stats

​centralstationcrm_companies_post_api_companies

​centralstationcrm_companies_post_api_companies_by_company_id_addrs

​centralstationcrm_companies_post_api_companies_by_company_id_avatars

​centralstationcrm_companies_post_api_companies_by_company_id_contact_details

​centralstationcrm_companies_post_api_companies_by_id_merge

​centralstationcrm_companies_put_api_companies_by_company_id_addrs_by_id

​centralstationcrm_companies_put_api_companies_by_company_id_contact_details_by_id

​centralstationcrm_companies_put_api_companies_by_id

Tools

centralstationcrm_companies_delete_api_companies_by_company_id_addrs_by_id

centralstationcrm_companies_delete_api_companies_by_company_id_avatars_by_id

centralstationcrm_companies_delete_api_companies_by_company_id_contact_details_by_id

centralstationcrm_companies_delete_api_companies_by_id

centralstationcrm_companies_get_api_companies

centralstationcrm_companies_get_api_companies_by_company_id_addrs

centralstationcrm_companies_get_api_companies_by_company_id_addrs_by_id

centralstationcrm_companies_get_api_companies_by_company_id_avatars

centralstationcrm_companies_get_api_companies_by_company_id_avatars_by_id

centralstationcrm_companies_get_api_companies_by_company_id_contact_details

centralstationcrm_companies_get_api_companies_by_company_id_contact_details_by_id

centralstationcrm_companies_get_api_companies_by_company_id_external_emails

centralstationcrm_companies_get_api_companies_by_company_id_external_emails_count

centralstationcrm_companies_get_api_companies_by_id

centralstationcrm_companies_get_api_companies_count

centralstationcrm_companies_get_api_companies_search

centralstationcrm_companies_get_api_companies_stats

centralstationcrm_companies_post_api_companies

centralstationcrm_companies_post_api_companies_by_company_id_addrs

centralstationcrm_companies_post_api_companies_by_company_id_avatars

centralstationcrm_companies_post_api_companies_by_company_id_contact_details

centralstationcrm_companies_post_api_companies_by_id_merge

centralstationcrm_companies_put_api_companies_by_company_id_addrs_by_id

centralstationcrm_companies_put_api_companies_by_company_id_contact_details_by_id

centralstationcrm_companies_put_api_companies_by_id