centralstationcrm-people

CentralStationCRM People — manage people contacts, addresses, contact details, positions, and related data

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

Tools

Tool	Description
centralstationcrm_people_delete_api_people_by_id	Destroy a person
centralstationcrm_people_delete_api_people_by_person_id_addrs_by_id	Destroy a addrs
centralstationcrm_people_delete_api_people_by_person_id_assis_by_id	Destroy a assi
centralstationcrm_people_delete_api_people_by_person_id_avatars_by_id	delete avatar
centralstationcrm_people_delete_api_people_by_person_id_contact_details_by_id	Destroy a contact_detail
centralstationcrm_people_delete_api_people_by_person_id_custom_fields_by_id	Destroy a custom_field
centralstationcrm_people_delete_api_people_by_person_id_historic_events_by_id	Destroy a historic_event
centralstationcrm_people_delete_api_people_by_person_id_positions_by_id	Destroy a position
centralstationcrm_people_delete_api_people_by_person_id_tags_by_id	Destroy a tag
centralstationcrm_people_get_api_people	Retrieves all people
centralstationcrm_people_get_api_people_by_id	Retrieves a person
centralstationcrm_people_get_api_people_by_person_id_addrs	Retrieves all addrs of the person
centralstationcrm_people_get_api_people_by_person_id_addrs_by_id	Retrieves the addr
centralstationcrm_people_get_api_people_by_person_id_assis	Retrieves all assis of the person
centralstationcrm_people_get_api_people_by_person_id_assis_by_id	Retrieves the assi
centralstationcrm_people_get_api_people_by_person_id_avatars	Retrieves all avatars
centralstationcrm_people_get_api_people_by_person_id_avatars_by_id	retrieve avatar
centralstationcrm_people_get_api_people_by_person_id_contact_details	Retrieves all contact_details of the person
centralstationcrm_people_get_api_people_by_person_id_contact_details_by_id	Retrieves the tel
centralstationcrm_people_get_api_people_by_person_id_custom_fields	Retrieves all custom_fields of the person
centralstationcrm_people_get_api_people_by_person_id_custom_fields_by_id	Retrieves the custom field
centralstationcrm_people_get_api_people_by_person_id_external_emails	Retrieves all external_emails
centralstationcrm_people_get_api_people_by_person_id_external_emails_count	Retrieves total amount of external_emails
centralstationcrm_people_get_api_people_by_person_id_historic_events	Retrieves all historic_events of the person
centralstationcrm_people_get_api_people_by_person_id_historic_events_by_id	Retrieves the historic_event
centralstationcrm_people_get_api_people_by_person_id_positions	Retrieves all positions
centralstationcrm_people_get_api_people_by_person_id_positions_by_id	Retrieves a position
centralstationcrm_people_get_api_people_by_person_id_tags	Retrieves all tags
centralstationcrm_people_get_api_people_by_person_id_tags_by_id	Retrieves a tag
centralstationcrm_people_get_api_people_count	Retrieves total amount of people
centralstationcrm_people_get_api_people_search	Retrieves people matching the search
centralstationcrm_people_get_api_people_stats	Retrieves key information of people
centralstationcrm_people_post_api_people	creates a person
centralstationcrm_people_post_api_people_by_id_merge	merge another person
centralstationcrm_people_post_api_people_by_person_id_addrs	Creates a basic Addr
centralstationcrm_people_post_api_people_by_person_id_assis	Creates an assi of the person
centralstationcrm_people_post_api_people_by_person_id_avatars	create avatar
centralstationcrm_people_post_api_people_by_person_id_contact_details	Creates a basic tel
centralstationcrm_people_post_api_people_by_person_id_custom_fields	Creates a basic custom field
centralstationcrm_people_post_api_people_by_person_id_historic_events	Creates a basic historic_event
centralstationcrm_people_post_api_people_by_person_id_positions	Creates a basic position
centralstationcrm_people_post_api_people_by_person_id_tags	Creates a basic tag
centralstationcrm_people_put_api_people_by_id	Update a person
centralstationcrm_people_put_api_people_by_person_id_addrs_by_id	Update a addr
centralstationcrm_people_put_api_people_by_person_id_assis_by_id	Update a assi
centralstationcrm_people_put_api_people_by_person_id_contact_details_by_id	Update a contact_detail
centralstationcrm_people_put_api_people_by_person_id_custom_fields_by_id	Update a custom_field
centralstationcrm_people_put_api_people_by_person_id_historic_events_by_id	Update a historic_event
centralstationcrm_people_put_api_people_by_person_id_positions_by_id	Update a position
centralstationcrm_people_put_api_people_by_person_id_tags_by_id	Update a tag

