openapi: 3.1.0 info: title: Apollo API Reference version: "1.0" summary: API servers: - url: "https://api.vessel.dev" security: - VesselAPIToken: [] paths: /api/actions/apollo/accounts/create: post: responses: '200': description: OK content: application/json: schema: type: object properties: account: type: object properties: id: type: string name: type: - string - 'null' websiteUrl: type: - string - 'null' estimatedNumEmployees: type: - number - 'null' industry: type: - string - 'null' organizationRawAddress: type: - string - 'null' organizationCity: type: - string - 'null' organizationStreetAddress: type: - string - 'null' organizationState: type: - string - 'null' organizationCountry: type: - string - 'null' organizationPostalCode: type: - string - 'null' domain: type: - string - 'null' ownerId: type: - string - 'null' lastActivityDate: anyOf: - type: string format: date-time - type: 'null' sanitizedPhone: type: - string - 'null' typedCustomFields: type: object properties: {} createdAt: type: string format: date-time required: - id - created_at examples: example-1: value: account: id: in deserunt Ut reprehenderit estimatedNumEmployees: null websiteUrl: fugiat sed nostrud sit incididunt organizationPostalCode: null createdAt: '1968-11-11T09:51:40.0Z' organizationState: veniam sit lastActivityDate: null industry: null name: null organizationStreetAddress: null ownerId: null organizationCity: tempor laboris cillum organizationRawAddress: voluptate sed ullamco exercitation organizationCountry: null sanitizedPhone: null domain: nulla quis cupidatat eiusmod typedCustomFields: {} requestBody: content: application/json: schema: type: object properties: name: type: - string - 'null' domain: type: - string - 'null' phone: type: - string - 'null' examples: example-1: value: name: fugiat eiusmod est domain: minim pariatur phone: null operationId: create-account parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/accounts/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: accounts: type: array items: type: object properties: id: type: string name: type: - string - 'null' websiteUrl: type: - string - 'null' estimatedNumEmployees: type: - number - 'null' industry: type: - string - 'null' organizationRawAddress: type: - string - 'null' organizationCity: type: - string - 'null' organizationStreetAddress: type: - string - 'null' organizationState: type: - string - 'null' organizationCountry: type: - string - 'null' organizationPostalCode: type: - string - 'null' domain: type: - string - 'null' ownerId: type: - string - 'null' lastActivityDate: anyOf: - type: string format: date-time - type: 'null' sanitizedPhone: type: - string - 'null' typedCustomFields: type: object properties: {} createdAt: type: string format: date-time required: - id - created_at pagination: type: object properties: page: type: - number - 'null' perPage: type: number totalEntries: type: number totalPages: type: number required: - page - per_page - total_entries - total_pages examples: example-1: value: accounts: - id: ex organizationPostalCode: null websiteUrl: Lorem in cillum commodo name: null ownerId: null organizationRawAddress: null sanitizedPhone: laborum magna ipsum organizationState: null domain: sint irure cillum et sunt organizationCity: Duis culpa nisi non tempor organizationStreetAddress: null lastActivityDate: null createdAt: '1998-02-13T02:51:42.0Z' organizationCountry: occaecat cillum laboris voluptate estimatedNumEmployees: 67370679.50048807 industry: laboris occaecat elit eiusmod typedCustomFields: {} pagination: page: null totalEntries: -94639301.4333235 totalPages: 17734680.960502043 perPage: 92941126.84197268 requestBody: content: application/json: schema: type: object properties: qOrganizationName: type: string page: type: number examples: example-1: value: qOrganizationName: aliqua page: 70115309.38806385 operationId: search-account parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/accounts/update: post: responses: '200': description: OK content: application/json: schema: type: object properties: account: type: object properties: id: type: string name: type: - string - 'null' websiteUrl: type: - string - 'null' estimatedNumEmployees: type: - number - 'null' industry: type: - string - 'null' organizationRawAddress: type: - string - 'null' organizationCity: type: - string - 'null' organizationStreetAddress: type: - string - 'null' organizationState: type: - string - 'null' organizationCountry: type: - string - 'null' organizationPostalCode: type: - string - 'null' domain: type: - string - 'null' ownerId: type: - string - 'null' lastActivityDate: anyOf: - type: string format: date-time - type: 'null' sanitizedPhone: type: - string - 'null' typedCustomFields: type: object properties: {} createdAt: type: string format: date-time required: - id - created_at examples: example-1: value: account: id: ut quis organizationPostalCode: null organizationRawAddress: null websiteUrl: ex id Lorem Excepteur elit industry: null sanitizedPhone: null organizationState: Ut et organizationStreetAddress: null createdAt: '1973-11-02T14:42:50.0Z' organizationCity: null lastActivityDate: '1987-10-26T21:47:10.0Z' name: null organizationCountry: null domain: eiusmod aliqua adipisicing amet estimatedNumEmployees: 4961864.883238703 ownerId: fugiat aliquip laboris dolor typedCustomFields: {} requestBody: content: application/json: schema: type: object properties: id: type: string name: type: - string - 'null' domain: type: - string - 'null' phone: type: - string - 'null' examples: example-1: value: id: Duis sint laboris proident name: nisi magna in Excepteur domain: null phone: commodo ex Excepteur ut operationId: update-account parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/activities/list: post: responses: '200': description: OK content: application/json: schema: type: object properties: activities: type: array items: type: object properties: id: type: string type: type: string emailerMessageId: type: string emailerMessage: type: object properties: id: type: string bodyText: type: - string - 'null' bodyHtml: type: - string - 'null' bounce: type: - boolean - 'null' completedAt: anyOf: - type: string format: date-time - type: 'null' contactId: type: string createdAt: type: string format: date-time emailerCampaignId: type: - string - 'null' fromEmail: type: string fromName: type: - string - 'null' numClicks: type: - number - 'null' numOpens: type: - number - 'null' replied: type: - boolean - 'null' status: type: - string - 'null' subject: type: - string - 'null' userId: type: string required: - id - contact_id - created_at - from_email - user_id required: - id - type - emailer_message_id - emailer_message examples: example-1: value: activities: - id: incididunt quis ad cillum sunt type: mollit laborum dolore culpa Excepteur emailerMessage: id: dolor ea consequat numOpens: 42325172.37951955 userId: dolore dolor non anim bodyText: null createdAt: '2014-10-25T01:10:35.0Z' subject: esse numClicks: null replied: null contactId: adipisicing labore Lorem veniam fromEmail: dolor reprehenderit labore ut fromName: ex aliquip emailerCampaignId: null completedAt: null status: null bounce: null bodyHtml: null emailerMessageId: eu in esse enim requestBody: content: application/json: schema: type: object properties: contactId: type: string types: type: array items: type: string examples: example-1: value: contactId: dolor irure Duis quis types: - dolore adipisicing nulla sit operationId: list-activities parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/contacts/create: post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' name: type: - string - 'null' title: type: - string - 'null' ownerId: type: - string - 'null' presentRawAddress: type: - string - 'null' phoneNumbers: type: array items: type: object properties: rawNumber: type: string sanitizedNumber: type: - string - 'null' type: type: string enum: - mobile - home - work_hq - work_direct - other position: type: number status: type: - string - 'null' dncStatus: type: - string - 'null' required: - raw_number - type - position organizationName: type: - string - 'null' email: type: - string - 'null' websiteUrl: type: - string - 'null' contactStageId: type: - string - 'null' accountId: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time linkedinUrl: type: - string - 'null' typedCustomFields: type: object properties: {} required: - id - phone_numbers - created_at - updated_at - typed_custom_fields examples: example-1: value: contact: id: aliquip ea eu Ut websiteUrl: exercitation in sit culpa occaecat presentRawAddress: incididunt reprehenderit est qui dolore phoneNumbers: - type: work_hq position: 47457977.40565795 sanitizedNumber: cupidatat eu status: null rawNumber: culpa in velit adipisicing sint dncStatus: nisi Excepteur Lorem name: elit deserunt ut linkedinUrl: null accountId: null typedCustomFields: {} organizationName: non adipisicing ipsum ut Excepteur lastName: null contactStageId: Ut fugiat title: cillum Excepteur irure firstName: do non Lorem amet veniam email: mollit nostrud do ownerId: adipisicing quis createdAt: '1994-03-12T21:38:45.0Z' updatedAt: '1946-09-21T20:11:15.0Z' requestBody: content: application/json: schema: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' organizationName: type: - string - 'null' title: type: - string - 'null' ownerId: type: - string - 'null' accountId: type: - string - 'null' email: type: - string - 'null' websiteUrl: type: - string - 'null' contactStageId: type: - string - 'null' presentRawAddress: type: - string - 'null' labelNames: anyOf: - type: array items: type: string - type: 'null' examples: example-1: value: firstName: consequat in lastName: null organizationName: null title: null ownerId: null accountId: laboris proident email: in cillum laboris reprehenderit sed websiteUrl: deserunt contactStageId: null presentRawAddress: ipsum ex labelNames: null operationId: create-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/contacts/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: contacts: type: array items: type: object properties: id: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' name: type: - string - 'null' title: type: - string - 'null' ownerId: type: - string - 'null' presentRawAddress: type: - string - 'null' phoneNumbers: type: array items: type: object properties: rawNumber: type: string sanitizedNumber: type: - string - 'null' type: type: string enum: - mobile - home - work_hq - work_direct - other position: type: number status: type: - string - 'null' dncStatus: type: - string - 'null' required: - raw_number - type - position organizationName: type: - string - 'null' email: type: - string - 'null' websiteUrl: type: - string - 'null' contactStageId: type: - string - 'null' accountId: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time linkedinUrl: type: - string - 'null' typedCustomFields: type: object properties: {} required: - id - phone_numbers - created_at - updated_at - typed_custom_fields pagination: type: object properties: page: type: - number - 'null' perPage: type: number totalEntries: type: number totalPages: type: number required: - page - per_page - total_entries - total_pages examples: example-1: value: contacts: - id: Duis accountId: null websiteUrl: est nostrud email: null ownerId: null updatedAt: '1956-08-24T19:27:02.0Z' title: qui phoneNumbers: - type: mobile position: -79905883.55043063 status: in dolor enim id qui dncStatus: null sanitizedNumber: null rawNumber: deserunt veniam aute createdAt: '2014-09-16T10:23:05.0Z' name: null contactStageId: dolore nisi voluptate incididunt consectetur lastName: null linkedinUrl: null typedCustomFields: {} presentRawAddress: null organizationName: null firstName: in Ut veniam sint pagination: page: null perPage: -27721305.236202195 totalEntries: -2828745.2465189993 totalPages: -83465761.89624675 requestBody: content: application/json: schema: type: object properties: page: type: number qKeywords: type: string examples: example-1: value: page: -72296540.97571659 qKeywords: sed Lorem non sunt nisi operationId: search-contacts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/contacts/update: post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' name: type: - string - 'null' title: type: - string - 'null' ownerId: type: - string - 'null' presentRawAddress: type: - string - 'null' phoneNumbers: type: array items: type: object properties: rawNumber: type: string sanitizedNumber: type: - string - 'null' type: type: string enum: - mobile - home - work_hq - work_direct - other position: type: number status: type: - string - 'null' dncStatus: type: - string - 'null' required: - raw_number - type - position organizationName: type: - string - 'null' email: type: - string - 'null' websiteUrl: type: - string - 'null' contactStageId: type: - string - 'null' accountId: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time linkedinUrl: type: - string - 'null' typedCustomFields: type: object properties: {} required: - id - phone_numbers - created_at - updated_at - typed_custom_fields examples: example-1: value: contact: id: culpa cupidatat anim ullamco ex firstName: null email: cupidatat nulla laborum Excepteur createdAt: '1971-03-20T06:22:45.0Z' websiteUrl: null contactStageId: in eiusmod title: null presentRawAddress: null phoneNumbers: - type: other position: -28564938.283136547 status: null dncStatus: null rawNumber: pariatur sanitizedNumber: null ownerId: laboris updatedAt: '1959-10-11T17:19:01.0Z' organizationName: proident incididunt anim cupidatat name: null accountId: labore linkedinUrl: null typedCustomFields: {} lastName: Excepteur amet esse est requestBody: content: application/json: schema: type: object properties: id: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' organizationName: type: - string - 'null' title: type: - string - 'null' ownerId: type: - string - 'null' accountId: type: - string - 'null' email: type: - string - 'null' websiteUrl: type: - string - 'null' presentRawAddress: type: - string - 'null' labelNames: anyOf: - type: array items: type: string - type: 'null' examples: example-1: value: id: exercitation id nostrud ea eiusmod firstName: aliquip officia lastName: null organizationName: null title: null ownerId: amet accountId: ad incididunt amet sunt email: null websiteUrl: amet irure presentRawAddress: ea id labelNames: - enim operationId: update-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/custom-fields/create: post: responses: '200': description: OK content: application/json: schema: type: object properties: typedCustomField: type: object properties: id: type: string modality: type: string name: type: string type: type: string required: - id - modality - name - type examples: example-1: value: typedCustomField: id: dolore et modality: elit quis deserunt occaecat consequat name: mollit type: veniam eiusmod Ut adipisicing requestBody: content: application/json: schema: type: object properties: modality: type: string enum: - contact - account name: type: string type: type: string examples: example-1: value: modality: account name: enim id do culpa type: veniam laborum et sed ullamco operationId: create-custom-fields parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/custom-fields/list: post: responses: '200': description: OK content: application/json: schema: type: object properties: typedCustomFields: type: array items: type: object properties: id: type: string modality: type: string name: type: string type: type: string required: - id - modality - name - type examples: example-1: value: typedCustomFields: - id: incididunt magna labore dolor modality: cupidatat ad name: reprehenderit enim dolore type: elit esse anim eiusmod est requestBody: content: application/json: schema: type: object properties: page: type: number examples: example-1: value: page: -82950308.47222939 operationId: list-custom-fields parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/emails/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: emailerMessages: type: array items: type: object properties: id: type: string bodyText: type: - string - 'null' bodyHtml: type: - string - 'null' bounce: type: - boolean - 'null' completedAt: anyOf: - type: string format: date-time - type: 'null' contactId: type: string createdAt: type: string format: date-time emailerCampaignId: type: - string - 'null' fromEmail: type: string fromName: type: - string - 'null' numClicks: type: - number - 'null' numOpens: type: - number - 'null' replied: type: - boolean - 'null' status: type: - string - 'null' subject: type: - string - 'null' userId: type: string required: - id - contact_id - created_at - from_email - user_id examples: example-1: value: emailerMessages: - id: esse ea in sit numOpens: null bodyText: elit emailerCampaignId: eiusmod officia deserunt contactId: adipisicing quis status: laborum Lorem completedAt: '2013-10-13T14:39:57.0Z' createdAt: '1995-01-19T11:53:49.0Z' bounce: true numClicks: null replied: null userId: in voluptate bodyHtml: null subject: elit ut in eiusmod dolore fromEmail: tempor consequat minim non fromName: null requestBody: content: application/json: schema: type: object properties: page: type: number emailerCampaignId: type: string examples: example-1: value: page: -19616594.168063402 emailerCampaignId: do Lorem ad operationId: search-emails parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/email-accounts/list: post: responses: '200': description: OK content: application/json: schema: type: object properties: emailAccounts: type: array items: type: object properties: id: type: string email: type: - string - 'null' default: type: boolean userId: type: - string - 'null' required: - id - default examples: example-1: value: emailAccounts: - id: magna amet elit default: true userId: null email: reprehenderit ipsum id requestBody: content: application/json: schema: type: object properties: page: type: number examples: example-1: value: page: -49703180.58754239 operationId: list-email-accounts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/labels/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: labels: type: array items: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - createdAt - updatedAt examples: example-1: value: labels: - id: in name: in createdAt: '2023-01-19T11:53:49.0Z' updatedAt: '2023-01-19T11:53:49.0Z' requestBody: content: application/json: schema: type: object properties: page: type: number qKeywords: type: string teamListsOnly: type: boolean examples: example-1: value: page: 1 operationId: search-labels parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/people/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: people: type: array items: type: object properties: id: type: string firstName: type: string lastName: type: string name: type: string contacts: type: array items: type: object properties: id: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' name: type: - string - 'null' title: type: - string - 'null' ownerId: type: - string - 'null' presentRawAddress: type: - string - 'null' phoneNumbers: type: array items: type: object properties: rawNumber: type: string sanitizedNumber: type: - string - 'null' type: type: string enum: - mobile - home - work_hq - work_direct - other position: type: number status: type: - string - 'null' dncStatus: type: - string - 'null' required: - raw_number - type - position organizationName: type: - string - 'null' email: type: - string - 'null' websiteUrl: type: - string - 'null' contactStageId: type: - string - 'null' accountId: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time typedCustomFields: type: object properties: {} required: - id - phone_numbers - created_at - updated_at - typed_custom_fields pagination: type: object properties: page: type: - number - 'null' perPage: type: number totalEntries: type: number totalPages: type: number required: - page - per_page - total_entries - total_pages examples: example-1: value: people: - id: abc123 name: Bill Gates firstName: Bill lastName: Gates contacts: - id: Duis accountId: null websiteUrl: est nostrud email: null ownerId: null updatedAt: '1956-08-24T19:27:02.0Z' title: qui phoneNumbers: - type: mobile position: -79905883.55043063 status: in dolor enim id qui dncStatus: null sanitizedNumber: null rawNumber: deserunt veniam aute createdAt: '2014-09-16T10:23:05.0Z' name: null contactStageId: dolore nisi voluptate incididunt consectetur lastName: null typedCustomFields: {} presentRawAddress: null organizationName: null firstName: in Ut veniam sint pagination: page: null perPage: 10 totalEntries: 10 totalPages: 10 requestBody: content: application/json: schema: type: object properties: page: type: number qKeywords: type: string labelIds: type: array examples: example-1: value: page: 1 operationId: search-people parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/tasks/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: tasks: type: array items: type: object properties: id: type: string userId: type: string createdAt: type: string format: date-time completedAt: type: string format: date-time note: type: string skippedAt: type: string format: date-time dueAt: type: string format: date-time type: type: string priority: type: string status: type: string answered: type: boolean emailerCampaignId: type: string contactId: type: string personId: type: string accountId: type: string organizationId: type: string personaIds: type: array items: type: string subject: type: string createdFrom: type: string salesforceType: type: string playbookStepIds: type: string playbookId: type: array items: type: string needsPlaybookAutoprospecting: type: boolean starredByUserIds: type: array items: type: string salesforceId: type: string hubspotId: type: string contact: type: object account: type: object required: - id - userId pagination: type: object properties: page: type: - number - 'null' perPage: type: number totalEntries: type: number totalPages: type: number required: - page - per_page - total_entries - total_pages examples: example-1: value: tasks: - emailerCampaignId: null id: "5ff3XXXXXXXXXXXXXXXXXXXX" userId: "5fc6XXXXXXXXXXXXXXXXXXXX" createdAt: "2021-01-04T15:48:10.467Z" completedAt: null note: null skippedAt: null dueAt: "2021-01-04T15:46:48.361+00:00" type: "action_item" priority: "medium" status: "scheduled" answered: null contactId: "5fd1XXXXXXXXXXXXXXXXXXXX" personId: null accountId: "5fd1XXXXXXXXXXXXXXXXXXXX" organizationId: null personaIds: [] subject: null createdFrom: "zp_ui" salesforceType: null playbookStepIds: [] playbookId: null needsPlaybookAutoprospecting: null starredByUserIds: [] salesforceId: null hubspotId: null account: id: "5fd1XXXXXXXXXXXXXXXXXXXX" name: "google" domain: ".com" websiteUrl: "www.google.com" estimatedNumEmployees: 100000 industry: null organizationRawAddress: null organizationCity: null organizationStreetAddress: null organizationState: null organizationCountry: null organizationPostalCode: null ownerId: null lastActivityDate: null sanitizedPhone: null createdAt: "2020-12-09T21:41:57.503Z" contact: id: "5fd1XXXXXXXXXXXXXXXXXXXX" firstName: "John" lastName: "Doe" name: "John Doe" title: "Senior QA Specialist" ownerId: "5fc6XXXXXXXXXXXXXXXXXXXX" presentRawAddress: "Washington, District of Columbia, United States" email: "email@domain.io" phoneNumbers: [] createdAt: "2020-12-09T21:41:57.503Z" accountId: "5fd1XXXXXXXXXXXXXXXXXXXX" updatedAt: "2020-12-28T10:51:37.432Z" pagination: page: null totalEntries: -95622675.08575992 perPage: 80845744.49505061 totalPages: -12938224.005571365 requestBody: content: application/json: schema: type: object properties: userIds: type: array items: type: string sequenceIds: type: array items: type: string sortAscending: type: boolean sortByField: type: string page: type: number examples: example-1: value: userIds: - "123123" sequenceIds: - "649dcfc3d37c3400a3bcdf78" sortAscending: false sortByField: "task_due_at" page: 1 operationId: search-tasks parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/tasks/mark-complete: post: responses: '200': description: OK content: application/json: schema: type: object properties: tasks: type: array items: type: object properties: id: type: string required: - id examples: example-1: value: tasks: - id: "123123" - id: "456456" requestBody: content: application/json: schema: type: object properties: ids: type: array items: type: string examples: example-1: value: ids: - "123123" - "456456" operationId: tasks-mark-complete parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/calls/create: post: responses: '200': description: OK content: application/json: schema: type: object properties: call: type: object properties: id: type: - string userId: type: - string contactId: type: - string - 'null' accountId: type: - string - 'null' dispositionId: type: - string - 'null' recordingUrl: type: - string - 'null' inbound: type: - string - 'null' fromNumber: type: - string - 'null' toNumber: type: - string - 'null' startTime: type: - string - 'null' format: date-time endTime: type: - string - 'null' format: date-time noteText: type: - string - 'null' duration: type: - string - 'null' required: - id - userId - contactId examples: example-1: value: call: id: "123123" userId: "456456" contactId: "678678" accountId: "890890" dispositionId: "123123" recordingUrl: "www.example.com" inbound: true fromNumber: "555-555-5555" toNumber: "555-555-5555" startTime: "2020-01-01T00:00:00Z" endTime: "2020-01-01T00:00:00Z" noteText: "sample note text" duration: 0 requestBody: content: application/json: schema: type: object properties: contactId: type: - string - 'null' dispositionId: type: - string - 'null' purposeId: type: - string - 'null' note: type: - string - 'null' fromNumber: type: - string - 'null' toNumber: type: - string - 'null' durationSeconds: type: - number - 'null' markComplete: type: - boolean - 'null' inbound: type: - boolean - 'null' examples: example-1: value: contactId: "456456" dispositionId: "789789" purposeId: "789789" note: "example note" fromNumber: "555-555-5555" toNumber: "555-555-5555" durationSeconds: 10 markComplete: true inbound: true operationId: create-call parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/calls/details: post: responses: '200': description: OK content: application/json: schema: type: object properties: dispositions: type: array items: type: object properties: id: type: - string teamId: type: - string name: type: - string answered: type: - boolean - 'null' order: type: - number - 'null' triggerContactStageId: type: - string - 'null' sentiment: type: - string - 'null' required: - id - teamId - name purposes: type: array items: type: object properties: id: type: - string teamId: type: - string name: type: - string settingsListPosition: type: - number - 'null' required: - id - teamId - name examples: example-1: value: dispositions: id: "123123" teamId: "123123" name: "Busy" answered: true order: 123123 triggerContactStageId: "123123" sentiment: "123123" purposes: id: "123123" teamId: "123123" name: "Prospecting" settingsListPosition: 0 requestBody: content: application/json: schema: type: object properties: userId: type: - string - 'null' contactId: type: - string - 'null' dispositionId: type: - string - 'null' note: type: - string - 'null' examples: example-1: value: userId: "123123" contactId: "456456" dispositionId: "789789" note: "example note" operationId: create-call parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/sequences/create: post: responses: '200': description: OK content: application/json: schema: type: object properties: emailerCampaign: type: object properties: id: type: string name: type: - string - 'null' createdAt: type: string format: date-time active: type: boolean labelIds: type: array items: type: string numSteps: type: - number - 'null' userId: type: - string - 'null' uniqueScheduled: anyOf: - type: - number - string - type: 'null' uniqueDelivered: anyOf: - type: - number - string - type: 'null' uniqueBounced: anyOf: - type: - number - string - type: 'null' uniqueOpened: anyOf: - type: - number - string - type: 'null' uniqueReplied: anyOf: - type: - number - string - type: 'null' uniqueDemoed: anyOf: - type: - number - string - type: 'null' uniqueClicked: anyOf: - type: - number - string - type: 'null' uniqueUnsubscribed: anyOf: - type: - number - string - type: 'null' bounceRate: anyOf: - type: - number - string - type: 'null' openRate: anyOf: - type: - number - string - type: 'null' clickRate: anyOf: - type: - number - string - type: 'null' replyRate: anyOf: - type: - number - string - type: 'null' spamBlockedRate: anyOf: - type: - number - string - type: 'null' optOutRate: anyOf: - type: - number - string - type: 'null' demoRate: anyOf: - type: - number - string - type: 'null' required: - id - created_at - active - label_ids examples: example-1: value: emailerCampaign: id: fugiat active: true uniqueClicked: null optOutRate: 11598126.325158864 spamBlockedRate: null name: Excepteur id sit demoRate: -1470897.7760232985 clickRate: -97191880.10046276 uniqueScheduled: null openRate: null uniqueDelivered: -60301467.46348391 bounceRate: null userId: null replyRate: null uniqueReplied: Excepteur nostrud ut aute ut uniqueBounced: non labore labelIds: - est incididunt voluptate uniqueOpened: cupidatat uniqueDemoed: veniam uniqueUnsubscribed: 60839769.018630564 createdAt: '2021-12-29T02:12:31.0Z' numSteps: null requestBody: content: application/json: schema: type: object properties: creationType: type: string name: type: string permissions: type: string type: type: string active: type: boolean examples: example-1: value: creationType: culpa dolore ex nisi name: consequat ullamco do permissions: elit anim exercitation type: adipisicing active: true operationId: create-sequences parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/sequences/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: emailerCampaigns: type: array items: type: object properties: id: type: string name: type: - string - 'null' createdAt: type: string format: date-time active: type: boolean labelIds: type: array items: type: string numSteps: type: - number - 'null' userId: type: - string - 'null' uniqueScheduled: anyOf: - type: - number - string - type: 'null' uniqueDelivered: anyOf: - type: - number - string - type: 'null' uniqueBounced: anyOf: - type: - number - string - type: 'null' uniqueOpened: anyOf: - type: - number - string - type: 'null' uniqueReplied: anyOf: - type: - number - string - type: 'null' uniqueDemoed: anyOf: - type: - number - string - type: 'null' uniqueClicked: anyOf: - type: - number - string - type: 'null' uniqueUnsubscribed: anyOf: - type: - number - string - type: 'null' bounceRate: anyOf: - type: - number - string - type: 'null' openRate: anyOf: - type: - number - string - type: 'null' clickRate: anyOf: - type: - number - string - type: 'null' replyRate: anyOf: - type: - number - string - type: 'null' spamBlockedRate: anyOf: - type: - number - string - type: 'null' optOutRate: anyOf: - type: - number - string - type: 'null' demoRate: anyOf: - type: - number - string - type: 'null' required: - id - created_at - active - label_ids pagination: type: object properties: page: type: - number - 'null' perPage: type: number totalEntries: type: number totalPages: type: number required: - page - per_page - total_entries - total_pages examples: example-1: value: emailerCampaigns: - id: ullamco Excepteur active: true clickRate: -61736818.674721316 userId: in id laborum nisi bounceRate: null uniqueDemoed: null uniqueDelivered: null demoRate: 29528060.39477016 optOutRate: minim in elit nisi quis openRate: -20479075.177627772 name: null uniqueReplied: null uniqueUnsubscribed: aute fugiat uniqueOpened: reprehenderit uniqueScheduled: culpa dolor deserunt replyRate: null numSteps: null labelIds: - irure spamBlockedRate: commodo do est createdAt: '1999-12-07T08:53:05.0Z' uniqueClicked: null uniqueBounced: null pagination: page: null totalEntries: -95622675.08575992 perPage: 80845744.49505061 totalPages: -12938224.005571365 requestBody: content: application/json: schema: type: object properties: qKeywords: type: string page: type: number examples: example-1: value: qKeywords: laboris amet consequat dolore page: 53513713.01563096 operationId: search-sequences parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/sequences/start: post: responses: '200': description: OK content: application/json: schema: type: object properties: contacts: type: array items: type: object properties: id: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' name: type: - string - 'null' title: type: - string - 'null' ownerId: type: - string - 'null' presentRawAddress: type: - string - 'null' phoneNumbers: type: array items: type: object properties: rawNumber: type: string sanitizedNumber: type: - string - 'null' type: type: string enum: - mobile - home - work_hq - work_direct - other position: type: number status: type: - string - 'null' dncStatus: type: - string - 'null' required: - raw_number - type - position organizationName: type: - string - 'null' email: type: - string - 'null' websiteUrl: type: - string - 'null' contactStageId: type: - string - 'null' accountId: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time typedCustomFields: type: object properties: {} required: - id - phone_numbers - created_at - updated_at - typed_custom_fields emailerCampaign: type: object properties: id: type: string name: type: - string - 'null' createdAt: type: string format: date-time active: type: boolean labelIds: type: array items: type: string numSteps: type: - number - 'null' userId: type: - string - 'null' uniqueScheduled: anyOf: - type: - number - string - type: 'null' uniqueDelivered: anyOf: - type: - number - string - type: 'null' uniqueBounced: anyOf: - type: - number - string - type: 'null' uniqueOpened: anyOf: - type: - number - string - type: 'null' uniqueReplied: anyOf: - type: - number - string - type: 'null' uniqueDemoed: anyOf: - type: - number - string - type: 'null' uniqueClicked: anyOf: - type: - number - string - type: 'null' uniqueUnsubscribed: anyOf: - type: - number - string - type: 'null' bounceRate: anyOf: - type: - number - string - type: 'null' openRate: anyOf: - type: - number - string - type: 'null' clickRate: anyOf: - type: - number - string - type: 'null' replyRate: anyOf: - type: - number - string - type: 'null' spamBlockedRate: anyOf: - type: - number - string - type: 'null' optOutRate: anyOf: - type: - number - string - type: 'null' demoRate: anyOf: - type: - number - string - type: 'null' required: - id - created_at - active - label_ids examples: example-1: value: contacts: - id: cupidatat ullamco sit deserunt laborum websiteUrl: velit exercitation phoneNumbers: - type: other position: 12922556.550570622 rawNumber: dolor status: null sanitizedNumber: anim minim sit incididunt ex dncStatus: null typedCustomFields: {} organizationName: non Duis id exercitation reprehenderit accountId: null lastName: null email: null createdAt: '1977-10-18T15:52:14.0Z' title: sint cillum consectetur ownerId: Ut in sunt name: null updatedAt: '2001-10-01T05:23:56.0Z' presentRawAddress: null contactStageId: pariatur firstName: reprehenderit magna eiusmod dolor emailerCampaign: id: dolor velit do Duis laboris active: true numSteps: null userId: null spamBlockedRate: -19102971.522516698 uniqueBounced: 42891496.357764095 uniqueScheduled: fugiat labore Lorem anim uniqueDelivered: null name: et anim aliqua amet laborum createdAt: '2000-02-07T18:39:49.0Z' uniqueClicked: -40021535.75435989 uniqueReplied: magna est nulla dolore sint openRate: -6107377.485056847 clickRate: null uniqueOpened: 18334622.995652556 replyRate: ad officia est in cillum uniqueDemoed: -95228997.13662559 demoRate: null optOutRate: null uniqueUnsubscribed: -16386402.351016745 labelIds: - magna mollit bounceRate: null requestBody: content: application/json: schema: type: object properties: emailerCampaignId: type: string contactIds: type: array items: type: string sendEmailFromEmailAccountId: type: string examples: example-1: value: emailerCampaignId: deserunt contactIds: - aliquip Lorem Duis labore ea sendEmailFromEmailAccountId: exercitation reprehenderit aliqua nulla operationId: start-sequences parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/sequence-steps/create: post: responses: '200': description: OK content: application/json: schema: type: object properties: emailerStep: type: object properties: id: type: string required: - id emailerTouch: type: object properties: id: type: string required: - id emailerTemplate: type: object properties: id: type: string required: - id examples: example-1: value: emailerStep: id: id cillum emailerTouch: id: ea Lorem reprehenderit magna emailerTemplate: id: exercitation ea elit requestBody: content: application/json: schema: type: object properties: emailerCampaignId: type: string priority: type: string position: type: number type: type: string waitMode: type: string waitTime: type: number exactDatetime: type: string examples: example-1: value: emailerCampaignId: minim esse priority: Excepteur ea elit dolore position: -49452973.170277394 type: aliqua waitMode: in enim aliquip waitTime: -32576063.94506967 exactDatetime: magna id operationId: create-sequence-steps parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/sequence-templates/update: post: responses: '200': description: OK content: application/json: schema: type: object properties: emailerTouch: type: object properties: id: type: string required: - id examples: example-1: value: emailerTouch: id: aliquip requestBody: content: application/json: schema: type: object properties: id: type: string emailerTemplate: type: object properties: name: type: string userId: type: string subject: type: string global: type: boolean bodyHtml: type: string bodyText: type: string creationType: type: string labelIds: type: array items: type: string emailerStepId: type: string emailerTemplateId: type: string status: type: string type: type: string includeSignature: type: boolean examples: example-1: value: id: laborum do ut aliqua nostrud emailerTemplate: name: anim subject: sint Excepteur est id global: true bodyHtml: sit creationType: do Lorem tempor irure mollit bodyText: exercitation anim in labelIds: - eu deserunt userId: aute laborum in emailerStepId: qui nostrud magna emailerTemplateId: non status: ullamco type: tempor velit includeSignature: true operationId: update-sequence-templates parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: [] /api/actions/apollo/users/search: post: responses: '200': description: OK content: application/json: schema: type: object properties: users: type: array items: type: object properties: id: type: string firstName: type: - string - 'null' lastName: type: - string - 'null' email: type: - string - 'null' teamId: type: - string - 'null' createdAt: type: string format: date-time required: - id - created_at pagination: type: object properties: page: type: - number - 'null' perPage: type: number totalEntries: type: number totalPages: type: number required: - page - per_page - total_entries - total_pages examples: example-1: value: users: - id: cupidatat ut eu pariatur ullamco teamId: null email: null lastName: null createdAt: '1979-11-28T09:15:41.0Z' firstName: eiusmod dolor proident sed in pagination: page: null totalEntries: -71403084.01006079 totalPages: 68295959.37075621 perPage: -65745786.56235261 requestBody: content: application/json: schema: type: object properties: page: type: number examples: example-1: value: page: 82504012.17147711 operationId: search-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string parameters: []