Skip to content

Integrations

Monaco

Manage Monaco CRM records, tasks, meetings, and outreach

Monaco is an AI-native revenue platform that combines a CRM, a prospect database, outbound sequencing, and a meeting recorder in one system.

With the Monaco block, you can:

  • Manage CRM records: list, read, create, update, upsert, and delete contacts and accounts, and manage opportunities with their pipeline stage, estimated value, linked contacts, and custom fields
  • Track work: create and update tasks, including email tasks with a draft, and create or list tags for contacts, accounts, and opportunities
  • Read activity: list meetings and read their AI summaries, next actions, and transcripts, and read a contact's or account's email and LinkedIn messages and full conversation threads
  • Run outreach: build audiences from contact IDs or filters, enroll contacts or attach audiences to campaigns, and pause, resume, enqueue, stop, or exclude sequences
  • Discover your workspace: list pipelines and users, and read the filterable and sortable field schemas for each record type

Create an API key in Monaco under Settings > API Keys (it starts with mks_ and is shown once), then add it as a Monaco credential from the block's Monaco Account field. Enrolling contacts, attaching audiences to campaigns, and resuming or enqueuing sequences send real email and LinkedIn messages.

In Sim, the Monaco block lets your agents prepare account briefs before meetings, keep the pipeline clean, turn meeting outcomes into follow-up tasks, and launch outbound to a new segment.

Use the block

Connect a Monaco API key to read and write contacts, accounts, and opportunities, manage tasks and tags, read meetings, transcripts, and email or LinkedIn conversations, and run outreach by building audiences, enrolling contacts in campaigns, and controlling sequences.

Actions

Monaco List Contacts

List Monaco contacts with optional filters, sorting, and pagination.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filtersjsonNoFilters as an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression for nested logic. Conditions include is, is_not, equals, contains, not_contains, is_empty, is_not_empty, is_before, and is_after. Use Get Field Schemas to find filterable fields.
sortstringNoField to sort by; prefix with "-" for descending (e.g. "-created_at"). Defaults to "-created_at".
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 50.
includeCustomFieldsbooleanNoInclude each contact's custom_field_<id> values. Defaults to false; Get Contact always includes them.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
contactsarrayContacts on this page
↳ idstringUnique identifier for the contact
↳ account_idstringID of the associated account
↳ account_namestringDisplay name of the associated account: its user-set name, falling back to the company name, then the account's domain
↳ first_namestringFirst name of the contact
↳ last_namestringLast name of the contact
↳ emailstringEmail address of the contact
↳ titlestringJob title of the contact
↳ phone_numberstringPhone number of the contact
↳ linkedin_urlstringLinkedIn profile URL
↳ locationstringLocation of the contact
↳ countrystringCountry of the contact
↳ job_start_datestringStart date of the contact's current job (YYYY-MM-DD)
↳ sourcestringSource from which the contact was added
↳ do_not_contactbooleanWhether the contact has opted out of outreach
↳ notesstringNotes about the contact
↳ scoringobjectContact scoring information
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the contact
↳ created_atstringWhen the contact was created (ISO 8601)
↳ updated_atstringWhen the contact was last updated (ISO 8601)
↳ last_activity_atstringWhen the contact's most recent activity (inbound or outbound) happened
↳ last_activity_typestringType of the contact's most recent activity
↳ last_outbound_atstringWhen the most recent outbound interaction with the contact happened
↳ last_outbound_typestringType of the most recent outbound interaction with the contact
↳ last_inbound_atstringWhen the most recent inbound interaction from the contact happened
↳ last_inbound_typestringType of the most recent inbound interaction from the contact
↳ custom_fieldsjsonCustom field values keyed by their custom_field_<id> key. Use Get Field Schemas to see what each key means.

Monaco Get Contact

Get one Monaco contact by ID, including scoring, heat score explanations, and custom fields.

Inputs and outputs

Input

ParameterTypeRequiredDescription
contactIdstringYesID of the contact to fetch
includeReasoningbooleanNoReturn each custom field as {value, reasoning, confidence, citations} instead of the bare value. Defaults to false.

Output

ParameterTypeDescription
contactobjectThe contact
↳ idstringUnique identifier for the contact
↳ account_idstringID of the associated account
↳ account_namestringDisplay name of the associated account: its user-set name, falling back to the company name, then the account's domain
↳ first_namestringFirst name of the contact
↳ last_namestringLast name of the contact
↳ emailstringEmail address of the contact
↳ titlestringJob title of the contact
↳ phone_numberstringPhone number of the contact
↳ linkedin_urlstringLinkedIn profile URL
↳ locationstringLocation of the contact
↳ countrystringCountry of the contact
↳ job_start_datestringStart date of the contact's current job (YYYY-MM-DD)
↳ sourcestringSource from which the contact was added
↳ do_not_contactbooleanWhether the contact has opted out of outreach
↳ notesstringNotes about the contact
↳ scoringobjectContact scoring information
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the contact
↳ created_atstringWhen the contact was created (ISO 8601)
↳ updated_atstringWhen the contact was last updated (ISO 8601)
↳ last_activity_atstringWhen the contact's most recent activity (inbound or outbound) happened
↳ last_activity_typestringType of the contact's most recent activity
↳ last_outbound_atstringWhen the most recent outbound interaction with the contact happened
↳ last_outbound_typestringType of the most recent outbound interaction with the contact
↳ last_inbound_atstringWhen the most recent inbound interaction from the contact happened
↳ last_inbound_typestringType of the most recent inbound interaction from the contact
↳ custom_fieldsjsonCustom field values keyed by their custom_field_<id> key. Use Get Field Schemas to see what each key means.
↳ heat_score_explanationobjectPer-signal explanations behind the heat score tier

Monaco Create Contact

Create a Monaco contact from an email or LinkedIn URL. Monaco enriches the contact and resolves or creates its account, which can take several seconds. A duplicate email or LinkedIn URL is rejected; use Upsert Contact to update a match instead.

Inputs and outputs

Input

ParameterTypeRequiredDescription
emailstringNoEmail address of the contact (max 255 characters). Either email or LinkedIn URL is required.
linkedinUrlstringNoLinkedIn profile URL (a linkedin.com/in/... URL). Either email or LinkedIn URL is required; with only a LinkedIn URL, also pass an account ID or domain.
firstNamestringNoFirst name of the contact (max 256 characters)
lastNamestringNoLast name of the contact (max 256 characters)
titlestringNoJob title of the contact
phoneNumberstringNoPhone number of the contact
locationstringNoLocation of the contact (max 256 characters)
accountIdstringNoID of the account to associate the contact with. Takes priority over domain, then the domain parsed from email, when resolving the account.
domainstringNoDomain of the contact's company, used to resolve its account
doNotContactbooleanNoWhether the contact has opted out of outreach
notesstringNoNotes about the contact (max 1,125,000 characters)
tagsarrayNoTag IDs for the contact, as an array or comma-separated list. When the request matches an existing contact, replaces its existing tags.
isInboundbooleanNoWhether the contact is an inbound lead. When true and the request creates a new contact, Monaco records it as a captured inbound lead. Ignored when the request matches an existing contact. Defaults to false.
customFieldsjsonNoCustom field values as a JSON object keyed by custom_field_<id> (e.g. {"custom_field_1a2b...": "economic_buyer"}). Use Get Field Schemas to find the keys.

Output

ParameterTypeDescription
contactobjectThe created contact
↳ idstringUnique identifier for the contact
↳ account_idstringID of the associated account
↳ account_namestringDisplay name of the associated account: its user-set name, falling back to the company name, then the account's domain
↳ first_namestringFirst name of the contact
↳ last_namestringLast name of the contact
↳ emailstringEmail address of the contact
↳ titlestringJob title of the contact
↳ phone_numberstringPhone number of the contact
↳ linkedin_urlstringLinkedIn profile URL
↳ locationstringLocation of the contact
↳ countrystringCountry of the contact
↳ job_start_datestringStart date of the contact's current job (YYYY-MM-DD)
↳ sourcestringSource from which the contact was added
↳ do_not_contactbooleanWhether the contact has opted out of outreach
↳ notesstringNotes about the contact
↳ scoringobjectContact scoring information
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the contact
↳ created_atstringWhen the contact was created (ISO 8601)
↳ updated_atstringWhen the contact was last updated (ISO 8601)
↳ last_activity_atstringWhen the contact's most recent activity (inbound or outbound) happened
↳ last_activity_typestringType of the contact's most recent activity
↳ last_outbound_atstringWhen the most recent outbound interaction with the contact happened
↳ last_outbound_typestringType of the most recent outbound interaction with the contact
↳ last_inbound_atstringWhen the most recent inbound interaction from the contact happened
↳ last_inbound_typestringType of the most recent inbound interaction from the contact
↳ custom_fieldsjsonCustom field values keyed by their custom_field_<id> key. Use Get Field Schemas to see what each key means.
↳ enrichment_statusstringHow enriching the contact from its identifiers ended: enriched; not_found, when no person matches them; or failed, when the lookup errored or timed out and the contact was saved with only the fields sent

Monaco Update Contact

Update fields on an existing Monaco contact by ID. Only the fields sent change.

Inputs and outputs

Input

ParameterTypeRequiredDescription
contactIdstringYesID of the contact to update
firstNamestringNoFirst name of the contact (max 256 characters)
lastNamestringNoLast name of the contact (max 256 characters)
emailstringNoEmail address of the contact (max 255 characters)
titlestringNoJob title of the contact
phoneNumberstringNoPhone number of the contact
linkedinUrlstringNoLinkedIn profile URL (a linkedin.com/in/... URL)
locationstringNoLocation of the contact (max 256 characters)
notesstringNoNotes about the contact (max 1,125,000 characters)
doNotContactbooleanNoWhether the contact has opted out of outreach
tagsarrayNoTag IDs for the contact, as an array or comma-separated list. Replaces the contact's existing tags; send [] to remove them all.
countrystringNoCountry of the contact, as a country name or code (max 128 characters)
jobStartDatestringNoStart date of the contact's current job (YYYY-MM-DD)
clearFieldsarrayNoFields to clear on the contact, as an array or comma-separated list. Allowed: first_name, last_name, email, title, phone_number, linkedin_url, notes.
customFieldsjsonNoCustom field values to set, as a JSON object keyed by custom_field_&lt;id&gt; (e.g. {"custom_field_<id>": "value"}). Custom fields are always updatable; use Get Field Schemas to find the keys.

Output

ParameterTypeDescription
contactobjectThe updated contact
↳ idstringUnique identifier for the contact
↳ account_idstringID of the associated account
↳ account_namestringDisplay name of the associated account: its user-set name, falling back to the company name, then the account's domain
↳ first_namestringFirst name of the contact
↳ last_namestringLast name of the contact
↳ emailstringEmail address of the contact
↳ titlestringJob title of the contact
↳ phone_numberstringPhone number of the contact
↳ linkedin_urlstringLinkedIn profile URL
↳ locationstringLocation of the contact
↳ countrystringCountry of the contact
↳ job_start_datestringStart date of the contact's current job (YYYY-MM-DD)
↳ sourcestringSource from which the contact was added
↳ do_not_contactbooleanWhether the contact has opted out of outreach
↳ notesstringNotes about the contact
↳ scoringobjectContact scoring information
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the contact
↳ created_atstringWhen the contact was created (ISO 8601)
↳ updated_atstringWhen the contact was last updated (ISO 8601)
↳ last_activity_atstringWhen the contact's most recent activity (inbound or outbound) happened
↳ last_activity_typestringType of the contact's most recent activity
↳ last_outbound_atstringWhen the most recent outbound interaction with the contact happened
↳ last_outbound_typestringType of the most recent outbound interaction with the contact
↳ last_inbound_atstringWhen the most recent inbound interaction from the contact happened
↳ last_inbound_typestringType of the most recent inbound interaction from the contact
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.

