suitedash_list_contacts
List contacts
List CRM contacts (leads, prospects, clients) 10 per page: name, emails, phones, role, tags, companies, address and custom fields. Filter by creation time and sort by name or creation date. GET /contacts.
输入参数metapageorder_bycreated_aftercreated_before
suitedash_get_contact
Get contact
One CRM contact by UID or primary email, with companies, tags, address and custom fields. GET /contact/{identifier}.
输入参数metaidentifier必填
suitedash_get_contact_fields
Get contact field schema
The contact field schema of this account: every default and custom field with its type, whether it is required, and which actions (read/create/update) allow it. Custom fields appear under their UID: use these UIDs in custom_fields. GET /contact/meta.
无需输入参数。
suitedash_create_contact
Create contact
WRITE: create a CRM contact in SuiteDash. role and names are required; email is required except for a Lead. Optionally link the contact to a company by name (set create_company_if_not_exists to create it). If send_welcome_email is true SuiteDash EMAILS the contact a portal access invitation: leave it false unless the user asked for that. POST /contact.
输入参数role必填tagsemailphonetitleaddresswebsitelast_name必填first_name必填name_prefixcompany_namecustom_fields另有 3 个
suitedash_update_contact
Update contact
WRITE: update fields of an existing CRM contact (found by UID or email); only the fields you pass change, and null clears a field. Tags and custom fields passed here replace the current values. If send_welcome_email is true SuiteDash EMAILS the contact a portal invitation (only if none was sent before): leave it unset unless the user asked. PUT /contact/{identifier}.
输入参数tagsemailphonetitleaddresswebsitelast_namefirst_namehome_emailhome_phoneidentifier必填shop_phone另有 8 个
suitedash_list_companies
List companies
List CRM companies 10 per page (idle companies are not available): name, role, category, phones, website, address, tags, primary contact and custom fields. Filter by creation time and sort by name or creation date. GET /companies.
输入参数metapageorder_bycreated_aftercreated_before
suitedash_get_company
Get company
One CRM company by UID or exact name, with primary contact, category, tags, address and custom fields. GET /company/{identifier}.
输入参数metaidentifier必填
suitedash_get_company_fields
Get company field schema
The company field schema of this account: every default and custom field (public, private and target custom fields under their UIDs) with type, required flag and the actions allowed. GET /company/meta.
无需输入参数。
suitedash_create_company
Create company
WRITE: create a CRM company (name and role are required) with an optional primary contact. With create_primary_contact_if_not_exists the primary contact is created from the given names/email when no contact has that email. If send_welcome_email is true SuiteDash EMAILS the primary contact a portal invitation: leave it false unless the user asked. POST /company.
输入参数name必填role必填primary_contact
suitedash_update_company
Update company
WRITE: update fields of an existing CRM company (found by UID or name); only the fields you pass change, and null clears a field. Tags and custom fields passed here replace the current values. PUT /company/{identifier}.
输入参数nametagsphoneaddresswebsitecategoryhome_phoneidentifier必填shop_phonework_phonebackground_infopublic_custom_fields另有 1 个
suitedash_list_projects
List projects
List projects 10 per page: name, status, start/end dates, due time. Filter by creation time and sort by name, creation, start or end date. Use suitedash_get_project for the client, team and economics. GET /projects.
输入参数metapageorder_bycreated_aftercreated_before
suitedash_get_project
Get project
One project with its description, client and secondary clients, teammates, team, leader, economics (estimated value, currency, sector) and custom fields. Find it by UID (default), exact name, a name fragment, or the most recent one. GET /project/{type}/{identifier}.
输入参数metalookupidentifier
suitedash_get_project_fields
Get project field schema
The project field schema of this account: default and custom fields (under their UIDs) with type, required flag and allowed actions. GET /project/meta.
无需输入参数。
suitedash_update_project
Update project
WRITE: update fields of an existing project (found by UID, name, name fragment or most recent); only the fields you pass change. The status must be one of the account's project statuses (see suitedash_get_project_fields). The description and client text accept HTML. PUT /project/{type}/{identifier}.
输入参数namelookupstatusdue_timeend_dateidentifierstart_datebusiness_sectorestimated_valueinfo_descriptioninfo_title_clientproject_custom_fields另有 2 个
suitedash_subscribe_to_marketing
Subscribe contacts to marketing audiences
WRITE: subscribe people (by email) to one or more marketing audiences (numeric audience ids from SuiteDash > Marketing). Unknown emails may be created as marketing contacts. This enrolls real people in email marketing and can start campaigns or automations tied to those audiences: only do it for people who have consented, and only when the user asked. The reply holds the outcome per person. POST /marketing/subscribe.
输入参数subscribers必填
suitedash_list_worlds
List worlds
List the account's Worlds (client groupings), 10 per page. Only available with the WORLDS Power-Up; otherwise SuiteDash answers 403. GET /worlds.
输入参数pageorder_by