---

centralstationcrm_people_delete_api_people_by_id

Destroy a person

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
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": "The id value"
    },
    "no_log": {
      "type": "boolean",
      "description": "Set to true if you don't want to generate a activity for the stream."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

centralstationcrm_people_delete_api_people_by_person_id_addrs_by_id

Destroy a addrs

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the addr belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_delete_api_people_by_person_id_assis_by_id

Destroy a assi

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the assi belong to
id	integer	Yes	—	ID of the assi

Show inputSchema

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

---

centralstationcrm_people_delete_api_people_by_person_id_avatars_by_id

delete avatar

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
person_id	string	Yes	—	Person Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "person_id": {
      "type": "string",
      "description": "Person Id"
    }
  },
  "required": [
    "PCID",
    "id",
    "person_id"
  ]
}

---

centralstationcrm_people_delete_api_people_by_person_id_contact_details_by_id

Destroy a contact_detail

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the contact details belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_delete_api_people_by_person_id_custom_fields_by_id

Destroy a custom_field

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the custom fields belong to
id	integer	Yes	—	ID of the custom field

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the custom fields belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the custom field"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_delete_api_people_by_person_id_historic_events_by_id

Destroy a historic_event

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the historic event belong to
id	integer	Yes	—	ID of the historic event

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the historic event belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the historic event"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_delete_api_people_by_person_id_positions_by_id

Destroy a position

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
id	string	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_delete_api_people_by_person_id_tags_by_id

Destroy a tag

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
id	string	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people