Monaco Upsert Contact

Create a Monaco contact or update the one matching its email (case-insensitive), then LinkedIn URL. Pass a contact ID instead to update that contact by ID, which is how to change its email. Creating a contact enriches it and can take several seconds.

Inputs and outputs

Input

ParameterTypeRequiredDescription
emailstringNoEmail address of the contact (max 255 characters). Either email or LinkedIn URL is required.
linkedinUrlstringNoLinkedIn profile URL (a linkedin.com/in/... URL). Either email or LinkedIn URL is required; with only a LinkedIn URL, also pass an account ID or domain.
firstNamestringNoFirst name of the contact (max 256 characters)
lastNamestringNoLast name of the contact (max 256 characters)
titlestringNoJob title of the contact
phoneNumberstringNoPhone number of the contact
locationstringNoLocation of the contact (max 256 characters)
accountIdstringNoID of the account to associate the contact with. Takes priority over domain, then the domain parsed from email, when resolving the account.
domainstringNoDomain of the contact's company, used to resolve its account
doNotContactbooleanNoWhether the contact has opted out of outreach
notesstringNoNotes about the contact (max 1,125,000 characters)
tagsarrayNoTag IDs for the contact, as an array or comma-separated list. When the request matches an existing contact, replaces its existing tags.
isInboundbooleanNoWhether the contact is an inbound lead. When true and the request creates a new contact, Monaco records it as a captured inbound lead. Ignored when the request matches an existing contact. Defaults to false.
customFieldsjsonNoCustom field values as a JSON object keyed by custom_field_&lt;id&gt; (e.g. {"custom_field_1a2b...": "economic_buyer"}). Use Get Field Schemas to find the keys.
idstringNoID of an existing contact to update by ID instead of matching by email or LinkedIn URL; it is never created, and an unknown ID fails. Cannot be combined with account ID, domain, location, or inbound.
clearFieldsarrayNoFields to clear on the contact, as an array or comma-separated list. Only applies with a contact ID. Allowed: first_name, last_name, email, title, phone_number, linkedin_url, notes.

Output

ParameterTypeDescription
contactobjectThe created or updated contact
↳ idstringUnique identifier for the contact
↳ account_idstringID of the associated account
↳ account_namestringDisplay name of the associated account: its user-set name, falling back to the company name, then the account's domain
↳ first_namestringFirst name of the contact
↳ last_namestringLast name of the contact
↳ emailstringEmail address of the contact
↳ titlestringJob title of the contact
↳ phone_numberstringPhone number of the contact
↳ linkedin_urlstringLinkedIn profile URL
↳ locationstringLocation of the contact
↳ countrystringCountry of the contact
↳ job_start_datestringStart date of the contact's current job (YYYY-MM-DD)
↳ sourcestringSource from which the contact was added
↳ do_not_contactbooleanWhether the contact has opted out of outreach
↳ notesstringNotes about the contact
↳ scoringobjectContact scoring information
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the contact
↳ created_atstringWhen the contact was created (ISO 8601)
↳ updated_atstringWhen the contact was last updated (ISO 8601)
↳ last_activity_atstringWhen the contact's most recent activity (inbound or outbound) happened
↳ last_activity_typestringType of the contact's most recent activity
↳ last_outbound_atstringWhen the most recent outbound interaction with the contact happened
↳ last_outbound_typestringType of the most recent outbound interaction with the contact
↳ last_inbound_atstringWhen the most recent inbound interaction from the contact happened
↳ last_inbound_typestringType of the most recent inbound interaction from the contact
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.
↳ enrichment_statusstringHow enriching the contact from its identifiers ended: enriched; not_found, when no person matches them; or failed, when the lookup errored or timed out and the contact was saved with only the fields sent

Monaco Delete Contact

Permanently delete a Monaco contact. This cannot be undone.

Inputs and outputs

Input

ParameterTypeRequiredDescription
contactIdstringYesID of the contact to delete

Output

ParameterTypeDescription
idstringID of the deleted contact
deletedbooleanWhether Monaco deleted the contact

Monaco List Accounts

List Monaco accounts with optional filters, sorting, and pagination.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filtersjsonNoFilters as an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression for nested logic. Conditions include is, is_not, equals, contains, not_contains, is_empty, is_not_empty, is_before, and is_after. Use Get Field Schemas to find filterable fields.
sortstringNoField to sort by; prefix with "-" for descending (e.g. "-created_at"). Defaults to "-created_at".
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 50.
includeCustomFieldsbooleanNoInclude each account's custom_field_&lt;id&gt; values. Defaults to false; Get Account always includes them.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
accountsarrayAccounts on this page
↳ idstringUnique identifier for the account
↳ namestringName of the account
↳ statusstringCurrent status of the account
↳ ownerobjectUser who owns the account
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ parent_accountobjectAccount this account is a sub-account of
↳ idstringUnique identifier of the parent account
↳ namestringName of the parent account
↳ notesstringNotes about the account
↳ domainsarrayThe account's own domains, primary first
↳ companyobjectCompany information associated with the account
↳ domainstringThe account's primary domain: the first entry of the account's domains list
↳ linkedin_urlstringLinkedIn company page URL
↳ descriptionstringCompany description
↳ employee_countnumberNumber of employees
↳ founded_yearnumberYear the company was founded
↳ industriesarrayIndustry classifications
↳ total_funding_usdnumberTotal funding raised in USD
↳ last_funding_datestringDate of the most recent funding round
↳ company_namestringCompany name
↳ estimated_annual_revenue_usdnumberEstimated annual revenue in USD
↳ last_funding_roundstringType of the most recent funding round
↳ business_modelstringBusiness model
↳ company_statusstringOperating status of the company
↳ locationstringHeadquarters as "city, state, country"
↳ overridden_fieldsarrayFields set by a user. Company data updates don't overwrite them
↳ scoringobjectAccount scoring information
↳ tierstringFirmographic tier
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the account
↳ created_atstringWhen the account was created (ISO 8601)
↳ updated_atstringWhen the account was last updated (ISO 8601)
↳ last_activity_atstringWhen the most recent activity (inbound or outbound) across the account's contacts happened
↳ last_activity_typestringType of the account's most recent contact activity
↳ last_contacted_atstringWhen the most recent outbound interaction with the account's contacts happened
↳ last_contacted_typestringType of the most recent outbound interaction with the account's contacts
↳ last_inbound_atstringWhen the most recent inbound interaction from the account's contacts happened
↳ last_inbound_typestringType of the most recent inbound interaction from the account's contacts
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.

Monaco Get Account

Get one Monaco account by ID, including enriched company information, scoring, heat score explanations, and custom fields.

Inputs and outputs

Input

ParameterTypeRequiredDescription
accountIdstringYesID of the account to fetch
includeReasoningbooleanNoReturn each custom field as {value, reasoning, confidence, citations} instead of the bare value. Defaults to false.

Output

ParameterTypeDescription
accountobjectThe account
↳ idstringUnique identifier for the account
↳ namestringName of the account
↳ statusstringCurrent status of the account
↳ ownerobjectUser who owns the account
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ parent_accountobjectAccount this account is a sub-account of
↳ idstringUnique identifier of the parent account
↳ namestringName of the parent account
↳ notesstringNotes about the account
↳ domainsarrayThe account's own domains, primary first
↳ companyobjectCompany information associated with the account
↳ domainstringThe account's primary domain: the first entry of the account's domains list
↳ linkedin_urlstringLinkedIn company page URL
↳ descriptionstringCompany description
↳ employee_countnumberNumber of employees
↳ founded_yearnumberYear the company was founded
↳ industriesarrayIndustry classifications
↳ total_funding_usdnumberTotal funding raised in USD
↳ last_funding_datestringDate of the most recent funding round
↳ company_namestringCompany name
↳ estimated_annual_revenue_usdnumberEstimated annual revenue in USD
↳ last_funding_roundstringType of the most recent funding round
↳ business_modelstringBusiness model
↳ company_statusstringOperating status of the company
↳ locationstringHeadquarters as "city, state, country"
↳ overridden_fieldsarrayFields set by a user. Company data updates don't overwrite them
↳ scoringobjectAccount scoring information
↳ tierstringFirmographic tier
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the account
↳ created_atstringWhen the account was created (ISO 8601)
↳ updated_atstringWhen the account was last updated (ISO 8601)
↳ last_activity_atstringWhen the most recent activity (inbound or outbound) across the account's contacts happened
↳ last_activity_typestringType of the account's most recent contact activity
↳ last_contacted_atstringWhen the most recent outbound interaction with the account's contacts happened
↳ last_contacted_typestringType of the most recent outbound interaction with the account's contacts
↳ last_inbound_atstringWhen the most recent inbound interaction from the account's contacts happened
↳ last_inbound_typestringType of the most recent inbound interaction from the account's contacts
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.
↳ heat_score_explanationobjectPer-signal explanations behind the heat score tier

Monaco Upsert Account

Create a Monaco account or update the one whose domain exactly matches the domain lookup. Pass an account ID instead to update that account by ID, or only a name to create an account without a domain where the workspace allows it. Creating an account enriches it with firmographic data and can take several seconds.

Inputs and outputs

Input

