Skip to main content
New to Corsair? See API access, authentication, and error handling.

Companies

create

companies.create Create a company, optionally with its first contact in the same call. The role decides what the client portal shows it Risk: write
Input Set primaryContact.create_primary_contact_if_not_exists to create the first contact in the same call; first_name, last_name and email are then required inside it.
Output

get

companies.get Read one company by uid or exact name, with its category, address, primary contact and custom fields Risk: read
Input The identifier is a uid or an exact name; SuiteDash decides which from the value. Set meta to true to also get the paging and custom field definitions. Output

list

companies.list List companies with filters for when they were created, an order, and whether to include the paging and custom field meta Risk: read
Input Output

meta

companies.meta Read the meta attributes of the company custom fields, which is where the uuid keys a write uses come from Risk: read
Input: empty object Read this before writing custom fields: the keys are uuids unique to the account, not field names. Output: object

update

companies.update Change a company’s details, phones, address, tags or custom fields. Only the fields sent change Risk: write
Input Custom fields are keyed by uuid. A response sends them as an array, but a write sends an object keyed by field uuid.
Output

Contacts

create

contacts.create Create a contact. First name, last name, email and role are required, and the role decides portal access. send_welcome_email sends the portal invitation Risk: destructive
Input First name, last name, email and role are all required by the spec, and role decides what the client portal shows them.
Output

get

contacts.get Read one contact by uid or email, with their roles, phones, addresses and custom fields Risk: read
Input The identifier is a uid or an email address, decided from the value. Output

list

contacts.list List contacts with filters for when they were created, an order, and whether to include the meta block Risk: read
Input Output

meta

contacts.meta Read the meta attributes of the contact custom fields, which is where the uuid keys a write uses come from Risk: read
Input: empty object Output: object

update

contacts.update Change a contact’s details, addresses, tags or custom fields, optionally sending the portal welcome email Risk: destructive
Input
Output

Marketing

subscribe

marketing.subscribe Subscribe contacts to marketing audiences, which can start the emails those audiences send. A partial failure throws, with the per-subscriber results on the error body Risk: destructive
Input The body is a bare array. The answer carries one result per subscriber and its top-level success is true only when every one worked, so a partial failure throws rather than looking like success.
Output

Projects

get

projects.get Find one project by uid, exact name, a name fragment, or the most recent one, with its clients, team and custom fields Risk: read
Input The lookup mode is part of the path: uid, name, contains_the_following, or most_recent with identifier “true”. Output

list

projects.list List projects with filters for when they were created, an order, and whether to include the meta block Risk: read
Input Output

meta

projects.meta Read the meta attributes of the project custom fields Risk: read
Input: empty object Output: object

update

projects.update Change a project’s name, status, dates, information text or custom fields. SuiteDash’s update schema is open, so only the documented fields are typed Risk: write
Input Output

Worlds

list

worlds.list List the worlds on the account, which is a Power-up and answers a bare array rather than the CRM list envelope Risk: read
Input Output