Retrieves all people

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, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the ‘all’ value.
methods	string	No	—	Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_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 people tagged with the submitted tag
tag_name	string	No	—	Optionally submit a tag name in order to only see people tagged with the submitted tag
stream_updated_at_before	string	No	—	Optionally submit a date or timestamp (ISO 8601) in order to only see people 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 people with activities within the stream later than the submitted point in time.
custom_fields	string	No	—	Optionally submit one or multiple custom field types to filter by their value. This shall be formatted like custom_fields[custom_field_type_id]=value
filter	object	No	—	Optionally submit one of the people attributes in order to filter by them (e.g. { ‘name’: { ‘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, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_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 people tagged with the submitted tag"
    },
    "tag_name": {
      "type": "string",
      "description": "Optionally submit a tag name in order to only see people 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 people 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 people with activities within the stream later than the submitted point in time."
    },
    "custom_fields": {
      "type": "string",
      "description": "Optionally submit one or multiple custom field types to filter by their value. This shall be formatted like custom_fields[custom_field_type_id]=value"
    },
    "filter": {
      "type": "object",
      "description": "Optionally submit one of the people attributes in order to filter by them (e.g. { 'name': { '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_people_get_api_people_by_id

Retrieves a person

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The id value
includes	string	No	—	possible includes are: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the ‘all’ value.
methods	string	No	—	Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_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": "The id value"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_url separated by space. Receive all methods using the 'all' value."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_addrs

Retrieves all addrs of the person

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person 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",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_addrs_by_id

Retrieves the addr

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the addr belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the addr"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_assis

Retrieves all assis of the person

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the assi 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the assi 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",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_assis_by_id

Retrieves the assi

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the assi belong to
id	integer	Yes	—	ID of the assi

Show inputSchema

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

---

centralstationcrm_people_get_api_people_by_person_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
person_id	string	Yes	—	Person 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"
    },
    "person_id": {
      "type": "string",
      "description": "Person Id"
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_avatars_by_id

retrieve avatar

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
person_id	string	Yes	—	Person Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "person_id": {
      "type": "string",
      "description": "Person Id"
    }
  },
  "required": [
    "PCID",
    "id",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_contact_details

Retrieves all contact_details of the person

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person 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",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_contact_details_by_id

Retrieves the tel

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the contact details belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_custom_fields

Retrieves all custom_fields of the person

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the custom fields 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
includes	string	No	—	possible option: custom_fields_type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the custom fields 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"
    },
    "includes": {
      "type": "string",
      "description": "possible option: custom_fields_type"
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_custom_fields_by_id

Retrieves the custom field

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the custom fields belong to
id	integer	Yes	—	ID of the custom field
includes	string	No	—	possible option: custom_fields_type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the custom fields belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the custom field"
    },
    "includes": {
      "type": "string",
      "description": "possible option: custom_fields_type"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_external_emails

Retrieves all external_emails

Parameters:

Parameter	Type	Required	Default	Description
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
includes	string	No	—	possible option: comments
person_id	integer	Yes	—	ID of the external_emails of the desired person

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
    },
    "includes": {
      "type": "string",
      "description": "possible option: comments"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the external_emails of the desired person"
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_external_emails_count

Retrieves total amount of external_emails

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the external_emails of the desired person

Show inputSchema

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

---

centralstationcrm_people_get_api_people_by_person_id_historic_events

Retrieves all historic_events of the person

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the historic event 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"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the historic event 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",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_historic_events_by_id

Retrieves the historic_event

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the historic event belong to
id	integer	Yes	—	ID of the historic event

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the historic event belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the historic event"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_positions

Retrieves all positions

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
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
includes	string	No	—	possible includes are: person, company separated by space. Receive all includes using the ‘all’ value.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "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"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: person, company separated by space. Receive all includes using the 'all' value."
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_positions_by_id

Retrieves a position

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
id	integer	Yes	—	The id value
includes	string	No	—	possible includes are: person, company separated by space. Receive all includes using the ‘all’ value.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "id": {
      "type": "integer",
      "description": "The id value"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: person, company separated by space. Receive all includes using the 'all' value."
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_tags

Retrieves all tags

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
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"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "perpage": {
      "type": "integer",
      "description": "Elements per page, maximum of 250"
    },
    "page": {
      "type": "integer",
      "description": "Retrieve records of the given page"
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_get_api_people_by_person_id_tags_by_id

Retrieves a tag

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
id	integer	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "id": {
      "type": "integer",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_get_api_people_count

Retrieves total amount of people

Parameters:

Parameter	Type	Required	Default	Description
tag_id	integer	No	—	Optionally submit a tag ID in order to only see people tagged with the submitted tag
tag_name	string	No	—	Optionally submit a tag name in order to only see people tagged with the submitted tag
filter	object	No	—	Optionally submit one of the people attributes in order to filter by them (e.g. { ‘name’: { ‘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 people tagged with the submitted tag"
    },
    "tag_name": {
      "type": "string",
      "description": "Optionally submit a tag name in order to only see people tagged with the submitted tag"
    },
    "filter": {
      "type": "object",
      "description": "Optionally submit one of the people attributes in order to filter by them (e.g. { 'name': { '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_people_get_api_people_search

Retrieves people 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 people by their last name
first_name	string	No	—	Retrieve people by their first name
email	string	No	—	Retrieve people by their email address (mutually exclusive with phone)
phone	string	No	—	Retrieve people by their phone number (mutually exclusive with email)
includes	string	No	—	possible includes are: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the ‘all’ value.
methods	string	No	—	Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_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 people by their last name"
    },
    "first_name": {
      "type": "string",
      "description": "Retrieve people by their first name"
    },
    "email": {
      "type": "string",
      "description": "Retrieve people by their email address (mutually exclusive with phone)"
    },
    "phone": {
      "type": "string",
      "description": "Retrieve people by their phone number (mutually exclusive with email)"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_url separated by space. Receive all methods using the 'all' value."
    }
  },
  "required": [
    "PCID"
  ]
}

---

centralstationcrm_people_get_api_people_stats

Retrieves key information of people

Parameters:

Parameter	Type	Required	Default	Description
tag_id	integer	No	—	Optionally submit a tag ID in order to only see people tagged with the submitted tag
tag_name	string	No	—	Optionally submit a tag name in order to only see people tagged with the submitted tag
filter	object	No	—	Optionally submit one of the people attributes in order to filter by them (e.g. { ‘name’: { ‘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 people tagged with the submitted tag"
    },
    "tag_name": {
      "type": "string",
      "description": "Optionally submit a tag name in order to only see people tagged with the submitted tag"
    },
    "filter": {
      "type": "object",
      "description": "Optionally submit one of the people attributes in order to filter by them (e.g. { 'name': { '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_people_post_api_people

creates a person

Parameters:

Parameter	Type	Required	Default	Description
includes	string	No	—	possible includes are: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the ‘all’ value.
methods	string	No	—	Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_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.
person	object	No	—	The person value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includes": {
      "type": "string",
      "description": "possible includes are: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the 'all' value."
    },
    "methods": {
      "type": "string",
      "description": "Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_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."
    },
    "person": {
      "type": "object",
      "description": "The person value",
      "properties": {
        "user_id": {
          "type": "integer",
          "description": "User Id"
        },
        "group_id": {
          "type": "integer",
          "description": "Group Id"
        },
        "country_code": {
          "type": "string",
          "description": "language code of the person in ISO-639-1 format"
        },
        "salutation": {
          "type": "string",
          "description": "automatic salutation will be build based on the first name; however a custom salutation can be stored here"
        },
        "title": {
          "type": "string",
          "description": "titles such as doctor or master"
        },
        "gender": {
          "type": "string",
          "description": "DEPRECATED: Use gender_identity instead. This field contains internal values like male_user or male_auto. The system tries to auto detect the gender by the first_name. 0: gender_unknown, 1: male_user, 2: female_user, 3: male_auto, 4: female_auto, 5: family_user, 6: family_auto, 7: diverse_user"
        },
        "gender_identity": {
          "type": "string",
          "description": "Contains the actual gender identity without internal source indicators.",
          "enum": [
            "male",
            "female",
            "diverse",
            "family",
            "unknown"
          ]
        },
        "first_name": {
          "type": "string",
          "description": "First Name"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "background": {
          "type": "string",
          "description": "details about the person e.g. hobbies"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

centralstationcrm_people_post_api_people_by_id_merge

merge another person

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
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": "The id value"
    },
    "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_people_post_api_people_by_person_id_addrs

Creates a basic Addr

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the contact details belong to
addr	object	No	—	The addr value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the contact details belong to"
    },
    "addr": {
      "type": "object",
      "description": "The addr value",
      "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",
    "person_id"
  ]
}

---

centralstationcrm_people_post_api_people_by_person_id_assis

Creates an assi of the person

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the assi belong to
assi	object	No	—	The assi value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the assi belong to"
    },
    "assi": {
      "type": "object",
      "description": "The assi value",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the assistent."
        },
        "email": {
          "type": "string",
          "description": "The email of the assistent."
        },
        "tel": {
          "type": "string",
          "description": "The tel of the assistent."
        },
        "primary": {
          "type": "boolean",
          "description": "Indicates if the assistent is the primary contact."
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_post_api_people_by_person_id_avatars

create avatar

Parameters:

Parameter	Type	Required	Default	Description
person_id	string	Yes	—	Person Id
avatar	object	No	—	The avatar value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "string",
      "description": "Person Id"
    },
    "avatar": {
      "description": "The avatar value"
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_post_api_people_by_person_id_contact_details

Creates a basic tel

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the contact details belong to
tel	object	No	—	The tel value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the contact details belong to"
    },
    "tel": {
      "type": "object",
      "description": "The tel value",
      "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",
    "person_id"
  ]
}

---

centralstationcrm_people_post_api_people_by_person_id_custom_fields

Creates a basic custom field

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the custom fields belong to
custom_field	object	No	—	Custom Field

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the custom fields belong to"
    },
    "custom_field": {
      "type": "object",
      "description": "Custom Field",
      "properties": {
        "attachable_type": {
          "type": "string",
          "description": "The record type the custom field belongs to. Must be either Person, Company, Deal or Project.",
          "enum": [
            "Person",
            "Company",
            "Deal",
            "Project"
          ]
        },
        "attachable_id": {
          "type": "integer",
          "description": "The ID of the record the custom field belongs to."
        },
        "custom_fields_type_id": {
          "type": "integer",
          "description": "The ID of the custom field type the custom field belongs to."
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "api_input": {
          "type": "boolean",
          "description": "States weather or not the custom field has been added via the API or some sort of integration."
        }
      },
      "required": [
        "custom_fields_type_id",
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_post_api_people_by_person_id_historic_events

Creates a basic historic_event

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the historic event belong to
historic_event	object	No	—	Historic Event

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the historic event belong to"
    },
    "historic_event": {
      "type": "object",
      "description": "Historic Event",
      "properties": {
        "atype": {
          "type": "string",
          "description": "The type of the historic event. Must be one of birthday, anniversary, first_met, renewal or other.",
          "enum": [
            "birthday",
            "anniversary",
            "first_met",
            "renewal",
            "other"
          ]
        },
        "name": {
          "type": "string",
          "description": "The date of the historic event."
        },
        "desc": {
          "type": "string",
          "description": "For atype `other` an additional description may be provided."
        }
      },
      "required": [
        "name",
        "atype"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_post_api_people_by_person_id_positions

Creates a basic position

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
position	object	No	—	The position value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "position": {
      "type": "object",
      "description": "The position value",
      "properties": {
        "person_id": {
          "type": "integer",
          "description": "The ID of the person the position belongs to. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "company_id": {
          "type": "integer",
          "description": "The ID of the company the position belongs to. Will be auto set when using routes such as /companies/:id with nested attributes."
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "department": {
          "type": "string",
          "description": "The department value"
        },
        "company_name": {
          "type": "string",
          "description": "Company Name"
        },
        "primary_function": {
          "type": "boolean",
          "description": "Only one position may be set to primary. This will mark the primary position the person holds"
        },
        "former": {
          "type": "boolean",
          "description": "Positions that are no longer active may be marked as former"
        }
      },
      "required": [
        "person_id",
        "company_id"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_post_api_people_by_person_id_tags

Creates a basic tag

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
tag	object	No	—	The tag value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "tag": {
      "type": "object",
      "description": "The tag value",
      "properties": {
        "attachable_id": {
          "type": "integer",
          "description": "id of the record the tag belongs to (e.g. a person). Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "attachable_type": {
          "type": "string",
          "description": "must be Person, Company, Deal, Company. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "api_input": {
          "type": "boolean",
          "description": "States weather or not the tag has been added via the API or some sort of integration."
        }
      },
      "required": [
        "attachable_id",
        "attachable_type",
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id"
  ]
}

---

centralstationcrm_people_put_api_people_by_id

Update a person

Parameters:

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "no_log": {
      "type": "boolean",
      "description": "Set to true if you don't want to generate a activity for the stream."
    },
    "person": {
      "type": "object",
      "description": "The person value",
      "properties": {
        "user_id": {
          "type": "integer",
          "description": "User Id"
        },
        "group_id": {
          "type": "integer",
          "description": "Group Id"
        },
        "country_code": {
          "type": "string",
          "description": "language code of the person in ISO-639-1 format"
        },
        "salutation": {
          "type": "string",
          "description": "automatic salutation will be build based on the first name; however a custom salutation can be stored here"
        },
        "title": {
          "type": "string",
          "description": "titles such as doctor or master"
        },
        "gender": {
          "type": "string",
          "description": "DEPRECATED: Use gender_identity instead. This field contains internal values like male_user or male_auto. The system tries to auto detect the gender by the first_name. 0: gender_unknown, 1: male_user, 2: female_user, 3: male_auto, 4: female_auto, 5: family_user, 6: family_auto, 7: diverse_user"
        },
        "gender_identity": {
          "type": "string",
          "description": "Contains the actual gender identity without internal source indicators.",
          "enum": [
            "male",
            "female",
            "diverse",
            "family",
            "unknown"
          ]
        },
        "first_name": {
          "type": "string",
          "description": "First Name"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "background": {
          "type": "string",
          "description": "details about the person e.g. hobbies"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

centralstationcrm_people_put_api_people_by_person_id_addrs_by_id

Update a addr

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the addr belong to
id	integer	Yes	—	ID of the addr
addr	object	No	—	The addr value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the addr belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the addr"
    },
    "addr": {
      "type": "object",
      "description": "The addr value",
      "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",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_put_api_people_by_person_id_assis_by_id

Update a assi

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the assi belong to
id	integer	Yes	—	ID of the assi
assi	object	No	—	The assi value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the assi belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the assi"
    },
    "assi": {
      "type": "object",
      "description": "The assi value",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the assistent."
        },
        "email": {
          "type": "string",
          "description": "The email of the assistent."
        },
        "tel": {
          "type": "string",
          "description": "The tel of the assistent."
        },
        "primary": {
          "type": "boolean",
          "description": "Indicates if the assistent is the primary contact."
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_put_api_people_by_person_id_contact_details_by_id

Update a contact_detail

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the contact details belong to
id	integer	Yes	—	ID of the contact detail
tel	object	No	—	The tel value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the contact details belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the contact detail"
    },
    "tel": {
      "type": "object",
      "description": "The tel value",
      "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",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_put_api_people_by_person_id_custom_fields_by_id

Update a custom_field

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the custom fields belong to
id	integer	Yes	—	ID of the custom field
custom_field	object	No	—	Custom Field

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the custom fields belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the custom field"
    },
    "custom_field": {
      "type": "object",
      "description": "Custom Field",
      "properties": {
        "attachable_type": {
          "type": "string",
          "description": "The record type the custom field belongs to. Must be either Person, Company, Deal or Project.",
          "enum": [
            "Person",
            "Company",
            "Deal",
            "Project"
          ]
        },
        "attachable_id": {
          "type": "integer",
          "description": "The ID of the record the custom field belongs to."
        },
        "custom_fields_type_id": {
          "type": "integer",
          "description": "The ID of the custom field type the custom field belongs to."
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "api_input": {
          "type": "boolean",
          "description": "States weather or not the custom field has been added via the API or some sort of integration."
        }
      },
      "required": [
        "custom_fields_type_id",
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_put_api_people_by_person_id_historic_events_by_id

Update a historic_event

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	ID of the person the historic event belong to
id	integer	Yes	—	ID of the historic event
historic_event	object	No	—	Historic Event

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "ID of the person the historic event belong to"
    },
    "id": {
      "type": "integer",
      "description": "ID of the historic event"
    },
    "historic_event": {
      "type": "object",
      "description": "Historic Event",
      "properties": {
        "atype": {
          "type": "string",
          "description": "The type of the historic event. Must be one of birthday, anniversary, first_met, renewal or other.",
          "enum": [
            "birthday",
            "anniversary",
            "first_met",
            "renewal",
            "other"
          ]
        },
        "name": {
          "type": "string",
          "description": "The date of the historic event."
        },
        "desc": {
          "type": "string",
          "description": "For atype `other` an additional description may be provided."
        }
      },
      "required": [
        "name",
        "atype"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_put_api_people_by_person_id_positions_by_id

Update a position

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
id	string	Yes	—	The id value
position	object	No	—	The position value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "position": {
      "type": "object",
      "description": "The position value",
      "properties": {
        "person_id": {
          "type": "integer",
          "description": "The ID of the person the position belongs to. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "company_id": {
          "type": "integer",
          "description": "The ID of the company the position belongs to. Will be auto set when using routes such as /companies/:id with nested attributes."
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "department": {
          "type": "string",
          "description": "The department value"
        },
        "company_name": {
          "type": "string",
          "description": "Company Name"
        },
        "primary_function": {
          "type": "boolean",
          "description": "Only one position may be set to primary. This will mark the primary position the person holds"
        },
        "former": {
          "type": "boolean",
          "description": "Positions that are no longer active may be marked as former"
        }
      },
      "required": [
        "person_id",
        "company_id"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}

---

centralstationcrm_people_put_api_people_by_person_id_tags_by_id

Update a tag

Parameters:

Parameter	Type	Required	Default	Description
person_id	integer	Yes	—	Person Id
id	string	Yes	—	The id value
tag	object	No	—	The tag value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "person_id": {
      "type": "integer",
      "description": "Person Id"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "tag": {
      "type": "object",
      "description": "The tag value",
      "properties": {
        "attachable_id": {
          "type": "integer",
          "description": "id of the record the tag belongs to (e.g. a person). Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "attachable_type": {
          "type": "string",
          "description": "must be Person, Company, Deal, Company. Will be auto set when using routes such as /people/:id with nested attributes."
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "api_input": {
          "type": "boolean",
          "description": "States weather or not the tag has been added via the API or some sort of integration."
        }
      },
      "required": [
        "attachable_id",
        "attachable_type",
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "person_id",
    "id"
  ]
}