ParameterTypeRequiredDescription
domainLookupstringNoDomain used to find the account, or to create it if none matches (a company record for the domain must exist in Monaco). Omit it to create an account from the name alone, where the workspace allows accounts without a company; every such call creates a new account. Not allowed with an account ID.
idstringNoID of an existing account to update by ID instead of matching by domain lookup; it is never created, and an unknown ID fails. Requires a user-scoped API key.
namestringNoDisplay name for the account (max 256 characters)
statusstringNoAccount status (max 64 characters). Suggested values: NEW, PROSPECTING, OPPORTUNITY, CUSTOMER, DISQUALIFIED, NURTURE, INBOUND, CHURNED; any string is accepted.
notesstringNoNotes about the account (max 1,125,000 characters)
ownerstringNoUser ID to assign as account owner
parentAccountstringNoAccount ID to set as this account's parent. The parent must be a top-level account in the same workspace.
companyIdstringNoID of the company to link to the account
replaceEditedFieldsbooleanNoAlso replace fields a user has edited, including edited domains, when linking a company. Defaults to false.
linkedinUrlstringNoLinkedIn company page URL for matching or creating the account
descriptionstringNoCompany description (max 8192 characters)
employeeCountnumberNoNumber of employees (0 or more)
foundedYearnumberNoYear the company was founded
estimatedAnnualRevenueUsdnumberNoEstimated annual revenue in USD (0 or more)
totalFundingUsdnumberNoTotal funding raised in USD (0 or more)
lastFundingRoundstringNoType of the most recent funding round. One of: pre_seed, seed, angel, series_a, series_b, series_c, series_d, series_e, series_f, series_g, series_h, series_i, series_j, series_unknown, private_equity, debt_financing, convertible_note, grant, non_equity_assistance, corporate_round, equity_crowdfunding, product_crowdfunding, initial_coin_offering, secondary_market, post_ipo_equity, post_ipo_debt, post_ipo_secondary, undisclosed.
lastFundingDatestringNoDate of the most recent funding round (YYYY-MM-DD)
industriesarrayNoIndustries from Monaco's standard list (each max 128 characters), as an array or comma-separated list. Replaces the current list.
businessModelstringNoBusiness model. One of: B2B, B2C.
companyStatusstringNoOperating status of the company. One of: active, acquired, out_of_business, ipo, unknown.
locationstringNoHeadquarters as "city, state, country"
tagsarrayNoTag IDs to associate with the account, as an array or comma-separated list. Appended to the account's existing tags.
domainsarrayNoThe account's full ordered list of domains, primary first, as an array or comma-separated list (max 500). Only applies with an account ID. Send [] to remove them all.
resetFieldsarrayNoCompany fields to reset to the linked company's value, as an array or comma-separated list. Only applies with an account ID. Allowed: linkedin_url, description, employee_count, founded_year, estimated_annual_revenue_usd, total_funding_usd, last_funding_round, last_funding_date, industries, business_model, company_status, location, domains.
clearFieldsarrayNoFields to clear on the account, as an array or comma-separated list. Only applies with an account ID; list company_id to unlink the company. Allowed: name, notes, owner, parent_account, company_id, linkedin_url, description, employee_count, founded_year, estimated_annual_revenue_usd, total_funding_usd, last_funding_round, last_funding_date, industries, business_model, company_status, location.
customFieldsjsonNoCustom field values as a JSON object keyed by custom_field_&lt;id&gt; (e.g. {"custom_field_7a1c...": "high"}). Use Get Field Schemas to find the keys.

Output

ParameterTypeDescription
accountobjectThe created or updated account
↳ idstringUnique identifier for the account
↳ namestringName of the account
↳ statusstringCurrent status of the account
↳ ownerobjectUser who owns the account
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ parent_accountobjectAccount this account is a sub-account of
↳ idstringUnique identifier of the parent account
↳ namestringName of the parent account
↳ notesstringNotes about the account
↳ domainsarrayThe account's own domains, primary first
↳ companyobjectCompany information associated with the account
↳ domainstringThe account's primary domain: the first entry of the account's domains list
↳ linkedin_urlstringLinkedIn company page URL
↳ descriptionstringCompany description
↳ employee_countnumberNumber of employees
↳ founded_yearnumberYear the company was founded
↳ industriesarrayIndustry classifications
↳ total_funding_usdnumberTotal funding raised in USD
↳ last_funding_datestringDate of the most recent funding round
↳ company_namestringCompany name
↳ estimated_annual_revenue_usdnumberEstimated annual revenue in USD
↳ last_funding_roundstringType of the most recent funding round
↳ business_modelstringBusiness model
↳ company_statusstringOperating status of the company
↳ locationstringHeadquarters as "city, state, country"
↳ overridden_fieldsarrayFields set by a user. Company data updates don't overwrite them
↳ scoringobjectAccount scoring information
↳ tierstringFirmographic tier
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the account
↳ created_atstringWhen the account was created (ISO 8601)
↳ updated_atstringWhen the account was last updated (ISO 8601)
↳ last_activity_atstringWhen the most recent activity (inbound or outbound) across the account's contacts happened
↳ last_activity_typestringType of the account's most recent contact activity
↳ last_contacted_atstringWhen the most recent outbound interaction with the account's contacts happened
↳ last_contacted_typestringType of the most recent outbound interaction with the account's contacts
↳ last_inbound_atstringWhen the most recent inbound interaction from the account's contacts happened
↳ last_inbound_typestringType of the most recent inbound interaction from the account's contacts
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.
↳ skipped_domainsarrayCompany websites not added because another account uses them
↳ domainstringThe domain that was rejected
↳ reasonstringWhy it was rejected: conflict (another account uses it), invalid (not a domain), consumer (a consumer email domain such as gmail.com) or own_org (your own organization domain)
↳ account_idstringFor a conflict, the ID of the account that already uses the domain
↳ account_namestringFor a conflict, the name of the account that already uses the domain

Monaco Update Account

Update fields on an existing Monaco account by ID. Only the fields sent change. Domains replace the account's whole domain list, and a domain another account already uses fails the request.

Inputs and outputs

Input

ParameterTypeRequiredDescription
accountIdstringYesID of the account to update
namestringNoDisplay name for the account (max 256 characters)
statusstringNoAccount status (max 64 characters). Suggested values: NEW, PROSPECTING, OPPORTUNITY, CUSTOMER, DISQUALIFIED, NURTURE, INBOUND, CHURNED; any string is accepted.
notesstringNoNotes about the account (max 1,125,000 characters)
ownerstringNoUser ID to assign as account owner
parentAccountstringNoAccount ID to set as this account's parent. The parent must be a top-level account in the same workspace.
companyIdstringNoID of the company to link to the account
replaceEditedFieldsbooleanNoAlso replace fields a user has edited, including edited domains, when linking a company. Defaults to false.
linkedinUrlstringNoLinkedIn company page URL
descriptionstringNoCompany description (max 8192 characters)
employeeCountnumberNoNumber of employees (0 or more)
foundedYearnumberNoYear the company was founded
estimatedAnnualRevenueUsdnumberNoEstimated annual revenue in USD (0 or more)
totalFundingUsdnumberNoTotal funding raised in USD (0 or more)
lastFundingRoundstringNoType of the most recent funding round. One of: pre_seed, seed, angel, series_a, series_b, series_c, series_d, series_e, series_f, series_g, series_h, series_i, series_j, series_unknown, private_equity, debt_financing, convertible_note, grant, non_equity_assistance, corporate_round, equity_crowdfunding, product_crowdfunding, initial_coin_offering, secondary_market, post_ipo_equity, post_ipo_debt, post_ipo_secondary, undisclosed.
lastFundingDatestringNoDate of the most recent funding round (YYYY-MM-DD)
industriesarrayNoIndustries from Monaco's standard list (each max 128 characters), as an array or comma-separated list. Replaces the current list.
businessModelstringNoBusiness model. One of: B2B, B2C.
companyStatusstringNoOperating status of the company. One of: active, acquired, out_of_business, ipo, unknown.
locationstringNoHeadquarters as "city, state, country"
tagsarrayNoTag IDs for the account, as an array or comma-separated list. Replaces the account's existing tags; send [] to remove them all.
domainsarrayNoThe account's complete list of domains, primary first, as an array or comma-separated list (max 500). Replaces the whole list: domains left out are removed. Send [] to remove them all.
resetFieldsarrayNoCompany fields to reset to the linked company's value, as an array or comma-separated list; later company updates fill them again. Allowed: linkedin_url, description, employee_count, founded_year, estimated_annual_revenue_usd, total_funding_usd, last_funding_round, last_funding_date, industries, business_model, company_status, location, domains.
clearFieldsarrayNoFields to clear on the account, as an array or comma-separated list. Clearing parent_account makes the account top-level and clearing company_id unlinks its company. Allowed: name, notes, owner, parent_account, company_id, linkedin_url, description, employee_count, founded_year, estimated_annual_revenue_usd, total_funding_usd, last_funding_round, last_funding_date, industries, business_model, company_status, location.
customFieldsjsonNoCustom field values to set, as a JSON object keyed by custom_field_&lt;id&gt; (e.g. {"custom_field_<id>": "value"}). Custom fields are always updatable; use Get Field Schemas to find the keys.

Output

ParameterTypeDescription
accountobjectThe updated account
↳ idstringUnique identifier for the account
↳ namestringName of the account
↳ statusstringCurrent status of the account
↳ ownerobjectUser who owns the account
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ parent_accountobjectAccount this account is a sub-account of
↳ idstringUnique identifier of the parent account
↳ namestringName of the parent account
↳ notesstringNotes about the account
↳ domainsarrayThe account's own domains, primary first
↳ companyobjectCompany information associated with the account
↳ domainstringThe account's primary domain: the first entry of the account's domains list
↳ linkedin_urlstringLinkedIn company page URL
↳ descriptionstringCompany description
↳ employee_countnumberNumber of employees
↳ founded_yearnumberYear the company was founded
↳ industriesarrayIndustry classifications
↳ total_funding_usdnumberTotal funding raised in USD
↳ last_funding_datestringDate of the most recent funding round
↳ company_namestringCompany name
↳ estimated_annual_revenue_usdnumberEstimated annual revenue in USD
↳ last_funding_roundstringType of the most recent funding round
↳ business_modelstringBusiness model
↳ company_statusstringOperating status of the company
↳ locationstringHeadquarters as "city, state, country"
↳ overridden_fieldsarrayFields set by a user. Company data updates don't overwrite them
↳ scoringobjectAccount scoring information
↳ tierstringFirmographic tier
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the account
↳ created_atstringWhen the account was created (ISO 8601)
↳ updated_atstringWhen the account was last updated (ISO 8601)
↳ last_activity_atstringWhen the most recent activity (inbound or outbound) across the account's contacts happened
↳ last_activity_typestringType of the account's most recent contact activity
↳ last_contacted_atstringWhen the most recent outbound interaction with the account's contacts happened
↳ last_contacted_typestringType of the most recent outbound interaction with the account's contacts
↳ last_inbound_atstringWhen the most recent inbound interaction from the account's contacts happened
↳ last_inbound_typestringType of the most recent inbound interaction from the account's contacts
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.
↳ skipped_domainsarrayCompany websites not added because another account uses them
↳ domainstringThe domain that was rejected
↳ reasonstringWhy it was rejected: conflict (another account uses it), invalid (not a domain), consumer (a consumer email domain such as gmail.com) or own_org (your own organization domain)
↳ account_idstringFor a conflict, the ID of the account that already uses the domain
↳ account_namestringFor a conflict, the name of the account that already uses the domain

Monaco Delete Account

Permanently delete a Monaco account. This cannot be undone. Its contacts and opportunities are not deleted but may become unlinked.

Inputs and outputs

Input

ParameterTypeRequiredDescription
accountIdstringYesID of the account to delete

Output

ParameterTypeDescription
idstringID of the deleted account
deletedbooleanWhether Monaco deleted the account

Monaco List Opportunities

