openapi-directory/api/salesloft.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.salesloft.com"}],"info":{"contact":{"email":"integrations@salesloft.com","x-twitter":"SalesLoft"},"description":"SalesLoft helps transform sales teams into modern sales organizations  - converting more target accounts into customer accounts\n","title":"SalesLoft Platform","version":"v2","x-apisguru-categories":["customer_relation"],"x-logo":{"url":"https://twitter.com/SalesLoft/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developers.salesloft.com/v2_api_def.json","version":"3.0"}],"x-providerName":"salesloft.com"},"tags":[{"description":"User Information","name":"Me"},{"description":"Team Information","name":"Team"},{"description":"Account Management","name":"Accounts"},{"description":"Account Stage Management","name":"Account Stages"},{"description":"Account Tier Information","name":"Account Tiers"},{"description":"Account Upsert","name":"Account Upsert"},{"description":"Actions","name":"Actions"},{"description":"Actions - Call Instructions","name":"Action Details - Call Instructions"},{"description":"Activities","name":"Activities"},{"description":"Activity Histories","name":"Activity Histories"},{"description":"Bulk Jobs","name":"Bulk Jobs"},{"description":"Bulk Jobs - Job Data","name":"Bulk Jobs - Job Data"},{"description":"Bulk Jobs - Results","name":"Bulk Jobs - Results"},{"description":"Cadence Exports","name":"Cadence Exports"},{"description":"Cadence Importing","name":"Cadence Imports"},{"description":"Cadence Management","name":"Cadences"},{"description":"Cadence Membership","name":"Cadence Memberships"},{"description":"Calendar Events","name":"Calendar Events"},{"description":"Call Data Record Management","name":"Call Data Records"},{"description":"Call Dispositions","name":"Call Dispositions"},{"description":"Call Management","name":"Calls"},{"description":"Call Sentiments","name":"Call Sentiments"},{"description":"Caller ID Information","name":"Caller IDs"},{"description":"Conversations Calls","name":"Conversations Calls"},{"description":"CRM Activity Fields","name":"CRM Activity Fields"},{"description":"CRM Activity Management","name":"CRM Activities"},{"description":"Crm Users","name":"Crm Users"},{"description":"Custom Field Management","name":"Custom Fields"},{"description":"Email Management","name":"Emails"},{"description":"Email Template Attachments","name":"Email Template Attachments"},{"description":"Email Templates Management","name":"Email Templates"},{"description":"External Emails","name":"External Emails"},{"description":"Group Management","name":"Groups"},{"description":"Import Management","name":"Imports"},{"description":"Live Feed Items","name":"Live Feed Items"},{"description":"Live Website Tracking Parameters","name":"Live Website Tracking Parameters"},{"description":"Meetings","name":"Meetings"},{"description":"Meetings Settings","name":"Meeting Settings"},{"description":"Meetings Settings - Searches","name":"Meetings Settings - Searches"},{"description":"MIME content for email","name":"Mime Email Payloads"},{"description":"Note Management","name":"Notes"},{"description":"Ongoing Actions","name":"Ongoing Actions"},{"description":"Pending Emails","name":"Pending Emails"},{"description":"Person Management","name":"People"},{"description":"Person Stage Management","name":"Person Stages"},{"description":"Person Upsert","name":"Person Upsert"},{"description":"Phone Number Assignments","name":"Phone Number Assignments"},{"description":"Recording Settings Information","name":"Recording Settings"},{"description":"Role Information","name":"Roles"},{"description":"Saved List Views","name":"Saved List Views"},{"description":"Steps","name":"Steps"},{"description":"Success Management","name":"Successes"},{"description":"Tags","name":"Tags"},{"description":"Tasks","name":"Tasks"},{"description":"Team Template Attachments","name":"Team Template Attachments"},{"description":"Team Template Management","name":"Team Templates"},{"description":"User Management","name":"Users"},{"description":"Webhook Subscriptions","name":"Webhook Subscriptions"}],"paths":{"/v2/account_stages.json":{"get":{"description":"Fetches multiple account stage records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of account stages to fetch. If a record can't be found, that record won't be returned and your request will be successful","explode":false,"in":"query","name":"ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","explode":false,"in":"query","name":"updated_at","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Key to sort on, must be one of: created_at, updated_at, order. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}},{"description":"Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data","in":"query","name":"limit_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/AccountStage"},"type":"array"}}},"description":"Success"}},"summary":"List account stages","tags":["Account Stages"]}},"/v2/account_stages/{id}.json":{"get":{"description":"Fetches an account stage, by ID only.\n","parameters":[{"description":"Account Stage ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountStage"}}},"description":"Success"}},"summary":"Fetch an account stage","tags":["Account Stages"]}},"/v2/account_tiers.json":{"get":{"description":"Fetches multiple account tier records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of Account Tiers to fetch. If a record can't be found, that record won't be returned and your request will be successful","explode":false,"in":"query","name":"ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Filters Account Tiers by name. Multiple names can be applied","explode":false,"in":"query","name":"name","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Key to sort on, must be one of: created_at, updated_at, order. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}},{"description":"Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data","in":"query","name":"limit_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/AccountTier"},"type":"array"}}},"description":"Success"}},"summary":"List Account Tiers","tags":["Account Tiers"]}},"/v2/account_tiers/{id}.json":{"get":{"description":"Fetches an account tier, by ID only.\n","parameters":[{"description":"Account Tier ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountTier"}}},"description":"Success"}},"summary":"Fetch an account tier","tags":["Account Tiers"]}},"/v2/account_upserts.json":{"post":{"description":"Upserts an account record. The upsert_key dictates how the upsert will be performed. The create and update behavior\nis exactly the same as the individual create and update endpoints.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"account_tier_id":{"description":"ID of the Account Tier for this Account","type":"integer"},"city":{"description":"City","type":"string"},"company_stage_id":{"description":"ID of the CompanyStage assigned to this Account","type":"integer"},"company_type":{"description":"Type of the Account's company","type":"string"},"conversational_name":{"description":"Conversational name of the Account","type":"string"},"country":{"description":"Country","type":"string"},"crm_id":{"description":"Requires Salesforce.\n\nID of the person in your external CRM. You must provide a crm_id_type if this is included.\n\nValidations will be applied to the crm_id depending on the crm_id_type. A \"salesforce\" ID must be exactly 18 characters. A \"salesforce\" ID must be either an Account (001) object. The type will be validated using the 18 character ID.\n\nThis field can only be used if your application or API key has the \"account:set_crm_id\" scope.\n\n","type":"string"},"crm_id_type":{"description":"The CRM that the provided crm_id is for. Must be one of: salesforce","type":"string"},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","items":{"type":"object"},"type":"array"},"description":{"description":"Description","type":"string"},"do_not_contact":{"description":"Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications","type":"boolean"},"domain":{"description":"Website domain, not a fully qualified URI","type":"string"},"founded":{"description":"Date or year of founding","type":"string"},"id":{"description":"ID of the account to update. Used if the upsert_key=id. When id and another upsert_key are provided,\nthe request will fail if the upsert record id and id parameter don't match.\n","type":"integer"},"industry":{"description":"Industry","type":"string"},"linkedin_url":{"description":"Full LinkedIn url","type":"string"},"locale":{"description":"Time locale","type":"string"},"name":{"description":"Account Full Name","type":"string"},"owner_id":{"description":"ID of the User that owns this Account","type":"integer"},"phone":{"description":"Phone number without formatting","type":"string"},"postal_code":{"description":"Postal code","type":"string"},"revenue_range":{"description":"Estimated revenue range","type":"string"},"size":{"description":"Estimated number of people in employment","type":"string"},"state":{"description":"State","type":"string"},"street":{"description":"Street name and number","type":"string"},"tags":{"description":"All tags applied to this Account","items":{"type":"string"},"type":"array"},"twitter_handle":{"description":"Twitter handle, with @","type":"string"},"upsert_key":{"description":"Name of the parameter to upsert on. The field must be provided in the input parameters, or the request will fail.\nThe request will also fail if there are multiple records matched by the upsert field.\n\nIf upsert_key is not provided, this endpoint will not update an existing record.\n\nValid options are: id, crm_id, domain. If crm_id is provided, then a valid crm_id_type must be provided, as documented\nfor the account create and update endpoints.\n","type":"string"},"website":{"description":"Website","type":"string"}},"required":["name","domain"],"type":"object"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountUpsert"}}},"description":"Success"}},"summary":"Upsert an account","tags":["Account Upsert"]}},"/v2/accounts.json":{"get":{"description":"Fetches multiple account records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of accounts to fetch. If a record can't be found, that record won't be returned and your request will be successful","explode":false,"in":"query","name":"ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Filters accounts by crm_id. Multiple crm ids can be applied","explode":false,"in":"query","name":"crm_id","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by the tags applied to the account. Multiple tags can be applied","explode":false,"in":"query","name":"tag","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by the tag id's applied to the account. Multiple tag id's can be applied","explode":false,"in":"query","name":"tag_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Equality filters that are applied to the created_at field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","explode":false,"in":"query","name":"created_at","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","explode":false,"in":"query","name":"updated_at","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Domain of the accounts to fetch. Domains are unique and lowercase","in":"query","name":"domain","required":false,"schema":{"type":"string"}},{"description":"Filters accounts by website. Multiple websites can be applied. An additional value of \"_is_null\" can be passed to filter accounts that do not have a website.","explode":false,"in":"query","name":"website","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by archived_at status. Returns only accounts where archived_at is not null if this field is true. Returns only accounts where archived_at is null if this field is false. Do not pass this parameter to return both archived and unarchived accounts. This filter is not applied if any value other than \"true\" or \"false\" is passed.","in":"query","name":"archived","required":false,"schema":{"type":"boolean"}},{"description":"Names of accounts to fetch. Name matches are exact and case sensitive. Multiple names can be fetched.","explode":false,"in":"query","name":"name","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by account_stage_id. Multiple account_stage_ids can be applied. An additional value of \"_is_null\" can be passed to filter accounts that do not have account_stage_id","explode":false,"in":"query","name":"account_stage_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Filters accounts by account_tier_id. Multiple account tier ids can be applied","explode":false,"in":"query","name":"account_tier_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Filters accounts by owner_id. Multiple owner_ids can be applied. An additional value of \"_is_null\" can be passed to filter accounts that are unowned","explode":false,"in":"query","name":"owner_id","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by whether the owner is active or not.","in":"query","name":"owner_is_active","required":false,"schema":{"type":"boolean"}},{"description":"Equality filters that are applied to the last_contacted field. A single filter can be used by itself or combined with other filters to create a range.\nAdditional values of \"_is_null\" or \"_is_not_null\" can be passed to filter records that either have no timestamp value or any timestamp value.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"last_contacted","required":false,"schema":{"type":"object"}},{"description":"Filters by accounts matching all given custom fields. The custom field names are case-sensitive, but the provided values are case-insensitive. Example: v2/accounts?custom_fields[custom_field_name]=custom_field_value","in":"query","name":"custom_fields","required":false,"schema":{"type":"object"}},{"description":"Filters accounts by industry by exact match. Supports partial matching","explode":false,"in":"query","name":"industry","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by country by exact match. Supports partial matching","explode":false,"in":"query","name":"country","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by state by exact match. Supports partial matching","explode":false,"in":"query","name":"state","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by city by exact match. Supports partial matching","explode":false,"in":"query","name":"city","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by owner_crm_id. Multiple owner_crm_ids can be applied. An additional value of \"_is_null\" can be passed to filter accounts that are unowned. A \"_not_in\" modifier can be used to exclude specific owner_crm_ids. Example: v2/accounts?owner_crm_id[_not_in]=id","explode":false,"in":"query","name":"owner_crm_id","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters accounts by locale. Multiple locales are allowed","explode":false,"in":"query","name":"locales","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters by accounts matching all given user relationship fields, _is_null or _unmapped can be passed to filter accounts with null or unmapped user relationship values. Example: v2/accounts?user_relationships[name]=value","in":"query","name":"user_relationships","required":false,"schema":{"type":"object"}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_contacted_at, account_stage, account_stage_name, account_tier, account_tier_name, name, counts_people. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}},{"description":"Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data","in":"query","name":"limit_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Account"},"type":"array"}}},"description":"Success"}},"summary":"List accounts","tags":["Accounts"]},"post":{"description":"Creates an account.\n\n\"domain\" must be unique on the current team.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"account_tier_id":{"description":"ID of the Account Tier for this Account","type":"integer"},"city":{"description":"City","type":"string"},"company_stage_id":{"description":"ID of the CompanyStage assigned to this Account","type":"integer"},"company_type":{"description":"Type of the Account's company","type":"string"},"conversational_name":{"description":"Conversational name of the Account","type":"string"},"country":{"description":"Country","type":"string"},"crm_id":{"description":"Requires Salesforce.\n\nID of the person in your external CRM. You must provide a crm_id_type if this is included.\n\nValidations will be applied to the crm_id depending on the crm_id_type. A \"salesforce\" ID must be exactly 18 characters. A \"salesforce\" ID must be either an Account (001) object. The type will be validated using the 18 character ID.\n\nThis field can only be used if your application or API key has the \"account:set_crm_id\" scope.\n\n","type":"string"},"crm_id_type":{"description":"The CRM that the provided crm_id is for. Must be one of: salesforce","type":"string"},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","items":{"type":"object"},"type":"array"},"description":{"description":"Description","type":"string"},"do_not_contact":{"description":"Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications","type":"boolean"},"domain":{"description":"Website domain, not a fully qualified URI","type":"string"},"founded":{"description":"Date or year of founding","type":"string"},"industry":{"description":"Industry","type":"string"},"linkedin_url":{"description":"Full LinkedIn url","type":"string"},"locale":{"description":"Time locale","type":"string"},"name":{"description":"Account Full Name","type":"string"},"owner_id":{"description":"ID of the User that owns this Account","type":"integer"},"phone":{"description":"Phone number without formatting","type":"string"},"postal_code":{"description":"Postal code","type":"string"},"revenue_range":{"description":"Estimated revenue range","type":"string"},"size":{"description":"Estimated number of people in employment","type":"string"},"state":{"description":"State","type":"string"},"street":{"description":"Street name and number","type":"string"},"tags":{"description":"All tags applied to this Account","items":{"type":"string"},"type":"array"},"twitter_handle":{"description":"Twitter handle, with @","type":"string"},"website":{"description":"Website","type":"string"}},"required":["name","domain"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Success"}},"summary":"Create an account","tags":["Accounts"]}},"/v2/accounts/{id}.json":{"delete":{"description":"Deletes an account. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.\n\nDeleting an account will remove all connected people from that account.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Account has been deleted successfully"}},"summary":"Delete an account","tags":["Accounts"]},"get":{"description":"Fetches an account, by ID only.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Success"}},"summary":"Fetch an account","tags":["Accounts"]},"put":{"description":"Updates an account.\n\n\"domain\" must be unique on the current team.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"account_tier_id":{"description":"ID of the Account Tier for this Account","type":"integer"},"archived":{"description":"Whether this Account should be archived or not. Setting this to true sets archived_at to the current time if it's not already set. Setting this to false will set archived_at to null","type":"boolean"},"city":{"description":"City","type":"string"},"company_stage_id":{"description":"ID of the CompanyStage assigned to this Account","type":"integer"},"company_type":{"description":"Type of the Account's company","type":"string"},"conversational_name":{"description":"Conversational name of the Account","type":"string"},"country":{"description":"Country","type":"string"},"crm_id":{"description":"Requires Salesforce.\n\nID of the person in your external CRM. You must provide a crm_id_type if this is included.\n\nValidations will be applied to the crm_id depending on the crm_id_type. A \"salesforce\" ID must be exactly 18 characters. A \"salesforce\" ID must be either an Account (001) object. The type will be validated using the 18 character ID.\n\nThis field can only be used if your application or API key has the \"account:set_crm_id\" scope.\n\n","type":"string"},"crm_id_type":{"description":"The CRM that the provided crm_id is for. Must be one of: salesforce","type":"string"},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","items":{"type":"object"},"type":"array"},"description":{"description":"Description","type":"string"},"do_not_contact":{"description":"Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications","type":"boolean"},"domain":{"description":"Website domain, not a fully qualified URI","type":"string"},"founded":{"description":"Date or year of founding","type":"string"},"industry":{"description":"Industry","type":"string"},"linkedin_url":{"description":"Full LinkedIn url","type":"string"},"locale":{"description":"Time locale","type":"string"},"name":{"description":"Account Full Name","type":"string"},"owner_id":{"description":"ID of the User that owns this Account","type":"integer"},"phone":{"description":"Phone number without formatting","type":"string"},"postal_code":{"description":"Postal code","type":"string"},"revenue_range":{"description":"Estimated revenue range","type":"string"},"size":{"description":"Estimated number of people in employment","type":"string"},"state":{"description":"State","type":"string"},"street":{"description":"Street name and number","type":"string"},"tags":{"description":"All tags applied to this Account","items":{"type":"string"},"type":"array"},"twitter_handle":{"description":"Twitter handle, with @","type":"string"},"website":{"description":"Website","type":"string"}},"required":["name","domain"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Success"}},"summary":"Update an existing Account","tags":["Accounts"]}},"/v2/action_details/call_instructions.json":{"get":{"description":"Fetches multiple call instruction records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of call instructions to fetch.","explode":false,"in":"query","name":"ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}},{"description":"Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data","in":"query","name":"limit_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CallInstruction"},"type":"array"}}},"description":"Success"}},"summary":"List call instructions","tags":["Action Details - Call Instructions"]}},"/v2/action_details/call_instructions/{id}.json":{"get":{"description":"Fetches a call instruction, by ID only.\n","parameters":[{"description":"Call instructions ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CallInstruction"}}},"description":"Success"}},"summary":"Fetch a call instructions","tags":["Action Details - Call Instructions"]}},"/v2/actions.json":{"get":{"description":"Fetches multiple action records. The records can be filtered, paged, and sorted according to\nthe respective parameters. Only actions that are currently \"in_progess\" will be returned by\nthis endpoint.\n\nIf the requester is not an admin, this endpoint will only return actions belonging to the requester.\nIf the request is an admin, this endpoint will return actions for the entire team. Additionaly, an admin\nmay use the user_guid parameter to request actions that belong to specific users on the team.\n","parameters":[{"description":"IDs of actions to fetch.","explode":false,"in":"query","name":"ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Fetch actions by step ID","in":"query","name":"step_id","required":false,"schema":{"type":"integer"}},{"description":"Filter actions by type","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Equality filters that are applied to the due_on field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","explode":false,"in":"query","name":"due_on","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters actions by the user's guid. Multiple user guids can be applied. The user must be a team admin to filter other users' actions","explode":false,"in":"query","name":"user_guid","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters actions by person_id. Multiple person ids can be applied","explode":false,"in":"query","name":"person_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Filters actions by cadence_id. Multiple cadence ids can be applied","explode":false,"in":"query","name":"cadence_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Filters actions by multitouch_group_id. Multiple multitouch group ids can be applied","explode":false,"in":"query","name":"multitouch_group_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","explode":false,"in":"query","name":"updated_at","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}},{"description":"Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data","in":"query","name":"limit_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Action"},"type":"array"}}},"description":"Success"}},"summary":"List actions","tags":["Actions"]}},"/v2/actions/{id}.json":{"get":{"description":"Fetches an action, by ID only.\nThis endpoint will only return actions that are in_progress or pending_activity.\nOnce an action is complete, the request for that action will return a 404 status code.\n","parameters":[{"description":"Action ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Action"}}},"description":"Success"}},"summary":"Fetch an action","tags":["Actions"]}},"/v2/activities.json":{"post":{"description":"Creates an activity. An activity will mark the associated action as completed. Currently,\nonly certain action types can have an activity explicitly created for them.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"action_id":{"description":"Action that is being completed. This will validate that the action is still\nvalid before completed it. The same action can never be successfully passed twice to this endpoint.\nThe action must have a type of 'integration'.\n","type":"integer"},"task_id":{"description":"Task that is being completed. This will validate that the task is still\nvalid before completed it. The same action can never be successfully passed twice to this endpoint.\nThe task must have a type of 'integration'.\n","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Activity"}}},"description":"Success"}},"summary":"Create an activity","tags":["Activities"]}},"/v2/activities/calls.json":{"get":{"description":"Fetches multiple call records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of calls to fetch. If a record can't be found, that record won't be returned and your request will be successful","explode":false,"in":"query","name":"ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Equality filters that are applied to the created_at field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","explode":false,"in":"query","name":"created_at","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","explode":false,"in":"query","name":"updated_at","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters list to only include guids","explode":false,"in":"query","name":"user_guid","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters calls by person_id. Multiple person ids can be applied","explode":false,"in":"query","name":"person_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Filters calls by sentiment. Sentiment matches are exact and case sensitive. Multiple sentiments are allowed.","explode":false,"in":"query","name":"sentiment","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters calls by disposition. Disposition matches are exact and case sensitive. Multiple dispositions are allowed.","explode":false,"in":"query","name":"disposition","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}},{"description":"Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data","in":"query","name":"limit_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Call"},"type":"array"}}},"description":"Success"}},"summary":"List calls","tags":["Calls"]},"post":{"description":"Creates a call. The parameters of this endpoint can be used to create an action\nand ensure that the CRM Task is mapped correctly.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"action_id":{"description":"Action that this call is being logged for. This will validate that the action is still\nvalid before completing it. The same action can never be successfully passed twice to this endpoint. The\naction must have a type of 'phone'.\n","type":"integer"},"crm_params":{"description":"CRM specific parameters. Some parameters are required on a per-team basis. Consume the\nCrmActivityFields endpoint to receive a list of valid parameters. The \"field\" property\nis passed as the key of this object, and the value of this object is the value that you\nwould like to set.\n\nIf CrmActivityField has a non-null value, then that value must be submitted, or excluded\nfrom API calls, as these values are automatically applied.\n","type":"object"},"disposition":{"description":"The disposition of the call. Can be required on a per-team basis. Must be present in the disposition list.","type":"string"},"duration":{"description":"The length of the call, in seconds","type":"integer"},"linked_call_data_record_ids":{"description":"CallDataRecord associations that will become linked to the created call. It is possible to pass\nmultiple CallDataRecord ids in this field; this can be used to represent multiple phone calls\nthat made up a single call.\n\nAny call data record that is used must not already be linked to a call. It is not possible\nto link a call data record to multiple calls, and it is not possible to re-assign a call data\nrecord to a different call.\n","items":{"type":"integer"},"type":"array"},"notes":{"description":"Notes to log for the call. This is similar to the notes endpoint, but ensures that the notes get synced to the user's CRM","type":"string"},"person_id":{"description":"The ID of the person whom this call will be logged for","type":"integer"},"sentiment":{"description":"The sentiment of the call. Can be required on a per-team basis. Must be present in the sentiment list.","type":"string"},"to":{"description":"The phone number that was called","type":"string"},"user_guid":{"description":"Guid of the user whom this call should be logged for. Defaults to the authenticated user. Only team admins can pass another user's guid","type":"string"}},"required":["person_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Call"}}},"description":"Success"}},"summary":"Create a call","tags":["Calls"]}},"/v2/activities/calls/{id}.json":{"get":{"description":"Fetches a call, by ID only.\n","parameters":[{"description":"Call ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Call"}}},"description":"Success"}},"summary":"Fetch a call","tags":["Calls"]}},"/v2/activities/emails.json":{"get":{"description":"Fetches multiple email records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of emails to fetch. If a record can't be found, that record won't be returned and your request will be successful","explode":false,"in":"query","name":"ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than