List Monaco opportunities with optional filters, sorting, pagination, and a pipeline scope.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filtersjsonNoFilters as an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression for nested logic. Conditions include is, is_not, equals, contains, not_contains, is_empty, is_not_empty, is_before, and is_after. Use Get Field Schemas to find filterable fields.
sortstringNoField to sort by; prefix with "-" for descending (e.g. "-created_at"). Defaults to "-created_at".
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 50.
pipelineIdstringNoReturn only opportunities in this pipeline (see List Pipelines). If omitted, opportunities in every pipeline are returned. Stage keys in a stage filter are this pipeline's, or the default pipeline's when omitted; a stage filter also takes stage IDs.
includeCustomFieldsbooleanNoInclude each opportunity's custom_field_&lt;id&gt; values. Defaults to true; set false for leaner responses. Get Opportunity always includes them.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
opportunitiesarrayOpportunities on this page
↳ idstringUnique identifier for the opportunity
↳ account_idstringID of the associated account
↳ namestringName of the opportunity
↳ ownerobjectUser who owns the opportunity
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ stagestringCurrent pipeline stage key of the opportunity
↳ stage_idstringID of the opportunity's stage within its pipeline
↳ pipeline_idstringID of the pipeline the opportunity is in
↳ pipeline_namestringName of the pipeline the opportunity is in
↳ estimated_valueobjectEstimated monetary value of the opportunity
↳ currency_codestringISO 4217 currency code
↳ amountnumberDeprecated: prefer amount_precise. Whole units of the currency.
↳ amount_precisenumberEstimated value as a decimal amount of the specified currency
↳ estimated_close_datestringExpected close date for the opportunity
↳ actual_close_datestringActual date the opportunity was closed
↳ summarystringAI-generated summary of the opportunity
↳ risksarrayIdentified risks for the opportunity
↳ notesstringNotes about the opportunity
↳ tagsarrayTag names associated with the opportunity
↳ contact_idsarrayIDs of contacts linked to the opportunity
↳ last_activity_atstringWhen the last activity on the opportunity happened (ISO 8601)
↳ updated_atstringWhen the opportunity was last updated (ISO 8601)
↳ created_atstringWhen the opportunity was created (ISO 8601)
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.

Monaco Get Opportunity

Get one Monaco opportunity by ID, including its AI-generated summary, identified risks, stage, pipeline, and custom fields.

Inputs and outputs

Input

ParameterTypeRequiredDescription
opportunityIdstringYesID of the opportunity to fetch
includeReasoningbooleanNoReturn each custom field as {value, reasoning, confidence, citations} instead of the bare value. Defaults to false.

Output

ParameterTypeDescription
opportunityobjectThe opportunity
↳ idstringUnique identifier for the opportunity
↳ account_idstringID of the associated account
↳ namestringName of the opportunity
↳ ownerobjectUser who owns the opportunity
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ stagestringCurrent pipeline stage key of the opportunity
↳ stage_idstringID of the opportunity's stage within its pipeline
↳ pipeline_idstringID of the pipeline the opportunity is in
↳ pipeline_namestringName of the pipeline the opportunity is in
↳ estimated_valueobjectEstimated monetary value of the opportunity
↳ currency_codestringISO 4217 currency code
↳ amountnumberDeprecated: prefer amount_precise. Whole units of the currency.
↳ amount_precisenumberEstimated value as a decimal amount of the specified currency
↳ estimated_close_datestringExpected close date for the opportunity
↳ actual_close_datestringActual date the opportunity was closed
↳ summarystringAI-generated summary of the opportunity
↳ risksarrayIdentified risks for the opportunity
↳ notesstringNotes about the opportunity
↳ tagsarrayTag names associated with the opportunity
↳ contact_idsarrayIDs of contacts linked to the opportunity
↳ last_activity_atstringWhen the last activity on the opportunity happened (ISO 8601)
↳ updated_atstringWhen the opportunity was last updated (ISO 8601)
↳ created_atstringWhen the opportunity was created (ISO 8601)
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.

Monaco Create Opportunity

Create a Monaco opportunity on an existing account, optionally setting its pipeline, stage, owner, estimated value, close date, tags, and custom fields.

Inputs and outputs

Input

ParameterTypeRequiredDescription
namestringYesName of the opportunity
accountIdstringYesID of the account to associate the opportunity with
pipelineIdstringNoPipeline to create the opportunity in (see List Pipelines). If omitted, the organization's default pipeline is used.
stagestringNoStage key for the opportunity within its pipeline (up to 64 characters; see List Pipelines). If omitted, the opportunity is placed in the first stage of that pipeline.
stageIdstringNoStage ID (from List Pipelines), instead of a stage key; provide either stage or stageId, not both. It names the pipeline too, so a pipeline ID, if given, must be that stage's pipeline.
ownerUserIdstringNoUser ID to assign as the opportunity owner
amountnumberNoEstimated value as a decimal amount of the currency (e.g. 50000.25). Set together with currencyCode.
currencyCodestringNoISO 4217 currency code of the estimated value (e.g. USD), up to 8 characters. Set together with amount.
estimatedCloseDatestringNoExpected close date (YYYY-MM-DD)
notesstringNoNotes about the opportunity
tagsarrayNoTag IDs to associate with the opportunity, as an array or comma-separated list
customFieldsjsonNoCustom field values as a JSON object keyed by custom_field_&lt;id&gt; (e.g. {"custom_field_<id>": "outbound"}). Use Get Field Schemas to find the keys.
idempotencyKeystringNoClient-provided UUID that prevents duplicate creation. Reusing a key returns a duplicate_opportunity error naming the opportunity it already created.

Output

ParameterTypeDescription
opportunityobjectThe created opportunity
↳ idstringUnique identifier for the opportunity
↳ account_idstringID of the associated account
↳ namestringName of the opportunity
↳ ownerobjectUser who owns the opportunity
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ stagestringCurrent pipeline stage key of the opportunity
↳ stage_idstringID of the opportunity's stage within its pipeline
↳ pipeline_idstringID of the pipeline the opportunity is in
↳ pipeline_namestringName of the pipeline the opportunity is in
↳ estimated_valueobjectEstimated monetary value of the opportunity
↳ currency_codestringISO 4217 currency code
↳ amountnumberDeprecated: prefer amount_precise. Whole units of the currency.
↳ amount_precisenumberEstimated value as a decimal amount of the specified currency
↳ estimated_close_datestringExpected close date for the opportunity
↳ actual_close_datestringActual date the opportunity was closed
↳ summarystringAI-generated summary of the opportunity
↳ risksarrayIdentified risks for the opportunity
↳ notesstringNotes about the opportunity
↳ tagsarrayTag names associated with the opportunity
↳ contact_idsarrayIDs of contacts linked to the opportunity
↳ last_activity_atstringWhen the last activity on the opportunity happened (ISO 8601)
↳ updated_atstringWhen the opportunity was last updated (ISO 8601)
↳ created_atstringWhen the opportunity was created (ISO 8601)
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.

Monaco Update Opportunity

Update a Monaco opportunity: rename it, change its owner, move it to another stage or pipeline, or set its estimated value, close dates, notes, or tags. Only the fields you set are changed.

Inputs and outputs

Input

ParameterTypeRequiredDescription
opportunityIdstringYesID of the opportunity to update
namestringNoNew name of the opportunity
pipelineIdstringNoPipeline to move the opportunity to (see List Pipelines). The stage key then names a stage in that pipeline; if no stage is given, an open opportunity lands on the pipeline's first active stage and a closed one on its first closed stage with the same outcome. If omitted, the opportunity stays in its pipeline.
stagestringNoStage key for the opportunity within its pipeline (up to 64 characters; see List Pipelines)
stageIdstringNoStage ID (from List Pipelines), instead of a stage key; provide either stage or stageId, not both. A stage of the opportunity's own pipeline changes its stage; a stage of another pipeline moves the opportunity there.
ownerUserIdstringNoUser ID to assign as the opportunity owner
amountnumberNoEstimated value as a decimal amount of the currency (e.g. 50000.25). Set together with currencyCode.
currencyCodestringNoISO 4217 currency code of the estimated value (e.g. USD), up to 8 characters. Set together with amount.
estimatedCloseDatestringNoExpected close date (YYYY-MM-DD)
actualCloseDatestringNoActual date the opportunity was closed (YYYY-MM-DD)
notesstringNoNotes about the opportunity
tagsarrayNoTag IDs for the opportunity, as an array or comma-separated list. Replaces the opportunity's existing tags; send [] to remove them all.
customFieldsjsonNoCustom field values to set, as a JSON object keyed by custom_field_&lt;id&gt; (e.g. {"custom_field_<id>": "value"}). Custom fields are always updatable; use Get Field Schemas to find the keys.

Output

ParameterTypeDescription
opportunityobjectThe updated opportunity
↳ idstringUnique identifier for the opportunity
↳ account_idstringID of the associated account
↳ namestringName of the opportunity
↳ ownerobjectUser who owns the opportunity
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ stagestringCurrent pipeline stage key of the opportunity
↳ stage_idstringID of the opportunity's stage within its pipeline
↳ pipeline_idstringID of the pipeline the opportunity is in
↳ pipeline_namestringName of the pipeline the opportunity is in
↳ estimated_valueobjectEstimated monetary value of the opportunity
↳ currency_codestringISO 4217 currency code
↳ amountnumberDeprecated: prefer amount_precise. Whole units of the currency.
↳ amount_precisenumberEstimated value as a decimal amount of the specified currency
↳ estimated_close_datestringExpected close date for the opportunity
↳ actual_close_datestringActual date the opportunity was closed
↳ summarystringAI-generated summary of the opportunity
↳ risksarrayIdentified risks for the opportunity
↳ notesstringNotes about the opportunity
↳ tagsarrayTag names associated with the opportunity
↳ contact_idsarrayIDs of contacts linked to the opportunity
↳ last_activity_atstringWhen the last activity on the opportunity happened (ISO 8601)
↳ updated_atstringWhen the opportunity was last updated (ISO 8601)
↳ created_atstringWhen the opportunity was created (ISO 8601)
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.

Monaco Delete Opportunity

Permanently delete a Monaco opportunity. This cannot be undone.

Inputs and outputs

Input

ParameterTypeRequiredDescription
opportunityIdstringYesID of the opportunity to delete

Output

ParameterTypeDescription
idstringID of the deleted opportunity
deletedbooleanWhether Monaco deleted the opportunity

Monaco List Opportunity Contacts

List the contacts linked to a Monaco opportunity, with their email, name, title, and how each link was created.

Inputs and outputs

Input

ParameterTypeRequiredDescription
opportunityIdstringYesID of the opportunity whose linked contacts to list
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 100. Defaults to 50.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
contactsarrayContacts linked to the opportunity on this page
↳ contact_idstringID of the linked contact
↳ sourcestringHow the link was created: manual (rep or API), ai (auto-detected), or system
↳ created_atstringWhen the link was created (ISO 8601)
↳ emailstringEmail of the linked contact
↳ first_namestringFirst name of the linked contact
↳ last_namestringLast name of the linked contact
↳ titlestringJob title of the linked contact
↳ account_idstringAccount ID of the linked contact

Link one or more contacts to a Monaco opportunity. Contacts that are already linked are left as they are, and previously unlinked contacts are restored.

Inputs and outputs

Input

ParameterTypeRequiredDescription
opportunityIdstringYesID of the opportunity to link contacts to
contactIdsarrayYesIDs of the contacts to link, as an array or comma-separated list. At most 500 IDs.

Output

ParameterTypeDescription
opportunityIdstringID of the opportunity the contacts were linked to
contactIdsarrayIDs of the contacts Monaco processed

Unlink one or more contacts from a Monaco opportunity. Contacts that are not currently linked are recorded as removed so they stay off the opportunity.

Inputs and outputs

Input

ParameterTypeRequiredDescription
opportunityIdstringYesID of the opportunity to unlink contacts from
contactIdsarrayYesIDs of the contacts to unlink, as an array or comma-separated list. At most 500 IDs.

Output

ParameterTypeDescription
opportunityIdstringID of the opportunity the contacts were unlinked from
contactIdsarrayIDs of the contacts Monaco processed

Monaco List Pipelines

List the organization's Monaco opportunity pipelines, default first, each with its stages in display order. Use the stage keys and IDs to set an opportunity's stage.

Inputs and outputs

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
pipelinesarrayOpportunity pipelines, default first
↳ idstringUnique identifier of the pipeline
↳ namestringName of the pipeline
↳ is_defaultbooleanWhether opportunities created without a pipeline ID go to this pipeline
↳ stagesarrayThe pipeline's stages in display order
↳ idstringUnique identifier of the stage, as written to an opportunity's stage_id
↳ keystringStage key, as written to an opportunity's stage
↳ display_namestringDisplay name of the stage

Monaco List Tasks

List Monaco tasks with optional filters, sorting, and pagination. Email drafts are omitted from list results; use Get Task for them.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filtersjsonNoFilters as an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression for nested logic. Conditions include is, is_not, equals, contains, not_contains, is_empty, is_not_empty, is_before, and is_after. Use Get Field Schemas to find filterable fields.
sortstringNoField to sort by; prefix with "-" for descending (e.g. "-created_at"). Defaults to "-created_at".
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 50.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
tasksarrayTasks on this page
↳ idstringUnique identifier for the task
↳ account_idstringID of the associated account
↳ opportunity_idstringID of the associated opportunity
↳ titlestringTitle of the task
↳ descriptionstringDetailed description of the task
↳ task_typestringType of task (e.g. GENERAL_ACTION_ITEM, EMAIL)
↳ assigneeobjectUser assigned to the task
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ statusstringCurrent status of the task (TODO, DONE, or CANCELLED)
↳ due_atstringWhen the task is due (ISO 8601)
↳ completed_atstringWhen the task was completed (ISO 8601)
↳ created_atstringWhen the task was created (ISO 8601)
↳ updated_atstringWhen the task was last updated (ISO 8601)
↳ message_draftobjectDraft email contents. Populated on single-task, create, and update responses for EMAIL tasks; always null in list responses.
↳ recipientsarrayPrimary recipients (To) of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ ccarrayCarbon-copy recipients of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ subjectstringSubject line of the email
↳ bodystringBody of the email (plain text or HTML)
↳ sent_atstringWhen the email was sent (ISO 8601)

Monaco Get Task

Get one Monaco task by ID, including the email draft for EMAIL tasks.

Inputs and outputs

Input

ParameterTypeRequiredDescription
taskIdstringYesID (UUID) of the task to fetch

Output

ParameterTypeDescription
taskobjectThe task
↳ idstringUnique identifier for the task
↳ account_idstringID of the associated account
↳ opportunity_idstringID of the associated opportunity
↳ titlestringTitle of the task
↳ descriptionstringDetailed description of the task
↳ task_typestringType of task (e.g. GENERAL_ACTION_ITEM, EMAIL)
↳ assigneeobjectUser assigned to the task
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ statusstringCurrent status of the task (TODO, DONE, or CANCELLED)
↳ due_atstringWhen the task is due (ISO 8601)
↳ completed_atstringWhen the task was completed (ISO 8601)
↳ created_atstringWhen the task was created (ISO 8601)
↳ updated_atstringWhen the task was last updated (ISO 8601)
↳ message_draftobjectDraft email contents. Populated on single-task, create, and update responses for EMAIL tasks; always null in list responses.
↳ recipientsarrayPrimary recipients (To) of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ ccarrayCarbon-copy recipients of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ subjectstringSubject line of the email
↳ bodystringBody of the email (plain text or HTML)
↳ sent_atstringWhen the email was sent (ISO 8601)

Monaco Create Task

Create a Monaco task, optionally linked to an account and/or opportunity. Without an assignee, the task is assigned to the API key owner.

Inputs and outputs

Input

ParameterTypeRequiredDescription
titlestringYesTitle of the task (max 256 characters)
descriptionstringNoDetailed description of the task (max 65,536 characters)
accountIdstringNoID (UUID) of the account to associate the task with
opportunityIdstringNoID (UUID) of the opportunity to associate the task with
taskTypestringNoType of task. One of GENERAL_ACTION_ITEM, EMAIL. Defaults to GENERAL_ACTION_ITEM.
assigneeIdstringNoUser ID (UUID) to assign the task to. Defaults to the API key owner. Use List Users to find IDs.
dueAtstringNoDue date and time for the task (ISO 8601 date-time)
messageDraftjsonNoDraft email as {"recipients": [{"name", "email"}], "cc": [{"name", "email"}], "subject", "body"}. recipients, subject, and body are required; body may be plain text or HTML. Only valid when taskType is EMAIL.

Output

ParameterTypeDescription
taskobjectThe created task
↳ idstringUnique identifier for the task
↳ account_idstringID of the associated account
↳ opportunity_idstringID of the associated opportunity
↳ titlestringTitle of the task
↳ descriptionstringDetailed description of the task
↳ task_typestringType of task (e.g. GENERAL_ACTION_ITEM, EMAIL)
↳ assigneeobjectUser assigned to the task
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ statusstringCurrent status of the task (TODO, DONE, or CANCELLED)
↳ due_atstringWhen the task is due (ISO 8601)
↳ completed_atstringWhen the task was completed (ISO 8601)
↳ created_atstringWhen the task was created (ISO 8601)
↳ updated_atstringWhen the task was last updated (ISO 8601)
↳ message_draftobjectDraft email contents. Populated on single-task, create, and update responses for EMAIL tasks; always null in list responses.
↳ recipientsarrayPrimary recipients (To) of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ ccarrayCarbon-copy recipients of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ subjectstringSubject line of the email
↳ bodystringBody of the email (plain text or HTML)
↳ sent_atstringWhen the email was sent (ISO 8601)

Monaco Update Task

Update a Monaco task. Only the fields you set are changed; setting status to DONE or CANCELLED marks it completed.

Inputs and outputs

Input

ParameterTypeRequiredDescription
taskIdstringYesID (UUID) of the task to update
titlestringNoTitle of the task (max 256 characters)
descriptionstringNoDetailed description of the task (max 65,536 characters)
statusstringNoStatus of the task. One of TODO, DONE, CANCELLED. Moving to DONE or CANCELLED sets completed_at; moving out of those states clears it.
accountIdstringNoID (UUID) of the account to associate the task with. Only supported for manually created tasks.
assigneeIdstringNoUser ID (UUID) to assign the task to. Use List Users to find IDs.
dueAtstringNoDue date and time for the task (ISO 8601 date-time)
messageDraftjsonNoDraft email as {"recipients": [{"name", "email"}], "cc": [{"name", "email"}], "subject", "body"}; replaces the existing draft. recipients, subject, and body are required. Only valid for EMAIL tasks.

Output

ParameterTypeDescription
taskobjectThe updated task
↳ idstringUnique identifier for the task
↳ account_idstringID of the associated account
↳ opportunity_idstringID of the associated opportunity
↳ titlestringTitle of the task
↳ descriptionstringDetailed description of the task
↳ task_typestringType of task (e.g. GENERAL_ACTION_ITEM, EMAIL)
↳ assigneeobjectUser assigned to the task
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ statusstringCurrent status of the task (TODO, DONE, or CANCELLED)
↳ due_atstringWhen the task is due (ISO 8601)
↳ completed_atstringWhen the task was completed (ISO 8601)
↳ created_atstringWhen the task was created (ISO 8601)
↳ updated_atstringWhen the task was last updated (ISO 8601)
↳ message_draftobjectDraft email contents. Populated on single-task, create, and update responses for EMAIL tasks; always null in list responses.
↳ recipientsarrayPrimary recipients (To) of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ ccarrayCarbon-copy recipients of the email
↳ namestringDisplay name of the recipient
↳ emailstringEmail address of the recipient
↳ subjectstringSubject line of the email
↳ bodystringBody of the email (plain text or HTML)
↳ sent_atstringWhen the email was sent (ISO 8601)

Monaco List Meetings

List Monaco meetings with optional filters, sorting, and pagination. Use Get Meeting for the transcript, summary, and recording.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filtersjsonNoFilters as an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression for nested logic. Conditions include is, is_not, equals, contains, not_contains, is_empty, is_not_empty, is_before, and is_after. Use Get Field Schemas to find filterable fields.
sortstringNoField to sort by; prefix with "-" for descending. Defaults to "-start_time". created_at is not a sortable meeting field.
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 50.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
meetingsarrayMeetings on this page
↳ idstringUnique identifier for the meeting
↳ account_idstringDeprecated: use account_candidates. ID of the associated account
↳ opportunity_idstringDeprecated: use opportunity_candidates. ID of the associated open opportunity
↳ opportunity_candidatesarrayOpen opportunities the meeting associates to
↳ opportunity_idstringID of the open opportunity
↳ namestringName of the opportunity
↳ titlestringMeeting title from the calendar event
↳ descriptionstringMeeting description
↳ start_timestringMeeting start time (ISO 8601)
↳ end_timestringMeeting end time (ISO 8601)
↳ occurred_atstringWhen the meeting actually occurred: recording start time (ISO 8601). Null for meetings that were never recorded, including future and declined events.
↳ meeting_platformstringVideo conferencing platform
↳ meeting_urlstringURL to join the meeting
↳ organizerobjectMeeting organizer
↳ emailstringEmail address of the organizer
↳ display_namestringDisplay name of the organizer
↳ attendeesarrayMeeting attendees
↳ emailstringEmail address of the attendee
↳ display_namestringDisplay name of the attendee
↳ response_statusstringRSVP response status
↳ next_actionsarrayAI-generated action items from the meeting
↳ created_atstringWhen the meeting was created in Monaco (ISO 8601)
↳ updated_atstringWhen the meeting was last updated in Monaco (ISO 8601)

Monaco Get Meeting

Get one Monaco meeting by ID, including AI pre-meeting notes, the AI summary, a presigned recording URL, and the full speaker-attributed transcript with word-level timestamps. The transcript is returned untruncated and can be very large for long meetings.

Inputs and outputs

Input

ParameterTypeRequiredDescription
meetingIdstringYesID (UUID) of the meeting to fetch

Output

ParameterTypeDescription
meetingobjectThe meeting with notes, summary, recording URL, and transcript
↳ idstringUnique identifier for the meeting
↳ account_idstringDeprecated: use account_candidates. ID of the associated account
↳ opportunity_idstringDeprecated: use opportunity_candidates. ID of the associated open opportunity
↳ opportunity_candidatesarrayOpen opportunities the meeting associates to
↳ opportunity_idstringID of the open opportunity
↳ namestringName of the opportunity
↳ titlestringMeeting title from the calendar event
↳ descriptionstringMeeting description
↳ start_timestringMeeting start time (ISO 8601)
↳ end_timestringMeeting end time (ISO 8601)
↳ occurred_atstringWhen the meeting actually occurred: recording start time (ISO 8601). Null for meetings that were never recorded, including future and declined events.
↳ meeting_platformstringVideo conferencing platform
↳ meeting_urlstringURL to join the meeting
↳ organizerobjectMeeting organizer
↳ emailstringEmail address of the organizer
↳ display_namestringDisplay name of the organizer
↳ attendeesarrayMeeting attendees
↳ emailstringEmail address of the attendee
↳ display_namestringDisplay name of the attendee
↳ response_statusstringRSVP response status
↳ next_actionsarrayAI-generated action items from the meeting
↳ created_atstringWhen the meeting was created in Monaco (ISO 8601)
↳ updated_atstringWhen the meeting was last updated in Monaco (ISO 8601)
↳ ai_premeeting_notesstringAI-generated preparation notes for an upcoming meeting; null when not generated yet
↳ meeting_summarystringAI-generated meeting summary
↳ video_urlstringPresigned URL for the meeting recording; null when there is no recording yet
↳ transcriptarrayFull transcript as speaker-attributed segments with word-level timestamps. Can be very large for long meetings.
↳ speakerstringName of the speaker
↳ languagestringLanguage code of the segment
↳ wordsarrayWords in this segment
↳ textstringThe transcribed word
↳ start_timestampnumberStart time in seconds
↳ end_timestampnumberEnd time in seconds
↳ transcript_sourcestringWhere the transcript came from: recall (Monaco's recorder), granola, circleback, or custom (imported). Null when the meeting has no transcript.

Monaco List Messages

List the email and LinkedIn conversation history for a contact or account as one recency-ordered feed, one row per conversation. Pass a row's conversation_id and channel to Get Conversation for the full thread. Paginates with a cursor.

Inputs and outputs

Input

ParameterTypeRequiredDescription
contactIdstringNoID (UUID) of a contact to scope the feed to that contact's message history
accountIdstringNoID (UUID) of an account to scope the feed to that account's message history
channelsarrayNoChannels to include, as an array or comma-separated list. Each is one of email, linkedin. Omit to include all channels.
cursorstringNoOpaque nextCursor from a previous response; omit for the first page
pageSizenumberNoResults per page, from 1 to 100. Defaults to 25.

Output

ParameterTypeDescription
messagesarrayConversations on this page, most recent first
↳ conversation_idstringThread or chat identifier; pass to Get Conversation with the channel
↳ channelstringChannel the message was sent over (email or linkedin)
↳ directionstringMessage direction: inbound, outbound, internal, or unknown
↳ subjectstringSubject line of the conversation
↳ previewstringShort preview of the most recent message
↳ timestampstringWhen the most recent message was sent (ISO 8601)
↳ contact_idstringID of the associated contact
↳ account_idstringID of the associated account
nextCursorstringPass back as cursor to fetch the next page; null when there are no more
hasMorebooleanWhether more pages are available

Monaco Get Conversation

Get the full ordered thread of one Monaco email or LinkedIn conversation, with participants and paginated messages. Bodies are plain text and truncated past 20,000 characters.

Inputs and outputs

Input

ParameterTypeRequiredDescription
conversationIdstringYesConversation to fetch: the email thread_id or LinkedIn chat_id (the conversation_id from List Messages)
channelstringYesChannel of the conversation; must match conversationId. One of email, linkedin.
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 100. Defaults to 20.

Output

ParameterTypeDescription
conversationobjectThe conversation with its participants and messages on this page
↳ idstringUnique identifier for the conversation
↳ channelstringChannel of the conversation (email or linkedin)
↳ subjectstringSubject line of the conversation
↳ account_idstringDeprecated: use account_candidates. ID of the associated account
↳ messagesarrayMessages on this page, in thread order
↳ idstringUnique identifier for the message
↳ channelstringChannel the message was sent over (email or linkedin)
↳ senderobjectSender of the message
↳ namestringDisplay name of the participant
↳ emailstringEmail address of the participant
↳ linkedin_urlstringLinkedIn profile URL of the participant
↳ contact_idstringID of the associated contact
↳ company_namestringCompany name of the participant
↳ is_current_userbooleanWhether this participant is the requesting user
↳ subjectstringSubject line of the message
↳ bodystringPlain-text body of the message (truncated past 20,000 characters)
↳ body_truncatedbooleanWhether the body was truncated due to length
↳ timestampstringWhen the message was sent (ISO 8601)

Monaco List Tags

List every Monaco tag defined for contacts, accounts, or opportunities.

Inputs and outputs

Input

ParameterTypeRequiredDescription
objectstringYesObject type to list tags for. One of contacts, accounts, opportunities.

Output

ParameterTypeDescription
tagsarrayTags defined for the object type
↳ idstringUnique identifier for the tag
↳ namestringDisplay name of the tag
↳ colorstringDisplay color of the tag

Monaco Create Tag

Create a Monaco tag for contacts, accounts, or opportunities.

Inputs and outputs

Input

ParameterTypeRequiredDescription
objectstringYesObject type the tag applies to. One of contacts, accounts, opportunities.
namestringYesDisplay name of the tag (max 100 characters). Letters, numbers, and spaces only; must be unique per object type within the organization.
colorstringNoDisplay color of the tag. One of green, blue, red, yellow, purple, berry, peach, gray.

Output

ParameterTypeDescription
tagobjectThe created tag
↳ idstringUnique identifier for the tag
↳ namestringDisplay name of the tag
↳ colorstringDisplay color of the tag

Monaco List Users

List the users in the Monaco organization, optionally filtered by name or email. Each user's role says whether they are a workspace ADMIN.

Inputs and outputs

Input

ParameterTypeRequiredDescription
querystringNoCase-insensitive substring filter on name or email

Output

ParameterTypeDescription
usersarrayUsers in the organization
↳ idstringUnique identifier of the user
↳ first_namestringFirst name of the user
↳ last_namestringLast name of the user
↳ emailstringEmail address of the user
↳ rolestringWorkspace role: ADMIN (manages organization-wide settings and users) or MEMBER

Monaco Get Current User

Get the Monaco user and organization the API key belongs to.

Inputs and outputs

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
currentUserobjectThe authenticated user and organization
↳ org_idstringAuthenticated organization ID
↳ user_idstringAuthenticated user ID
↳ user_emailstringAuthenticated user email
↳ user_first_namestringAuthenticated user first name
↳ user_last_namestringAuthenticated user last name
↳ org_namestringAuthenticated organization name

Monaco Get Field Schemas

List the filterable and sortable fields for a Monaco entity, with each field's key, type, allowed filter operators, whether it is updatable, custom-field settings, and allowed enum values. Use it to build list filters and to interpret custom_field_<id> keys.

Inputs and outputs

Input

ParameterTypeRequiredDescription
entitystringYesEntity to describe. One of accounts, contacts, meetings, opportunities, sequences, tasks.

Output

ParameterTypeDescription
fieldsarrayField schemas for the entity
↳ namestringDisplay name of the field
↳ keystringKey used for filtering and sorting
↳ typestringData type: string, number, time, boolean, enum, array, date, datetime, text, uuid, or object. A multi-select custom field is array.
↳ parentstringKey of the parent object field this field belongs to; null for top-level fields
↳ filterablebooleanWhether the field can be used in filter rules
↳ sortablebooleanWhether the field can be used for sorting
↳ updatablebooleanWhether the field can be written via the update endpoint; false marks a read-only field
↳ allowed_operatorsarrayOperators that can be used to filter this field
↳ custom_field_settingsobjectSettings present only for custom fields
↳ idstringUnique identifier of the custom field schema
↳ is_ai_auto_filledbooleanWhether this custom field is automatically populated by AI
↳ questionstringFor an AI auto-filled field, the question AI answers to fill it
↳ enum_field_settingsobjectSettings present only for enum/select fields. For date and datetime fields these are semantic periods (e.g. 'previous_week') used with the is operator.
↳ allowed_valuesarrayValid values that can be used in filters
↳ keystringThe value to use in filter rules
↳ display_valuestringHuman-readable label for the value

Monaco List Sequences

List Monaco outreach sequences with optional filters, sorting, and pagination.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filtersjsonNoFilters as an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression for nested logic. Conditions include is, is_not, equals, contains, not_contains, is_empty, is_not_empty, is_before, and is_after. Use Get Field Schemas to find filterable fields.
sortstringNoField to sort by; prefix with "-" for descending (e.g. "-created_at"). Defaults to "-created_at".
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 50.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
sequencesarraySequences on this page
↳ idstringUnique identifier for the sequence
↳ contact_idstringID of the contact this sequence is associated with
↳ namestringName of the sequence
↳ descriptionstringDescription of the sequence
↳ statusstringCurrent status of the sequence
↳ template_idstringID of the sequence template this sequence was created from
↳ created_atstringWhen the sequence was created (ISO 8601)
↳ updated_atstringWhen the sequence was last updated (ISO 8601)
↳ last_interactionstringHuman-readable summary of the most recent interaction on this sequence (e.g. "Email today", "No interactions yet")
↳ enqueued_atstringWhen the sequence was enqueued (ISO 8601)
↳ started_atstringWhen the sequence was started (ISO 8601)
↳ responded_atstringWhen the contact responded on this sequence (ISO 8601)
↳ meeting_booked_atstringWhen a meeting was booked off this sequence (ISO 8601)
↳ sender_idstringID of the user sending this sequence
↳ sender_namestringFull name of the user sending this sequence
↳ exclusion_infoobjectWhy this sequence was excluded: the most recently triggered rules-of-engagement violation. Null unless the status is Excluded and a violation was recorded.
↳ rule_namestringRules-of-engagement rule that was violated
↳ descriptionstringHuman-readable reason the sequence was excluded
↳ overridabilitystringWhether the rule can be overridden: HARD or SOFT

Monaco Get Sequence

Get one Monaco sequence by ID, including its ordered list of tasks.

Inputs and outputs

Input

ParameterTypeRequiredDescription
sequenceIdstringYesID of the sequence to fetch

Output

ParameterTypeDescription
sequenceobjectThe sequence with its ordered tasks
↳ idstringUnique identifier for the sequence
↳ contact_idstringID of the contact this sequence is associated with
↳ namestringName of the sequence
↳ descriptionstringDescription of the sequence
↳ statusstringCurrent status of the sequence
↳ template_idstringID of the sequence template this sequence was created from
↳ created_atstringWhen the sequence was created (ISO 8601)
↳ updated_atstringWhen the sequence was last updated (ISO 8601)
↳ last_interactionstringHuman-readable summary of the most recent interaction on this sequence (e.g. "Email today", "No interactions yet")
↳ enqueued_atstringWhen the sequence was enqueued (ISO 8601)
↳ started_atstringWhen the sequence was started (ISO 8601)
↳ responded_atstringWhen the contact responded on this sequence (ISO 8601)
↳ meeting_booked_atstringWhen a meeting was booked off this sequence (ISO 8601)
↳ sender_idstringID of the user sending this sequence
↳ sender_namestringFull name of the user sending this sequence
↳ exclusion_infoobjectWhy this sequence was excluded: the most recently triggered rules-of-engagement violation. Null unless the status is Excluded and a violation was recorded.
↳ rule_namestringRules-of-engagement rule that was violated
↳ descriptionstringHuman-readable reason the sequence was excluded
↳ overridabilitystringWhether the rule can be overridden: HARD or SOFT
↳ tasksarrayOrdered list of tasks in the sequence
↳ idstringUnique identifier for the task
↳ sequence_idstringID of the sequence this task belongs to
↳ ordernumberPosition of the task within the sequence (1-indexed)
↳ namestringDisplay name of the task
↳ typestringType of task: generic, auto_email, manual_email, auto_linkedin_connection, manual_linkedin_connection, auto_linkedin_message, manual_linkedin_message, auto_linkedin_inmail, manual_linkedin_inmail, auto_phone, manual_phone, internal_email, gifting_via_email, gifting_via_address, or complete_sequence
↳ statusstringCurrent status of the task: unknown, scheduled, pending, in_progress, paused, completed, failed, cancelled, or skipped
↳ scheduled_atstringWhen the task is scheduled for (ISO 8601)
↳ completed_atstringWhen the task was completed (ISO 8601)
↳ task_bodystringTask message body
↳ subjectstringSubject line, for subject-bearing channels (email, InMail, gifting email)
↳ outcomestringObserved outcome of the task, such as positive_reply, negative_reply, email_bounced, accepted, meeting_scheduled, or do_not_contact
↳ hold_reasonstringWhy this open task can't be sent right now: not_connected, inmail_not_in_plan, rate_limited, or out_of_inmail_credits. Null when nothing is holding it, including normal waits like a step delay or a pending connection request
↳ hold_untilstringWhen the engine will try the task again, if the hold clears on its own

Monaco Update Sequence

Apply a state transition (enqueue, pause, resume, stop, or exclude) to a Monaco sequence and return the refreshed sequence with its tasks. Enqueuing or resuming a sequence lets it send real emails and LinkedIn messages to the contact; stopping ends the sequence as failed.

Inputs and outputs

Input

ParameterTypeRequiredDescription
sequenceIdstringYesID of the sequence to update
actionstringYesState transition to apply: "enqueue" (move a suggested sequence into the queue), "pause" (temporarily halt execution), "resume" (resume a paused sequence), "stop" (end the sequence as failed), or "exclude" (remove a needs_review or staged sequence before it is queued; the sequence moves to excluded)

Output

ParameterTypeDescription
sequenceobjectThe refreshed sequence with its ordered tasks
↳ idstringUnique identifier for the sequence
↳ contact_idstringID of the contact this sequence is associated with
↳ namestringName of the sequence
↳ descriptionstringDescription of the sequence
↳ statusstringCurrent status of the sequence
↳ template_idstringID of the sequence template this sequence was created from
↳ created_atstringWhen the sequence was created (ISO 8601)
↳ updated_atstringWhen the sequence was last updated (ISO 8601)
↳ last_interactionstringHuman-readable summary of the most recent interaction on this sequence (e.g. "Email today", "No interactions yet")
↳ enqueued_atstringWhen the sequence was enqueued (ISO 8601)
↳ started_atstringWhen the sequence was started (ISO 8601)
↳ responded_atstringWhen the contact responded on this sequence (ISO 8601)
↳ meeting_booked_atstringWhen a meeting was booked off this sequence (ISO 8601)
↳ sender_idstringID of the user sending this sequence
↳ sender_namestringFull name of the user sending this sequence
↳ exclusion_infoobjectWhy this sequence was excluded: the most recently triggered rules-of-engagement violation. Null unless the status is Excluded and a violation was recorded.
↳ rule_namestringRules-of-engagement rule that was violated
↳ descriptionstringHuman-readable reason the sequence was excluded
↳ overridabilitystringWhether the rule can be overridden: HARD or SOFT
↳ tasksarrayOrdered list of tasks in the sequence
↳ idstringUnique identifier for the task
↳ sequence_idstringID of the sequence this task belongs to
↳ ordernumberPosition of the task within the sequence (1-indexed)
↳ namestringDisplay name of the task
↳ typestringType of task: generic, auto_email, manual_email, auto_linkedin_connection, manual_linkedin_connection, auto_linkedin_message, manual_linkedin_message, auto_linkedin_inmail, manual_linkedin_inmail, auto_phone, manual_phone, internal_email, gifting_via_email, gifting_via_address, or complete_sequence
↳ statusstringCurrent status of the task: unknown, scheduled, pending, in_progress, paused, completed, failed, cancelled, or skipped
↳ scheduled_atstringWhen the task is scheduled for (ISO 8601)
↳ completed_atstringWhen the task was completed (ISO 8601)
↳ task_bodystringTask message body
↳ subjectstringSubject line, for subject-bearing channels (email, InMail, gifting email)
↳ outcomestringObserved outcome of the task, such as positive_reply, negative_reply, email_bounced, accepted, meeting_scheduled, or do_not_contact
↳ hold_reasonstringWhy this open task can't be sent right now: not_connected, inmail_not_in_plan, rate_limited, or out_of_inmail_credits. Null when nothing is holding it, including normal waits like a step delay or a pending connection request
↳ hold_untilstringWhen the engine will try the task again, if the hold clears on its own

Monaco List Audiences

List Monaco audiences, the reusable contact lists that campaigns enroll. The default page size returns every audience in one page.

Inputs and outputs

Input

ParameterTypeRequiredDescription
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 500.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
audiencesarrayAudiences on this page
↳ idstringUnique identifier for the audience
↳ namestringName of the audience
↳ typestringAudience type
↳ statusstringAudience status
↳ contact_countnumberNumber of contacts currently in the audience
↳ created_atstringWhen the audience was created (ISO 8601)
↳ updated_atstringWhen the audience was last updated (ISO 8601)

Monaco Get Audience

Get one Monaco audience by ID.

Inputs and outputs

Input

ParameterTypeRequiredDescription
audienceIdstringYesID of the audience to fetch

Output

ParameterTypeDescription
audienceobjectThe audience
↳ idstringUnique identifier for the audience
↳ namestringName of the audience
↳ typestringAudience type
↳ statusstringAudience status
↳ contact_countnumberNumber of contacts currently in the audience
↳ created_atstringWhen the audience was created (ISO 8601)
↳ updated_atstringWhen the audience was last updated (ISO 8601)

Monaco List Audience Contacts

List the contacts in a Monaco audience, one page at a time.

Inputs and outputs

Input

ParameterTypeRequiredDescription
audienceIdstringYesID of the audience whose contacts to list
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 15.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
contactsarrayContacts in the audience on this page
↳ idstringUnique identifier for the contact
↳ account_idstringID of the associated account
↳ account_namestringDisplay name of the associated account: its user-set name, falling back to the company name, then the account's domain
↳ first_namestringFirst name of the contact
↳ last_namestringLast name of the contact
↳ emailstringEmail address of the contact
↳ titlestringJob title of the contact
↳ phone_numberstringPhone number of the contact
↳ linkedin_urlstringLinkedIn profile URL
↳ locationstringLocation of the contact
↳ countrystringCountry of the contact
↳ job_start_datestringStart date of the contact's current job (YYYY-MM-DD)
↳ sourcestringSource from which the contact was added
↳ do_not_contactbooleanWhether the contact has opted out of outreach
↳ notesstringNotes about the contact
↳ scoringobjectContact scoring information
↳ heat_scorestringHeat score tier
↳ tagsarrayTag names associated with the contact
↳ created_atstringWhen the contact was created (ISO 8601)
↳ updated_atstringWhen the contact was last updated (ISO 8601)
↳ last_activity_atstringWhen the contact's most recent activity (inbound or outbound) happened
↳ last_activity_typestringType of the contact's most recent activity
↳ last_outbound_atstringWhen the most recent outbound interaction with the contact happened
↳ last_outbound_typestringType of the most recent outbound interaction with the contact
↳ last_inbound_atstringWhen the most recent inbound interaction from the contact happened
↳ last_inbound_typestringType of the most recent inbound interaction from the contact
↳ custom_fieldsjsonCustom field values keyed by their custom_field_&lt;id&gt; key. Use Get Field Schemas to see what each key means.

Monaco Create Audience

Create a Monaco audience, optionally seeded with contacts: either an explicit list of contact IDs, or a filters query over the contact field schemas (optionally narrowed by excluded IDs or a source audience). Audiences can be shared across campaigns.

Inputs and outputs

Input

ParameterTypeRequiredDescription
namestringYesName of the audience to create
contactIdsarrayNoContact IDs to add to the audience on creation (up to 10,000), as an array or comma-separated list. Provide either contactIds or filters, not both.
filtersjsonNoSelects the contacts to seed the audience with by query instead of listing every ID: an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression. Valid fields, conditions, and values come from the contacts field schemas; a rule on "account_id" selects that account's contacts. At most 10,000 matching contacts (before exclusions). Provide either filters or contactIds, not both. An empty list is rejected because Monaco would match every contact.
excludedIdsarrayNoContact IDs to exclude from the filtered set (up to 10,000). Only valid together with filters.
sourceAudienceIdstringNoRestricts the contacts selected by filters to current members of this audience. Only valid together with filters.

Output

ParameterTypeDescription
audienceobjectThe created audience
↳ idstringUnique identifier for the audience
↳ namestringName of the audience
↳ typestringAudience type
↳ statusstringAudience status
↳ contact_countnumberNumber of contacts currently in the audience
↳ created_atstringWhen the audience was created (ISO 8601)
↳ updated_atstringWhen the audience was last updated (ISO 8601)

Monaco Add Audience Contacts

Add contacts to a Monaco audience by ID. Audiences can be attached to multiple campaigns, so adding a contact here enrolls them in every campaign that uses this audience, which can start real email and LinkedIn outreach.

Inputs and outputs

Input

ParameterTypeRequiredDescription
audienceIdstringYesID of the audience to add contacts to
contactIdsarrayYesIDs of the contacts to add (1 to 10,000), as an array or comma-separated list

Output

ParameterTypeDescription
failuresarrayContacts that exist but could not be added or removed, grouped by reason
↳ reasonstringReason code for the failure
↳ contact_idsarrayContact IDs that failed for this reason
audienceIdstringID of the audience that was modified
addedCountnumberNumber of contacts this call added to the audience
unknownContactIdsarrayContact IDs that do not exist in the organization and were skipped

Monaco Remove Audience Contacts

Remove contacts from a Monaco audience by ID. Idempotent: IDs not in the audience are ignored. Per-contact failures are returned in failures.

Inputs and outputs

Input

ParameterTypeRequiredDescription
audienceIdstringYesID of the audience to remove contacts from
contactIdsarrayYesIDs of the contacts to remove (1 to 10,000), as an array or comma-separated list

Output

ParameterTypeDescription
failuresarrayContacts that exist but could not be added or removed, grouped by reason
↳ reasonstringReason code for the failure
↳ contact_idsarrayContact IDs that failed for this reason
audienceIdstringID of the audience that was modified

Monaco List Campaigns

List Monaco campaigns with optional filters, sorting, and pagination.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filtersjsonNoFilters as an array of {"field", "condition", "value"} rules (ANDed), or an {"operator": "and"|"or", "filters": [...]} expression for nested logic. Conditions include is, is_not, equals, contains, not_contains, is_empty, is_not_empty, is_before, and is_after. Use Get Field Schemas to find filterable fields.
sortstringNoField to sort by; prefix with "-" for descending (e.g. "-created_at"). Defaults to "-created_at".
pagenumberNoPage number, starting at 1. Defaults to 1.
pageSizenumberNoResults per page, from 1 to 500. Defaults to 50.

Output

ParameterTypeDescription
paginationobjectPagination for the returned page
↳ pagenumberCurrent page number (1-indexed)
↳ page_sizenumberNumber of results per page
↳ total_countnumberTotal number of matching records
↳ total_pagesnumberTotal number of pages
campaignsarrayCampaigns on this page
↳ idstringUnique identifier for the campaign
↳ namestringName of the campaign
↳ statusstringCurrent lifecycle status of the campaign: active, paused, completed, draft, or archived
↳ prioritizedbooleanWhether this campaign takes priority over non-prioritized campaigns
↳ end_datestringDate the campaign stops enrolling (YYYY-MM-DD)
↳ template_idstringID of the template enrolled contacts are placed on
↳ template_namestringTitle of the template
↳ audiencesarrayAudiences enrolled in this campaign
↳ idstringUnique identifier for the audience
↳ namestringName of the audience
↳ enrollment_statusstringProgress of the async task enrolling this campaign's audiences: pending, running, enriching, completed, or failed
↳ created_atstringWhen the campaign was created (ISO 8601)
↳ updated_atstringWhen the campaign was last updated (ISO 8601)

Monaco Get Campaign

Get one Monaco campaign by ID, including its attached audiences, sender distribution, rules of engagement, and autopilot settings.

Inputs and outputs

Input

ParameterTypeRequiredDescription
campaignIdstringYesID of the campaign to fetch

Output

ParameterTypeDescription
campaignobjectThe campaign
↳ idstringUnique identifier for the campaign
↳ namestringName of the campaign
↳ statusstringCurrent lifecycle status of the campaign: active, paused, completed, draft, or archived
↳ prioritizedbooleanWhether this campaign takes priority over non-prioritized campaigns
↳ end_datestringDate the campaign stops enrolling (YYYY-MM-DD)
↳ template_idstringID of the template enrolled contacts are placed on
↳ template_namestringTitle of the template
↳ audiencesarrayAudiences enrolled in this campaign
↳ idstringUnique identifier for the audience
↳ namestringName of the audience
↳ enrollment_statusstringProgress of the async task enrolling this campaign's audiences: pending, running, enriching, completed, or failed
↳ created_atstringWhen the campaign was created (ISO 8601)
↳ updated_atstringWhen the campaign was last updated (ISO 8601)
↳ distributionobjectHow sends are routed across senders (percentage or account_owner)
↳ modestringDistribution mode: percentage or account_owner
↳ sender_idsarrayIDs of the users eligible to send on this campaign
↳ percentagesarrayPer-sender percentages summing to 100; set only in percentage mode
↳ sender_idstringID of the sending user
↳ percentagenumberShare of sends routed to this sender
↳ fallback_sender_idstringSender used whenever a contact's account is unassigned or its owner is not in sender_ids; set only in account_owner mode
↳ rules_of_engagementobjectThe campaign's effective rules of engagement; null when the campaign uses the org defaults with no campaign-level config
↳ do_not_contactobjectSkip contacts flagged do-not-contact
↳ enabledbooleanWhether this rule is enforced for the campaign
↳ allow_sequence_stop_on_meeting_bookedobjectStop a contact's sequence once a meeting is booked
↳ enabledbooleanWhether this rule is enforced for the campaign
↳ contact_cooldownobjectCooldown before re-contacting the same contact
↳ enabledbooleanWhether the cooldown is enforced
↳ daysnumberLength of the cooldown window in days (Monaco defaults to 90)
↳ account_cooldownobjectCooldown before re-contacting any contact at the same account
↳ enabledbooleanWhether the cooldown is enforced
↳ daysnumberLength of the cooldown window in days (Monaco defaults to 90)
↳ max_contacts_in_sequenceobjectCap on simultaneously-active contacts per account
↳ enabledbooleanWhether the cap is enforced
↳ max_contactsnumberMaximum contacts per account allowed in sequences simultaneously (Monaco defaults to 5)
↳ allow_non_account_owner_campaignsobjectAllow enrolling contacts whose account owner is not a campaign sender
↳ enabledbooleanWhether this rule is enforced for the campaign
↳ allow_stop_and_dismiss_on_account_statusobjectStop and dismiss sequences when an account changes to certain statuses
↳ enabledbooleanWhether the rule is enforced for the trigger statuses
↳ statusesarrayAccount statuses that trigger the rule (NEW, PROSPECTING, OPPORTUNITY, CUSTOMER, DISQUALIFIED, NURTURE, INBOUND, CHURNED); null inherits the org's default set
↳ exclude_sequences_on_account_statusobjectExclude not-yet-started sequences when an account is in (or transitions into) certain statuses; already-active sequences are unaffected
↳ enabledbooleanWhether the rule is enforced for the trigger statuses
↳ statusesarrayAccount statuses that trigger the rule (NEW, PROSPECTING, OPPORTUNITY, CUSTOMER, DISQUALIFIED, NURTURE, INBOUND, CHURNED); null inherits the org's default set
↳ autopilot_modestringautopilot when every sender auto-sends, supervised when none do, hybrid when it is a mix
↳ autopilot_settingsobjectSenders currently on autopilot and their daily send-release cap
↳ sender_ratesarraySenders on autopilot; senders not listed need manual approval before each send
↳ sender_idstringID of the sending user
↳ daily_rate_targetnumberDaily cap on auto-released sends for this sender
↳ contact_readiness_settingsobjectChecks run on each contact before its sequence starts
↳ emailobjectEmail lookup and verification before the sequence starts
↳ check_on_enrollbooleanWhether to find and verify each contact's email on enrollment, before the sequence starts
↳ on_failurestringWhat happens when a contact's email can't be found or verified: exclude (the sequence is excluded) or skip_channel_steps (its email steps are skipped)

Monaco Enroll Campaign Contacts

Enroll contacts in a Monaco campaign. This sends real outreach: enrolled contacts are placed on the campaign sequence, which sends real emails and LinkedIn messages. Monaco always creates a new audience with the given name, attaches it to the campaign, and adds the contacts to it. The campaign must be active or paused. Sequences are created asynchronously, so contacts already enrolled are deduplicated later and still count as successes.

Inputs and outputs

Input

ParameterTypeRequiredDescription
campaignIdstringYesID of the campaign to enroll contacts in; it must be active or paused
audienceNamestringYesName for the new audience created to hold these contacts (1 to 255 characters); pick something short and relevant to the enrollment. Must be unique within the organization: a duplicate name is rejected, so vary it and retry.
contactIdsarrayYesIDs of the contacts to enroll (1 to 10,000), as an array or comma-separated list

Output

ParameterTypeDescription
successCountnumberContacts added to the campaign's new audience
failureCountnumberContacts that could not be added (e.g. not found in the organization)
failureReasonsarrayFailure reasons with the number of contacts affected by each
↳ codestringFailure reason code (e.g. contact_has_active_sequence)
↳ descriptionstringHuman-readable description of the failure reason
↳ countnumberNumber of contacts that hit this failure

Monaco Add Campaign Audiences

Attach audiences to a Monaco campaign, keeping its existing ones, and return the refreshed campaign. This sends real outreach: every contact in the attached audiences is enrolled asynchronously and the campaign sequence sends them real emails and LinkedIn messages. Audiences already attached are ignored, so retries are safe.

Inputs and outputs

Input

ParameterTypeRequiredDescription
campaignIdstringYesID of the campaign to attach audiences to
audienceIdsarrayYesIDs of the audiences to attach (at least one), as an array or comma-separated list

Output

ParameterTypeDescription
campaignobjectThe refreshed campaign with its attached audiences
↳ idstringUnique identifier for the campaign
↳ namestringName of the campaign
↳ statusstringCurrent lifecycle status of the campaign: active, paused, completed, draft, or archived
↳ prioritizedbooleanWhether this campaign takes priority over non-prioritized campaigns
↳ end_datestringDate the campaign stops enrolling (YYYY-MM-DD)
↳ template_idstringID of the template enrolled contacts are placed on
↳ template_namestringTitle of the template
↳ audiencesarrayAudiences enrolled in this campaign
↳ idstringUnique identifier for the audience
↳ namestringName of the audience
↳ enrollment_statusstringProgress of the async task enrolling this campaign's audiences: pending, running, enriching, completed, or failed
↳ created_atstringWhen the campaign was created (ISO 8601)
↳ updated_atstringWhen the campaign was last updated (ISO 8601)
↳ distributionobjectHow sends are routed across senders (percentage or account_owner)
↳ modestringDistribution mode: percentage or account_owner
↳ sender_idsarrayIDs of the users eligible to send on this campaign
↳ percentagesarrayPer-sender percentages summing to 100; set only in percentage mode
↳ sender_idstringID of the sending user
↳ percentagenumberShare of sends routed to this sender
↳ fallback_sender_idstringSender used whenever a contact's account is unassigned or its owner is not in sender_ids; set only in account_owner mode
↳ rules_of_engagementobjectThe campaign's effective rules of engagement; null when the campaign uses the org defaults with no campaign-level config
↳ do_not_contactobjectSkip contacts flagged do-not-contact
↳ enabledbooleanWhether this rule is enforced for the campaign
↳ allow_sequence_stop_on_meeting_bookedobjectStop a contact's sequence once a meeting is booked
↳ enabledbooleanWhether this rule is enforced for the campaign
↳ contact_cooldownobjectCooldown before re-contacting the same contact
↳ enabledbooleanWhether the cooldown is enforced
↳ daysnumberLength of the cooldown window in days (Monaco defaults to 90)
↳ account_cooldownobjectCooldown before re-contacting any contact at the same account
↳ enabledbooleanWhether the cooldown is enforced
↳ daysnumberLength of the cooldown window in days (Monaco defaults to 90)
↳ max_contacts_in_sequenceobjectCap on simultaneously-active contacts per account
↳ enabledbooleanWhether the cap is enforced
↳ max_contactsnumberMaximum contacts per account allowed in sequences simultaneously (Monaco defaults to 5)
↳ allow_non_account_owner_campaignsobjectAllow enrolling contacts whose account owner is not a campaign sender
↳ enabledbooleanWhether this rule is enforced for the campaign
↳ allow_stop_and_dismiss_on_account_statusobjectStop and dismiss sequences when an account changes to certain statuses
↳ enabledbooleanWhether the rule is enforced for the trigger statuses
↳ statusesarrayAccount statuses that trigger the rule (NEW, PROSPECTING, OPPORTUNITY, CUSTOMER, DISQUALIFIED, NURTURE, INBOUND, CHURNED); null inherits the org's default set
↳ exclude_sequences_on_account_statusobjectExclude not-yet-started sequences when an account is in (or transitions into) certain statuses; already-active sequences are unaffected
↳ enabledbooleanWhether the rule is enforced for the trigger statuses
↳ statusesarrayAccount statuses that trigger the rule (NEW, PROSPECTING, OPPORTUNITY, CUSTOMER, DISQUALIFIED, NURTURE, INBOUND, CHURNED); null inherits the org's default set
↳ autopilot_modestringautopilot when every sender auto-sends, supervised when none do, hybrid when it is a mix
↳ autopilot_settingsobjectSenders currently on autopilot and their daily send-release cap
↳ sender_ratesarraySenders on autopilot; senders not listed need manual approval before each send
↳ sender_idstringID of the sending user
↳ daily_rate_targetnumberDaily cap on auto-released sends for this sender
↳ contact_readiness_settingsobjectChecks run on each contact before its sequence starts
↳ emailobjectEmail lookup and verification before the sequence starts
↳ check_on_enrollbooleanWhether to find and verify each contact's email on enrollment, before the sequence starts
↳ on_failurestringWhat happens when a contact's email can't be found or verified: exclude (the sequence is excluded) or skip_channel_steps (its email steps are skipped)
Was this helpful?
Suggest an edit