openapi: 3.2.0 info: title: Vessel Actions API version: '1.0' description: 'Operations tagged Actions across 12 of this provider''s published API definitions: vessel-activecampaign-actions-openapi.yml, vessel-aircall-actions-openapi.yml, vessel-apollo-actions-openapi.yml, vessel-dialpad-actions-openapi.yml, vessel-mailchimp-actions-openapi.yml, vessel-monday-actions-openapi.yml, vessel-outreach-actions-openapi.yml, vessel-ringcentral-actions-openapi.yml, vessel-salesforce-actions-openapi.yml, vessel-salesloft-actions-openapi.yml, vessel-slack-actions-openapi.yml, vessel-teams-actions-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.vessel.dev security: - VesselAPIToken: [] tags: - name: Actions paths: /api/actions/activecampaign/contacts/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: string email: type: string phone: type: string firstName: type: string lastName: type: string udate: type: string format: date-time cdate: type: string format: date-time required: - id - email - phone - firstName - lastName - udate - cdate examples: example-1: value: contact: id: magna nostrud aute ex email: dolor Duis voluptate phone: quis magna minim veniam firstName: Duis dolore irure lastName: ea sed udate: '1993-06-09T04:48:55.0Z' cdate: '1968-04-09T23:04:27.0Z' requestBody: content: application/json: schema: type: object properties: email: type: string firstName: type: string lastName: type: string phone: type: string examples: example-1: value: email: commodo nulla fugiat firstName: officia commodo do ipsum lastName: sint consequat tempor enim incididunt phone: quis magna non laboris culpa operationId: create-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/activecampaign/contacts/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: string email: type: string phone: type: string firstName: type: string lastName: type: string udate: type: string format: date-time cdate: type: string format: date-time required: - id - email - phone - firstName - lastName - udate - cdate examples: example-1: value: contact: id: dolore email: minim Ut eu qui phone: cupidatat firstName: occaecat laborum lastName: commodo pariatur culpa Ut ea udate: '1974-11-24T02:14:27.0Z' cdate: '1948-12-31T17:23:58.0Z' requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: ipsum sit operationId: find-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/activecampaign/contacts/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contacts: type: array items: type: object properties: id: type: string email: type: string phone: type: string firstName: type: string lastName: type: string udate: type: string format: date-time cdate: type: string format: date-time required: - id - email - phone - firstName - lastName - udate - cdate examples: example-1: value: contacts: - id: laborum Lorem email: ut incididunt Duis in phone: amet consectetur sit firstName: ea tempor consectetur veniam lastName: Lorem udate: '1997-04-13T17:24:29.0Z' cdate: '2012-11-08T11:04:48.0Z' requestBody: content: application/json: schema: type: object properties: {} examples: example-1: value: {} operationId: list-contacts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/activecampaign/contacts/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: string email: type: string phone: type: string firstName: type: string lastName: type: string udate: type: string format: date-time cdate: type: string format: date-time required: - id - email - phone - firstName - lastName - udate - cdate examples: example-1: value: contact: id: id et qui eiusmod do email: ipsum reprehenderit phone: in firstName: deserunt ut sed pariatur lastName: sunt udate: '1994-10-25T07:04:39.0Z' cdate: '1952-03-02T20:22:37.0Z' requestBody: content: application/json: schema: type: object properties: id: type: string email: type: string firstName: type: string lastName: type: string phone: type: string examples: example-1: value: id: in minim email: dolore sunt laborum adipisicing firstName: dolor cupidatat lastName: dolore nisi laboris phone: pariatur in operationId: update-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/activecampaign/lists/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: list: type: object properties: id: type: string name: type: string cdate: type: string format: date-time required: - id - name - cdate examples: example-1: value: list: id: labore cillum irure aliqua name: sed ut sit cdate: '1993-09-24T02:40:23.0Z' requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: aliquip aute in dolor reprehenderit operationId: find-list parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/activecampaign/lists/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: lists: type: array items: type: object properties: id: type: string name: type: string cdate: type: string format: date-time required: - id - name - cdate examples: example-1: value: lists: - id: non ad name: sed sint non laboris cdate: '1976-07-20T17:09:24.0Z' requestBody: content: application/json: schema: type: object properties: limit: type: number examples: example-1: value: limit: 71740595.36603016 operationId: list-lists parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/activecampaign/users/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: users: type: array items: type: object properties: id: type: string username: type: string firstName: type: string lastName: type: string email: type: string phone: type: string required: - id - username - firstName - lastName - email - phone examples: example-1: value: users: - id: non username: non firstName: commodo laborum lastName: veniam email: aute phone: Duis mollit eu cupidatat requestBody: content: application/json: schema: type: object properties: {} examples: example-1: value: {} operationId: list-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/users/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: users: type: array items: type: object properties: id: type: number directLink: type: - string - 'null' name: type: string email: type: - string - 'null' available: type: - boolean - 'null' availabilityStatus: type: - string - 'null' timeZone: type: - string - 'null' language: type: - string - 'null' wrapUpTime: type: - number - 'null' createdAt: type: string format: date-time required: - id - direct_link - name - email - available - availability_status - time_zone - language - wrap_up_time - created_at meta: type: object properties: count: type: - number - 'null' total: type: - number - 'null' currentPage: type: - number - 'null' perPage: type: - number - 'null' nextPageLink: anyOf: - type: string - type: 'null' previousPageLink: anyOf: - type: string - type: 'null' required: - count - total - current_page - per_page - next_page_link - previous_page_link examples: example-1: value: users: - id: -89270352.46227905 name: Ut email: consequat fugiat dolor ut available: null language: null wrapUpTime: 77299649.46462867 timeZone: esse ea et nostrud elit createdAt: '2018-10-13T10:10:16.0Z' directLink: null availabilityStatus: esse ex meta: count: -84061575.0836465 total: null previousPageLink: in veniam mollit fugiat currentPage: -57299537.317396656 perPage: null nextPageLink: ut requestBody: content: application/json: schema: type: object properties: from: type: string perPage: type: number nextPageLink: type: string examples: example-1: value: from: dolore fugiat perPage: -62917728.630286396 nextPageLink: aliqua operationId: list-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/users/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: user: type: object properties: id: type: number directLink: type: - string - 'null' name: type: string email: type: - string - 'null' available: type: - boolean - 'null' availabilityStatus: type: - string - 'null' timeZone: type: - string - 'null' language: type: - string - 'null' wrapUpTime: type: - number - 'null' createdAt: type: string format: date-time required: - id - direct_link - name - email - available - availability_status - time_zone - language - wrap_up_time - created_at examples: example-1: value: user: id: -55279769.4802079 name: ipsum nulla sit qui email: null available: null language: null availabilityStatus: Excepteur eu minim irure cillum directLink: nostrud do exercitation in in wrapUpTime: null timeZone: ullamco ut ex createdAt: '1961-04-23T09:09:34.0Z' requestBody: content: application/json: schema: type: object properties: id: type: - number - string examples: example-1: value: id: dolore operationId: find-user parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/users/start-call: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: {} examples: example-1: value: {} requestBody: content: application/json: schema: type: object properties: id: type: - number - string numberId: type: - number - string to: type: string examples: example-1: value: id: consequat numberId: enim to: labore id ut eu officia operationId: start-user-call parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/contacts/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: number directLink: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' companyName: type: - string - 'null' information: type: - string - 'null' isShared: type: - boolean - 'null' createdAt: type: number updatedAt: type: number emails: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' phoneNumbers: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' required: - id - direct_link - first_name - last_name - company_name - information - is_shared - created_at - updated_at - emails - phone_numbers examples: example-1: value: contact: id: -4310924.4277355075 information: consectetur emails: - id: -64046885.245729744 label: null value: commodo aute66: 49947290 velit_40: false phoneNumbers: null directLink: null isShared: null updatedAt: 2237749.0678489953 createdAt: 51588572.78623724 firstName: irure aliqua consequat lastName: null companyName: null requestBody: content: application/json: schema: type: object properties: firstName: type: string lastName: type: string companyName: type: string information: type: string emails: type: array items: type: object properties: label: type: string value: type: string required: - value phoneNumbers: type: array items: type: object properties: label: type: string value: type: string required: - value examples: example-1: value: firstName: adipisicing sed dolor Lorem officia lastName: Lorem companyName: laboris nulla ex mollit information: tempor emails: - value: occaecat eu sint label: non occaecat incididunt phoneNumbers: - value: ex exercitation label: in operationId: create-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/contacts/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: number directLink: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' companyName: type: - string - 'null' information: type: - string - 'null' isShared: type: - boolean - 'null' createdAt: type: number updatedAt: type: number emails: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' phoneNumbers: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' required: - id - direct_link - first_name - last_name - company_name - information - is_shared - created_at - updated_at - emails - phone_numbers examples: example-1: value: contact: id: 99345447.36392054 information: anim magna emails: null directLink: null firstName: null lastName: esse dolor elit phoneNumbers: null updatedAt: 68223509.77328452 createdAt: 80664193.9649893 isShared: false companyName: Lorem et requestBody: content: application/json: schema: type: object properties: id: type: - number - string examples: example-1: value: id: -36096015.86504509 operationId: find-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/contacts/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contacts: type: array items: type: object properties: id: type: number directLink: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' companyName: type: - string - 'null' information: type: - string - 'null' isShared: type: - boolean - 'null' createdAt: type: number updatedAt: type: number emails: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' phoneNumbers: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' required: - id - direct_link - first_name - last_name - company_name - information - is_shared - created_at - updated_at - emails - phone_numbers meta: type: object properties: count: type: - number - 'null' total: type: - number - 'null' currentPage: type: - number - 'null' perPage: type: - number - 'null' nextPageLink: anyOf: - type: string - type: 'null' previousPageLink: anyOf: - type: string - type: 'null' required: - count - total - current_page - per_page - next_page_link - previous_page_link examples: example-1: value: contacts: - id: 57434312.2139124 information: null emails: - id: -30375498.88328086 label: null value: proident in occaecat quis cillum cupidatat__: false Ut6b4: est laboris irure__: est mollit dolor_28: veniam exercitation Excepteur companyName: Ut eiusmod pariatur dolore isShared: true phoneNumbers: - id: 27001835.037813306 label: Excepteur ea cillum amet mollit value: id ipsum sit est anim updatedAt: 41043219.67213011 firstName: null directLink: aliqua lastName: null createdAt: 29886562.004416466 meta: count: 79154511.47519681 total: null nextPageLink: velit dolor commodo previousPageLink: nisi aliqua perPage: null currentPage: null requestBody: content: application/json: schema: type: object properties: from: type: string perPage: type: number nextPageLink: type: string examples: example-1: value: from: ad perPage: -7016389.1691586375 nextPageLink: sed adipisicing ad culpa operationId: list-contacts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/contacts/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: contact: type: object properties: id: type: number directLink: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' companyName: type: - string - 'null' information: type: - string - 'null' isShared: type: - boolean - 'null' createdAt: type: number updatedAt: type: number emails: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' phoneNumbers: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' required: - id - direct_link - first_name - last_name - company_name - information - is_shared - created_at - updated_at - emails - phone_numbers examples: example-1: value: contact: id: -89158428.57605143 information: id emails: null createdAt: -74604828.86311862 updatedAt: 99775715.99888128 directLink: ad companyName: magna dolor isShared: null phoneNumbers: - id: -20111456.690393314 label: null value: Excepteur Ut nisi firstName: null lastName: null requestBody: content: application/json: schema: type: object properties: id: type: - number - string firstName: type: string lastName: type: string companyName: type: string information: type: string examples: example-1: value: id: -57164264.11440763 firstName: proident lastName: anim companyName: exercitation information: et operationId: update-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/calls/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: call: type: object properties: id: type: number directLink: type: - string - 'null' direction: anyOf: - type: string enum: - inbound - outbound - type: 'null' status: type: - string - 'null' startedAt: type: number answeredAt: type: number endedAt: type: number duration: type: - number - 'null' voicemail: type: - string - 'null' recording: type: - string - 'null' rawDigits: type: string user: type: object properties: id: type: number directLink: type: - string - 'null' name: type: string email: type: - string - 'null' available: type: - boolean - 'null' availabilityStatus: type: - string - 'null' timeZone: type: - string - 'null' language: type: - string - 'null' wrapUpTime: type: - number - 'null' createdAt: type: string format: date-time required: - id - direct_link - name - email - available - availability_status - time_zone - language - wrap_up_time - created_at contact: anyOf: - type: object properties: id: type: number directLink: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' companyName: type: - string - 'null' information: type: - string - 'null' isShared: type: - boolean - 'null' createdAt: type: number updatedAt: type: number emails: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' phoneNumbers: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' required: - id - direct_link - first_name - last_name - company_name - information - is_shared - created_at - updated_at - emails - phone_numbers - type: 'null' number: type: object properties: id: type: number name: type: - string - 'null' digits: type: - string - 'null' createdAt: type: string format: date-time required: - id - name - digits - created_at participants: type: array items: type: object properties: id: type: number type: type: string enum: - user - contact - external name: type: - string - 'null' phoneNumber: type: - string - 'null' required: - id - type - name - phone_number required: - id - direct_link - direction - status - started_at - answered_at - ended_at - duration - voicemail - recording - raw_digits - user - contact - number examples: example-1: value: call: id: 76973404.07882455 direction: outbound status: null duration: 51302934.868718445 voicemail: null recording: null user: id: 74099454.77302057 name: officia in Ut Lorem email: dolor aliquip available: true language: null wrapUpTime: 23688321.605538264 timeZone: null directLink: null availabilityStatus: null createdAt: '1964-01-30T09:26:09.0Z' contact: null number: id: -16598077.18119803 name: voluptate Ut digits: null createdAt: '1971-01-18T18:59:09.0Z' participants: - id: 91322388.92238086 type: user name: null phoneNumber: null rawDigits: labore nostrud voluptate Excepteur aliqua directLink: null endedAt: 77737922.9855662 answeredAt: -52119061.94518017 startedAt: -85399918.58678864 requestBody: content: application/json: schema: type: object properties: id: type: - number - string examples: example-1: value: id: 94701425.10324454 operationId: find-call parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/aircall/calls/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: calls: type: array items: type: object properties: id: type: number directLink: type: - string - 'null' direction: anyOf: - type: string enum: - inbound - outbound - type: 'null' status: type: - string - 'null' startedAt: type: number answeredAt: type: number endedAt: type: number duration: type: - number - 'null' voicemail: type: - string - 'null' recording: type: - string - 'null' rawDigits: type: string user: type: object properties: id: type: number directLink: type: - string - 'null' name: type: string email: type: - string - 'null' available: type: - boolean - 'null' availabilityStatus: type: - string - 'null' timeZone: type: - string - 'null' language: type: - string - 'null' wrapUpTime: type: - number - 'null' createdAt: type: string format: date-time required: - id - direct_link - name - email - available - availability_status - time_zone - language - wrap_up_time - created_at contact: anyOf: - type: object properties: id: type: number directLink: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' companyName: type: - string - 'null' information: type: - string - 'null' isShared: type: - boolean - 'null' createdAt: type: number updatedAt: type: number emails: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' phoneNumbers: anyOf: - type: array items: type: object properties: id: type: number label: type: - string - 'null' value: type: string required: - id - label - value - type: 'null' required: - id - direct_link - first_name - last_name - company_name - information - is_shared - created_at - updated_at - emails - phone_numbers - type: 'null' number: type: object properties: id: type: number name: type: - string - 'null' digits: type: - string - 'null' createdAt: type: string format: date-time required: - id - name - digits - created_at participants: type: array items: type: object properties: id: type: number type: type: string enum: - user - contact - external name: type: - string - 'null' phoneNumber: type: - string - 'null' required: - id - type - name - phone_number required: - id - direct_link - direction - status - started_at - answered_at - ended_at - duration - voicemail - recording - raw_digits - user - contact - number meta: type: object properties: count: type: - number - 'null' total: type: - number - 'null' currentPage: type: - number - 'null' perPage: type: - number - 'null' nextPageLink: anyOf: - type: string - type: 'null' previousPageLink: anyOf: - type: string - type: 'null' required: - count - total - current_page - per_page - next_page_link - previous_page_link examples: example-1: value: calls: - id: -75376073.69676214 direction: null status: null duration: -57347375.44697053 voicemail: nostrud recording: do reprehenderit user: id: 18089884.18484439 name: mollit esse email: pariatur available: false language: eiusmod amet dolor consectetur createdAt: '1982-02-25T05:02:38.0Z' wrapUpTime: null availabilityStatus: occaecat nisi proident timeZone: fugiat mollit pariatur non directLink: null contact: id: -80586999.36226827 information: null emails: - id: 58053087.984629005 label: sed value: nulla Lorem firstName: null directLink: aute eiusmod companyName: dolore nulla phoneNumbers: null lastName: nostrud Ut incididunt amet quis createdAt: -41802029.006895445 updatedAt: -66405885.980554745 isShared: false number: id: 50178920.37031323 name: ad digits: quis anim labore Ut createdAt: '1979-12-09T15:58:42.0Z' rawDigits: Lorem aliqua nulla ullamco directLink: null participants: - id: 48614791.61519435 type: external name: null phoneNumber: null answeredAt: 80830968.84168652 endedAt: -37500350.467588015 startedAt: -24821882.62971157 meta: count: null total: null perPage: -21536160.552566707 currentPage: null nextPageLink: null previousPageLink: null requestBody: content: application/json: schema: type: object properties: from: type: string perPage: type: number nextPageLink: type: string examples: example-1: value: from: ut esse perPage: 48568655.0099569 nextPageLink: ex mollit Ut operationId: list-calls parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/accounts/create: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/accounts/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/accounts/update: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/activities/list: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/contacts/create: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/contacts/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/contacts/update: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/custom-fields/create: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/custom-fields/list: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/emails/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/email-accounts/list: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/labels/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/people/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/tasks/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/tasks/mark-complete: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/calls/create: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/calls/details: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/sequences/create: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/sequences/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/sequences/start: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/sequence-steps/create: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/sequence-templates/update: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/apollo/users/search: parameters: [] 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 tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/users/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: cursor: type: string items: type: array items: type: object properties: adminOfficeIds: type: array items: type: string companyId: type: string country: type: string dateActive: type: string format: date-time dateAdded: type: string format: date-time dateFirstLogin: type: string format: date-time doNotDisturb: type: boolean emails: type: array items: type: string firstName: type: string id: type: string imageUrl: type: string isAdmin: type: boolean isAvailable: type: boolean isOnDuty: type: boolean isOnline: type: boolean isSuperAdmin: type: boolean language: type: string lastName: type: string license: type: string muted: type: boolean officeId: type: string phoneNumbers: type: array items: type: string state: type: string timezone: type: string required: - admin_office_ids - company_id - country - date_active - date_added - date_first_login - do_not_disturb - emails - first_name - id - image_url - is_admin - is_available - is_on_duty - is_online - is_super_admin - language - last_name - license - muted - office_id - phone_numbers - state - timezone examples: example-1: value: - - country: officia emails: - aute ad qui culpa Excepteur id: laboris dolor consectetur ex irure language: amet irure non license: in consequat muted: true state: voluptate et irure sint timezone: aliqua magna dateActive: '1998-05-26T22:29:39.0Z' doNotDisturb: true isOnDuty: false officeId: amet consectetur adminOfficeIds: - nisi culpa est et amet firstName: nisi qui exercitation commodo isOnline: false companyId: non dateAdded: '1974-06-05T18:02:36.0Z' lastName: ea isAvailable: true isAdmin: true dateFirstLogin: '1972-04-16T04:34:19.0Z' imageUrl: in officia phoneNumbers: - dolore isSuperAdmin: true requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: nostrud operationId: list-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/users/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: adminOfficeIds: type: array items: type: string companyId: type: string country: type: string dateActive: type: string format: date-time dateAdded: type: string format: date-time dateFirstLogin: type: string format: date-time doNotDisturb: type: boolean emails: type: array items: type: string firstName: type: string id: type: string imageUrl: type: string isAdmin: type: boolean isAvailable: type: boolean isOnDuty: type: boolean isOnline: type: boolean isSuperAdmin: type: boolean language: type: string lastName: type: string license: type: string muted: type: boolean officeId: type: string phoneNumbers: type: array items: type: string state: type: string timezone: type: string examples: example-1: value: adminOfficeIds: - cupidatat non minim companyId: aliqua anim sunt Excepteur adipisicing country: aliqua ad laborum Lorem in dateActive: '1991-06-27T19:11:13.0Z' dateAdded: '1947-01-26T11:48:28.0Z' dateFirstLogin: '1998-05-31T18:52:48.0Z' doNotDisturb: true emails: - ullamco firstName: ullamco ex ipsum laboris occaecat id: Lorem ut occaecat consequat aute imageUrl: laborum isAdmin: false isAvailable: true isOnDuty: true isOnline: true isSuperAdmin: true language: Ut deserunt veniam occaecat sunt lastName: esse pariatur ut cillum exercitation license: voluptate eiusmod in labore occaecat muted: false officeId: consectetur Ut est laboris Lorem phoneNumbers: - in cupidatat state: deserunt cillum do in labore timezone: pariatur ipsum dolore anim veniam requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: magna ut operationId: find-user parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/contacts/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string companyName: type: string displayName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string ownerId: type: string phones: type: array items: type: string primaryEmail: type: string primaryPhone: type: string type: type: string enum: - shared - local urls: type: array items: type: string examples: example-1: value: id: deserunt dolor aliqua officia Lorem firstName: qui occaecat dolore lastName: dolore esse companyName: Duis anim proident exercitation displayName: elit emails: - consectetur extension: mollit sit consectetur nostrud proident jobTitle: esse deserunt ownerId: cupidatat elit phones: - est primaryEmail: sit et consectetur nulla elit primaryPhone: mollit pariatur nisi fugiat sunt type: shared urls: - enim in sunt requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: nostrud laborum sed ut operationId: find-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/contacts/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: cursor: type: string items: type: array items: type: object properties: id: type: string firstName: type: string lastName: type: string companyName: type: string displayName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string ownerId: type: string phones: type: array items: type: string primaryEmail: type: string primaryPhone: type: string type: type: string enum: - shared - local urls: type: array items: type: string required: - id - first_name - last_name - company_name - display_name - emails - extension - job_title - owner_id - phones - primary_email - primary_phone - type - urls examples: example-1: value: - - id: occaecat nulla ipsum Duis emails: - consequat anim irure officia qui extension: ut phones: - mollit do type: shared urls: - ut jobTitle: dolore primaryPhone: fugiat occaecat anim ut Ut lastName: non deserunt ut aliqua companyName: id cupidatat firstName: occaecat nulla primaryEmail: sint commodo fugiat sit elit displayName: dolor labore Excepteur ownerId: in requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: dolor operationId: list-contacts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/contacts/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string companyName: type: string displayName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string ownerId: type: string phones: type: array items: type: string primaryEmail: type: string primaryPhone: type: string type: type: string enum: - shared - local urls: type: array items: type: string examples: example-1: value: id: et firstName: dolore lastName: ex quis ea labore companyName: aliqua laborum displayName: occaecat sed aliquip amet emails: - ut fugiat extension: Duis laborum aliqua non pariatur jobTitle: ut ownerId: incididunt tempor dolor commodo Ut phones: - labore in fugiat quis consectetur primaryEmail: ut qui cillum primaryPhone: in minim cupidatat ut irure type: local urls: - ullamco id requestBody: content: application/json: schema: type: object properties: firstName: type: string lastName: type: string companyName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string phones: type: array items: type: string urls: type: array items: type: string examples: example-1: value: firstName: incididunt voluptate elit lastName: qui sed mollit id companyName: adipisicing aliqua in emails: - tempor adipisicing qui extension: ullamco sint elit consectetur aliquip jobTitle: ut et phones: - culpa cillum eiusmod esse urls: - culpa minim ad quis ut operationId: contacts-create parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/contacts/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string companyName: type: string displayName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string ownerId: type: string phones: type: array items: type: string primaryEmail: type: string primaryPhone: type: string type: type: string enum: - shared - local urls: type: array items: type: string examples: example-1: value: id: in firstName: Excepteur dolor culpa lastName: eiusmod Excepteur proident reprehenderit companyName: minim displayName: culpa esse mollit ut Ut emails: - proident velit in eiusmod extension: nostrud ullamco in velit jobTitle: dolor ownerId: incididunt phones: - proident culpa officia sint non primaryEmail: consequat adipisicing voluptate exercitation primaryPhone: reprehenderit dolore type: shared urls: - commodo occaecat sed incididunt dolor requestBody: content: application/json: schema: type: object properties: firstName: type: string lastName: type: string companyName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string phones: type: array items: type: string urls: type: array items: type: string uid: type: string examples: example-1: value: firstName: irure minim exercitation voluptate veniam lastName: aute commodo pariatur velit companyName: quis ut emails: - labore culpa laborum incididunt extension: et in jobTitle: id phones: - cupidatat in nulla commodo sit urls: - occaecat commodo id esse uid: commodo qui operationId: contacts-update parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/calls/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: adminCallRecordingShareLinks: type: array items: type: string callId: type: number callRecordingIds: type: array items: type: number callRecordingShareLinks: type: array items: type: string contact: type: object properties: id: type: string firstName: type: string lastName: type: string companyName: type: string displayName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string ownerId: type: string phones: type: array items: type: string primaryEmail: type: string primaryPhone: type: string type: type: string enum: - shared - local urls: type: array items: type: string required: - id - first_name - last_name - company_name - display_name - emails - extension - job_title - owner_id - phones - primary_email - primary_phone - type - urls csatRecordingUrls: type: array items: type: string csatScore: type: string csatTranscriptions: type: string customData: type: string dateConnected: type: number dateEnded: type: number dateRang: type: number dateStarted: type: number direction: type: string enum: - inbound - outbound duration: type: number entryPointCallId: type: number entryPointTarget: type: object properties: email: type: string id: type: string name: type: string phone: type: string type: type: string required: - email - id - name - phone - type eventTimestamp: type: number externalNumber: type: string groupId: type: string internalNumber: type: string isTransferred: type: boolean labels: type: array items: type: string masterCallId: type: number mosScore: type: number operatorCallId: type: number proxyTarget: {} recordingUrl: type: array items: type: string routingBreadcrumbs: type: array items: type: object properties: breadcrumbType: type: string date: type: number request: type: object properties: body: type: string headers: type: string method: type: string url: type: string required: - body - headers - method - url response: type: object properties: body: type: string headers: type: string statusCode: type: number required: - body - headers - status_code targetId: type: number targetType: type: string url: type: string required: - breadcrumb_type - date - request - response - target_id - target_type - url screenRecordingUrls: type: array items: type: string state: type: string target: {} totalDuration: type: number transcriptionText: type: string voicemailLink: type: string voicemailRecordingId: type: string voicemailShareLink: type: string wasRecorded: type: boolean examples: example-1: value: adminCallRecordingShareLinks: - minim aute in eu callId: 77054484.92567113 callRecordingIds: - -26913073.440438002 callRecordingShareLinks: - fugiat velit cupidatat pariatur contact: id: voluptate occaecat fugiat ea cupidatat emails: - in amet extension: Ut phones: - sint aliqua type: shared urls: - aute lastName: sint aliquip sit laborum primaryEmail: aliquip occaecat voluptate adipisicing deserunt displayName: elit id dolor jobTitle: eu voluptate ownerId: ad companyName: eu cillum reprehenderit sit do primaryPhone: eiusmod aliqua eu esse in firstName: nulla occaecat minim csatRecordingUrls: - qui csatScore: est Excepteur esse csatTranscriptions: consequat aute veniam culpa in customData: laboris quis est dateConnected: -55246381.23107475 dateEnded: 18840819.990400255 dateRang: 8018301.6867556125 dateStarted: -17717936.133780032 direction: inbound duration: 20971692.599217966 entryPointCallId: -37586076.92328635 entryPointTarget: email: qui id: aliquip et name: mollit adipisicing commodo phone: ea magna type: Ut eventTimestamp: -2766352.666595891 externalNumber: nulla elit groupId: ad exercitation cillum internalNumber: anim amet occaecat quis isTransferred: true labels: - culpa reprehenderit mollit irure quis masterCallId: 2035563.1508786976 mosScore: -86311809.30944455 operatorCallId: 53424652.617881745 proxyTarget: {} recordingUrl: - exercitation eu dolor ullamco in routingBreadcrumbs: - date: 13824765.586758003 request: body: exercitation headers: Excepteur cillum in minim method: dolore do url: consequat elit response: body: tempor ullamco irure in laborum headers: magna anim statusCode: -45397526.915761024 url: tempor officia in dolor breadcrumbType: sit non targetType: dolore elit minim ullamco ut targetId: 53131940.11906487 screenRecordingUrls: - fugiat irure et state: cupidatat consequat dolore nostrud target: {} totalDuration: 87927288.79861835 transcriptionText: non ea sed id voicemailLink: velit ad sunt voicemailRecordingId: cillum incididunt voicemailShareLink: aliquip incididunt ea dolore officia wasRecorded: true requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: in operationId: find-call parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/calls/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: cursor: type: string items: type: array items: type: object properties: adminCallRecordingShareLinks: type: array items: type: string callId: type: number callRecordingIds: type: array items: type: number callRecordingShareLinks: type: array items: type: string contact: type: object properties: id: type: string firstName: type: string lastName: type: string companyName: type: string displayName: type: string emails: type: array items: type: string extension: type: string jobTitle: type: string ownerId: type: string phones: type: array items: type: string primaryEmail: type: string primaryPhone: type: string type: type: string enum: - shared - local urls: type: array items: type: string required: - id - first_name - last_name - company_name - display_name - emails - extension - job_title - owner_id - phones - primary_email - primary_phone - type - urls csatRecordingUrls: type: array items: type: string csatScore: type: string csatTranscriptions: type: string customData: type: string dateConnected: type: number dateEnded: type: number dateRang: type: number dateStarted: type: number direction: type: string enum: - inbound - outbound duration: type: number entryPointCallId: type: number entryPointTarget: type: object properties: email: type: string id: type: string name: type: string phone: type: string type: type: string required: - email - id - name - phone - type eventTimestamp: type: number externalNumber: type: string groupId: type: string internalNumber: type: string isTransferred: type: boolean labels: type: array items: type: string masterCallId: type: number mosScore: type: number operatorCallId: type: number proxyTarget: {} recordingUrl: type: array items: type: string routingBreadcrumbs: type: array items: type: object properties: breadcrumbType: type: string date: type: number request: type: object properties: body: type: string headers: type: string method: type: string url: type: string required: - body - headers - method - url response: type: object properties: body: type: string headers: type: string statusCode: type: number required: - body - headers - status_code targetId: type: number targetType: type: string url: type: string required: - breadcrumb_type - date - request - response - target_id - target_type - url screenRecordingUrls: type: array items: type: string state: type: string target: {} totalDuration: type: number transcriptionText: type: string voicemailLink: type: string voicemailRecordingId: type: string voicemailShareLink: type: string wasRecorded: type: boolean required: - admin_call_recording_share_links - call_id - call_recording_ids - call_recording_share_links - contact - csat_recording_urls - csat_score - csat_transcriptions - custom_data - date_connected - date_ended - date_rang - date_started - direction - duration - entry_point_call_id - entry_point_target - event_timestamp - external_number - group_id - internal_number - is_transferred - labels - master_call_id - mos_score - operator_call_id - proxy_target - recording_url - routing_breadcrumbs - screen_recording_urls - state - target - total_duration - transcription_text - voicemail_link - voicemail_recording_id - voicemail_share_link - was_recorded examples: example-1: value: - - contact: id: aute veniam emails: - labore ullamco extension: dolore qui in phones: - id veniam cupidatat deserunt fugiat type: local urls: - occaecat firstName: cupidatat magna primaryPhone: sed Lorem cupidatat primaryEmail: dolore cupidatat id elit jobTitle: dolor in companyName: laboris cillum displayName: irure ownerId: minim laborum amet lastName: ullamco cupidatat irure culpa direction: outbound duration: 67044079.224696815 labels: - commodo pariatur magna laboris velit state: commodo consectetur target: {} customData: eu routingBreadcrumbs: - date: -99106840.98334594 request: body: Duis Excepteur ut minim headers: velit deserunt exercitation id method: incididunt url: magna response: body: ipsum headers: ad amet dolor ut consequat statusCode: -41582221.43456474 url: occaecat targetId: -78940284.33033893 breadcrumbType: voluptate targetType: minim magna masterCallId: -82588683.92832546 csatScore: culpa dolor minim anim callRecordingShareLinks: - amet ipsum fugiat adminCallRecordingShareLinks: - id csatTranscriptions: nulla ex voicemailLink: do aute dateStarted: 80237295.69488558 isTransferred: false voicemailRecordingId: id commodo proident dolor nostrud voicemailShareLink: tempor elit nostrud groupId: Lorem consequat sunt Ut dateRang: 37915086.76479119 mosScore: 58031845.30476937 entryPointCallId: -60745947.720309705 totalDuration: 71422747.06369403 proxyTarget: {} dateEnded: 60304621.27159807 operatorCallId: -91233894.47226891 screenRecordingUrls: - velit eventTimestamp: 77039326.09683299 dateConnected: 36921359.271056056 recordingUrl: - elit et aute internalNumber: esse laboris wasRecorded: true externalNumber: eu callId: -73683813.1752279 transcriptionText: nulla callRecordingIds: - 39388991.459876806 csatRecordingUrls: - laborum entryPointTarget: email: exercitation id: amet sed name: ipsum ut magna phone: ad type: commodo sunt esse485: false requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: non dolor veniam do operationId: list-calls parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/dialpad/calls/start: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: est ea requestBody: content: application/json: schema: type: object properties: customData: type: string deviceId: type: string groupId: type: number groupType: type: string outboundCallerId: type: string phoneNumber: type: string userId: type: string examples: example-1: value: customData: pariatur exercitation minim occaecat deviceId: aute fugiat amet groupId: 54437391.84711501 groupType: anim cillum aute qui outboundCallerId: tempor velit phoneNumber: sed ea ex nisi userId: Duis labore deserunt aliqua ex operationId: start-call parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/mailchimp/members/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: consectetur requestBody: content: application/json: schema: type: object properties: listId: type: string member: type: object properties: emailAddress: type: string fullName: type: string status: type: string lastChanged: type: string format: date-time timestampSignup: type: string format: date-time required: - email_address - status examples: example-1: value: listId: Ut sed ut pariatur incididunt member: status: ea Duis lastChanged: '1954-10-28T17:22:43.0Z' timestampSignup: '1995-01-30T07:20:15.0Z' emailAddress: mollit qui fullName: laboris mollit sint dolore operationId: create-member parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/mailchimp/members/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: aute dolor anim Excepteur requestBody: content: application/json: schema: type: object properties: listId: type: string member: type: object properties: id: type: string emailAddress: type: string fullName: type: string status: type: string lastChanged: type: string format: date-time timestampSignup: type: string format: date-time required: - id - email_address - status examples: example-1: value: listId: do Ut member: id: fugiat anim in ipsum status: eiusmod consectetur sint exercitation officia emailAddress: consectetur Excepteur sint exercitation amet timestampSignup: '2020-11-25T11:08:14.0Z' lastChanged: '1955-10-03T03:46:38.0Z' fullName: dolor et anim sed operationId: update-member parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/mailchimp/members/search: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: exactMatches: type: object properties: members: type: array items: type: object properties: id: type: string emailAddress: type: string fullName: type: string status: type: string lastChanged: type: string format: date-time timestampSignup: type: string format: date-time required: - id - email_address - full_name - status - last_changed - timestamp_signup required: - members fullSearch: type: object properties: members: type: array items: {} required: - members examples: example-1: value: exactMatches: members: - id: qui status: enim dolor do timestampSignup: '1982-03-03T03:33:27.0Z' fullName: irure Ut dolor est emailAddress: amet enim laborum ad incididunt lastChanged: '1965-10-11T05:54:19.0Z' fullSearch: members: [] requestBody: content: application/json: schema: type: object properties: listId: type: string fields: type: array items: type: string excludeFields: type: array items: type: string query: type: string examples: example-1: value: listId: velit sit fields: - culpa dolore excludeFields: - culpa enim eu query: eu operationId: search-members parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/mailchimp/lists/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: list: type: object properties: id: type: string name: type: string dateCreated: type: string format: date-time required: - id - name - date_created examples: example-1: value: list: listId: velit sit fields: - culpa dolore excludeFields: - culpa enim eu query: eu requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: fugiat mollit Excepteur nulla operationId: find-list parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/mailchimp/lists/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: lists: type: array items: type: object properties: id: type: string name: type: string dateCreated: type: string format: date-time required: - id - name - date_created examples: example-1: value: lists: - id: enim consequat name: et Ut Lorem cupidatat labore dateCreated: '1965-06-15T22:12:43.0Z' requestBody: content: application/json: schema: type: object properties: count: type: number offset: type: number examples: example-1: value: count: -87514915.5288328 offset: 45925499.292773694 operationId: list-lists parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/monday/graphql/query: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: - object - array required: - data examples: example-1: value: data: users: - id: 10000 name: John Doe requestBody: content: application/json: schema: type: object properties: query: type: string examples: example-1: value: query: 'query { users (limit: 50) { created_at email account { name id }}}' operationId: graphql-query parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/monday/items/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: number required: - id examples: example-1: value: id: 1000 requestBody: content: application/json: schema: type: object properties: boardId: type: number groupId: type: string itemName: type: string columnValues: type: object required: - boardId - groupId - itemName - columnValues examples: example-1: value: boardId: 123456789 groupId: topics itemName: New Item columnValues: name: John Doe lead_company: New Company operationId: create-items parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/monday/groups/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string required: - id examples: example-1: value: id: vessel_leads requestBody: content: application/json: schema: type: object properties: boardId: type: number groupName: type: string required: - boardId - groupName examples: example-1: value: boardId: 123456789 groupName: Vessel Leads operationId: create-groups parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/monday/boards/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: boards: type: array items: type: object properties: id: type: number name: type: string state: type: string permissions: type: string columns: type: array items: type: object properties: id: type: string description: type: string title: type: string type: type: string groups: type: array items: type: object properties: id: type: string title: type: string required: - boards examples: example-1: value: data: boards: - id: 1000 name: Board 1 state: all permissions: public columns: - id: name description: Name title: Name type: text - id: email description: Email title: Email type: text groups: - id: topics title: New Leads requestBody: content: application/json: schema: type: object properties: limit: type: number page: type: number examples: example-1: value: limit: 10 page: 1 operationId: list-boards parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/accounts/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: companyType: type: - string - 'null' name: type: - string - 'null' description: type: - string - 'null' domain: type: - string - 'null' locality: type: - string - 'null' numberOfEmployees: type: - number - 'null' websiteUrl: type: - string - 'null' industry: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - companyType - name - description - domain - locality - numberOfEmployees - websiteUrl - industry - createdAt - updatedAt relationships: type: object properties: owner: type: object properties: data: type: object properties: id: type: string required: - id required: - data required: - owner required: - id - attributes - relationships examples: example-1: value: data: id: -73121789.77917258 attributes: companyType: laborum name: proident in description: dolor consectetur domain: in ex locality: null numberOfEmployees: null websiteUrl: Ut dolore do industry: null createdAt: '2018-05-09T17:28:41.0Z' updatedAt: '1978-08-28T14:27:24.0Z' relationships: owner: data: id: in tempor dolor ut requestBody: content: application/json: schema: type: object properties: id: type: number examples: example-1: value: id: -40966825.30895803 operationId: find-account parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/accounts/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: allOf: - type: object properties: data: type: array items: type: object properties: id: type: number attributes: type: object properties: companyType: type: - string - 'null' name: type: - string - 'null' description: type: - string - 'null' domain: type: - string - 'null' locality: type: - string - 'null' numberOfEmployees: type: - number - 'null' websiteUrl: type: - string - 'null' industry: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - companyType - name - description - domain - locality - numberOfEmployees - websiteUrl - industry - createdAt - updatedAt relationships: type: object properties: owner: type: object properties: data: type: object properties: id: type: string required: - id required: - data required: - owner required: - id - attributes - relationships required: - data - type: object properties: links: anyOf: - type: object properties: next: type: - string - 'null' - type: 'null' examples: example-1: value: data: - id: -98779064.77779308 attributes: companyType: sunt ullamco anim culpa mollit name: null description: adipisicing in ex magna domain: eu in nostrud dolor locality: mollit velit numberOfEmployees: null websiteUrl: null industry: null createdAt: '2014-12-13T04:12:21.0Z' updatedAt: '2001-05-08T17:14:16.0Z' relationships: owner: data: id: ullamco veniam fugiat links: next: deserunt dolore eiusmod non requestBody: content: application/json: schema: type: object properties: filters: type: object properties: name: type: string domain: type: string cursor: type: string examples: example-1: value: filters: name: non amet domain: consequat officia pariatur cursor: occaecat in cupidatat operationId: list-accounts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/mailboxes/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: allOf: - type: object properties: data: type: array items: type: object properties: id: type: number attributes: type: object properties: email: type: string userId: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - email - userId - createdAt - updatedAt required: - id - attributes required: - data - type: object properties: links: anyOf: - type: object properties: next: type: - string - 'null' - type: 'null' examples: example-1: value: data: - id: 13399360.674311906 attributes: email: ex et cillum Ut userId: 21821.89441342652 createdAt: '2021-01-19T02:01:42.0Z' updatedAt: '2004-10-23T21:57:02.0Z' links: next: eiusmod velit sit adipisicing do requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: sint operationId: list-mailboxes parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/mailings/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: bodyHtml: type: - string - 'null' bodyText: type: - string - 'null' bouncedAt: type: - string - 'null' clickCount: type: - number - 'null' clickedAt: type: - string - 'null' deliveredAt: type: - string - 'null' openCount: type: - number - 'null' openedAt: type: - string - 'null' repliedAt: type: - string - 'null' subject: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - bodyHtml - bodyText - bouncedAt - clickCount - clickedAt - deliveredAt - openCount - openedAt - repliedAt - subject - createdAt - updatedAt relationships: type: object properties: user: anyOf: - type: object properties: data: type: object properties: id: type: string required: - id required: - data - type: 'null' sequence: anyOf: - {} - type: 'null' required: - user - sequence required: - id - attributes - relationships examples: example-1: value: data: id: 5137231.793693602 attributes: bodyHtml: cupidatat bodyText: null bouncedAt: null clickCount: 28489713.583598062 clickedAt: exercitation laboris ut dolor deliveredAt: null openCount: 31207064.983144134 openedAt: incididunt repliedAt: null subject: pariatur eiusmod proident cillum createdAt: '1982-08-17T16:44:39.0Z' updatedAt: '1979-10-11T23:52:57.0Z' relationships: user: data: id: ullamco sunt aliqua requestBody: content: application/json: schema: type: object properties: id: type: number examples: example-1: value: id: 10015340.752246797 operationId: find-mailing parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/mailings/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: allOf: - type: object properties: data: type: array items: type: object properties: id: type: number attributes: type: object properties: bodyHtml: type: - string - 'null' bodyText: type: - string - 'null' bouncedAt: type: - string - 'null' clickCount: type: - number - 'null' clickedAt: type: - string - 'null' deliveredAt: type: - string - 'null' openCount: type: - number - 'null' openedAt: type: - string - 'null' repliedAt: type: - string - 'null' subject: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - bodyHtml - bodyText - bouncedAt - clickCount - clickedAt - deliveredAt - openCount - openedAt - repliedAt - subject - createdAt - updatedAt relationships: type: object properties: user: anyOf: - type: object properties: data: type: object properties: id: type: string required: - id required: - data - type: 'null' sequence: anyOf: - {} - type: 'null' required: - user - sequence required: - id - attributes - relationships required: - data - type: object properties: links: anyOf: - type: object properties: next: type: - string - 'null' - type: 'null' examples: example-1: value: data: - id: 17365327.076577142 attributes: bodyHtml: commodo culpa bodyText: null bouncedAt: null clickCount: null clickedAt: null deliveredAt: Ut et Excepteur ex tempor openCount: 52168259.10125035 openedAt: in exercitation et minim do repliedAt: tempor pariatur subject: null createdAt: '1989-10-21T22:32:09.0Z' updatedAt: '2004-05-03T11:32:44.0Z' relationships: user: data: id: aliqua Duis incididunt links: next: null requestBody: content: application/json: schema: type: object properties: cursor: type: string filters: type: object properties: prospectId: type: number sequenceId: type: number examples: example-1: value: cursor: deserunt esse filters: sequenceId: -57639451.95482893 prospectId: -23727739.721193954 operationId: list-mailings parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/prospects/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' occupation: type: - string - 'null' addressCity: type: - string - 'null' addressCountry: type: - string - 'null' addressState: type: - string - 'null' addressStreet: type: - string - 'null' addressStreet2: type: - string - 'null' addressZip: type: - string - 'null' emails: anyOf: - type: array items: type: string - type: 'null' homePhones: anyOf: - type: array items: type: string - type: 'null' mobilePhones: anyOf: - type: array items: type: string - type: 'null' otherPhones: anyOf: - type: array items: type: string - type: 'null' workPhones: anyOf: - type: array items: type: string - type: 'null' clickCount: type: - number - 'null' openCount: type: - number - 'null' replyCount: type: - number - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - firstName - lastName - occupation - addressCity - addressCountry - addressState - addressStreet - addressStreet2 - addressZip - emails - homePhones - mobilePhones - otherPhones - workPhones - clickCount - openCount - replyCount - createdAt - updatedAt relationships: type: object properties: owner: anyOf: - type: object properties: data: type: object properties: id: type: string required: - id required: - data - type: 'null' account: anyOf: - {} - type: 'null' required: - id - attributes - relationships examples: example-1: value: data: id: 80591692.27684051 attributes: firstName: null lastName: null occupation: null addressCity: enim sed Excepteur commodo addressCountry: null addressState: null addressStreet: occaecat cupidatat in dolor ut addressStreet2: null addressZip: null emails: - laboris ad dolore homePhones: - sed culpa commodo esse anim mobilePhones: - velit ullamco ut otherPhones: null workPhones: null clickCount: null openCount: 28404165.844468072 replyCount: null createdAt: '2001-07-27T03:37:06.0Z' updatedAt: '2006-10-31T01:02:06.0Z' relationships: owner: null requestBody: content: application/json: schema: type: object properties: attributes: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' occupation: type: - string - 'null' addressCity: type: - string - 'null' addressCountry: type: - string - 'null' addressState: type: - string - 'null' addressStreet: type: - string - 'null' addressStreet2: type: - string - 'null' addressZip: type: - string - 'null' emails: type: array items: type: string relationships: type: object properties: ownerId: type: number accountId: type: number examples: example-1: value: attributes: firstName: null addressCity: null addressStreet2: commodo do anim Excepteur in emails: - velit occupation: null addressState: dolore elit culpa qui aute addressCountry: sit enim id veniam lastName: amet proident aliquip addressStreet: magna non laboris nisi addressZip: do dolore relationships: accountId: 79232671.17152092 ownerId: 76293205.50088212 operationId: create-prospect parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/prospects/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' occupation: type: - string - 'null' addressCity: type: - string - 'null' addressCountry: type: - string - 'null' addressState: type: - string - 'null' addressStreet: type: - string - 'null' addressStreet2: type: - string - 'null' addressZip: type: - string - 'null' emails: anyOf: - type: array items: type: string - type: 'null' homePhones: anyOf: - type: array items: type: string - type: 'null' mobilePhones: anyOf: - type: array items: type: string - type: 'null' otherPhones: anyOf: - type: array items: type: string - type: 'null' workPhones: anyOf: - type: array items: type: string - type: 'null' clickCount: type: - number - 'null' openCount: type: - number - 'null' replyCount: type: - number - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - firstName - lastName - occupation - addressCity - addressCountry - addressState - addressStreet - addressStreet2 - addressZip - emails - homePhones - mobilePhones - otherPhones - workPhones - clickCount - openCount - replyCount - createdAt - updatedAt relationships: type: object properties: owner: anyOf: - type: object properties: data: type: object properties: id: type: string required: - id required: - data - type: 'null' account: anyOf: - {} - type: 'null' required: - id - attributes - relationships examples: example-1: value: data: id: 68184234.67225495 attributes: firstName: null lastName: null occupation: null addressCity: null addressCountry: exercitation dolor eiusmod addressState: null addressStreet: ut eu dolore addressStreet2: tempor laboris nulla do addressZip: proident aliquip in emails: null homePhones: null mobilePhones: null otherPhones: - deserunt Lorem occaecat Duis nostrud workPhones: - cillum aliquip clickCount: -62776367.167051636 openCount: null replyCount: -42069278.108680755 createdAt: '1974-05-01T23:03:44.0Z' updatedAt: '1988-11-03T01:31:22.0Z' relationships: owner: data: id: commodo account: null requestBody: content: application/json: schema: type: object properties: id: type: number examples: example-1: value: id: 39770475.74343881 operationId: find-prospect parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/prospects/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: allOf: - type: object properties: data: type: array items: type: object properties: id: type: number attributes: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' occupation: type: - string - 'null' addressCity: type: - string - 'null' addressCountry: type: - string - 'null' addressState: type: - string - 'null' addressStreet: type: - string - 'null' addressStreet2: type: - string - 'null' addressZip: type: - string - 'null' emails: anyOf: - type: array items: type: string - type: 'null' homePhones: anyOf: - type: array items: type: string - type: 'null' mobilePhones: anyOf: - type: array items: type: string - type: 'null' otherPhones: anyOf: - type: array items: type: string - type: 'null' workPhones: anyOf: - type: array items: type: string - type: 'null' clickCount: type: - number - 'null' openCount: type: - number - 'null' replyCount: type: - number - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - firstName - lastName - occupation - addressCity - addressCountry - addressState - addressStreet - addressStreet2 - addressZip - emails - homePhones - mobilePhones - otherPhones - workPhones - clickCount - openCount - replyCount - createdAt - updatedAt relationships: type: object properties: owner: anyOf: - type: object properties: data: type: object properties: id: type: string required: - id required: - data - type: 'null' account: anyOf: - {} - type: 'null' required: - id - attributes - relationships required: - data - type: object properties: links: anyOf: - type: object properties: next: type: - string - 'null' - type: 'null' examples: example-1: value: data: - id: -44768200.32322064 attributes: firstName: aliquip dolore ullamco irure fugiat lastName: est non ex sit elit occupation: Excepteur laboris consectetur consequat addressCity: null addressCountry: null addressState: null addressStreet: null addressStreet2: cupidatat exercitation id sunt laborum addressZip: null emails: null homePhones: null mobilePhones: - Excepteur adipisicing otherPhones: null workPhones: null clickCount: null openCount: null replyCount: null createdAt: '2008-07-04T02:44:33.0Z' updatedAt: '2001-01-18T15:16:23.0Z' relationships: owner: data: id: Ut links: null requestBody: content: application/json: schema: type: object properties: filters: type: object properties: emails: type: string required: - emails cursor: type: string examples: example-1: value: filters: emails: elit ut velit cursor: sit aliquip occaecat operationId: list-prospects parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/prospects/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' occupation: type: - string - 'null' addressCity: type: - string - 'null' addressCountry: type: - string - 'null' addressState: type: - string - 'null' addressStreet: type: - string - 'null' addressStreet2: type: - string - 'null' addressZip: type: - string - 'null' emails: anyOf: - type: array items: type: string - type: 'null' homePhones: anyOf: - type: array items: type: string - type: 'null' mobilePhones: anyOf: - type: array items: type: string - type: 'null' otherPhones: anyOf: - type: array items: type: string - type: 'null' workPhones: anyOf: - type: array items: type: string - type: 'null' clickCount: type: - number - 'null' openCount: type: - number - 'null' replyCount: type: - number - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - firstName - lastName - occupation - addressCity - addressCountry - addressState - addressStreet - addressStreet2 - addressZip - emails - homePhones - mobilePhones - otherPhones - workPhones - clickCount - openCount - replyCount - createdAt - updatedAt relationships: type: object properties: owner: anyOf: - type: object properties: data: type: object properties: id: type: string required: - id required: - data - type: 'null' account: anyOf: - {} - type: 'null' required: - id - attributes - relationships examples: example-1: value: data: id: -58545856.5729291 attributes: firstName: null lastName: aute sint dolore occupation: null addressCity: null addressCountry: null addressState: null addressStreet: null addressStreet2: null addressZip: aliquip voluptate fugiat id emails: null homePhones: null mobilePhones: - adipisicing aliquip velit deserunt otherPhones: - cillum aliquip velit workPhones: - commodo ipsum clickCount: 49204853.20410663 openCount: 46550608.29722616 replyCount: null createdAt: '1953-03-23T11:07:20.0Z' updatedAt: '1966-04-10T01:22:26.0Z' relationships: owner: data: id: magna elit reprehenderit aliquip requestBody: content: application/json: schema: type: object properties: id: type: number attributes: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' occupation: type: - string - 'null' addressCity: type: - string - 'null' addressCountry: type: - string - 'null' addressState: type: - string - 'null' addressStreet: type: - string - 'null' addressStreet2: type: - string - 'null' addressZip: type: - string - 'null' examples: example-1: value: id: 23284383.97091639 attributes: addressStreet2: esse addressState: ipsum quis firstName: null addressCountry: in officia nulla in lastName: est labore addressStreet: null addressCity: ut occupation: incididunt dolor magna laborum addressZip: et ex operationId: update-prospect parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/sequence-states/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: {} relationships: type: object properties: prospect: type: object properties: data: type: object properties: id: type: string required: - id required: - data sequence: {} mailbox: {} required: - prospect - sequence - mailbox required: - id - attributes - relationships examples: example-1: value: data: id: 63804386.34817743 attributes: {} relationships: prospect: data: id: exercitation commodo requestBody: content: application/json: schema: type: object properties: relationships: type: object properties: prospectId: type: number sequenceId: type: number mailboxId: type: number required: - prospectId - sequenceId - mailboxId examples: example-1: value: relationships: prospectId: -70103019.51049876 sequenceId: 93699420.55675119 mailboxId: 45691285.64025861 operationId: create-sequence-state parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/sequences/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: name: type: string bounceCount: type: number clickCount: type: number deliverCount: type: number description: type: - string - 'null' enabled: type: boolean openCount: type: number optOutCount: type: number replyCount: type: number scheduleCount: type: number sequenceStepCount: type: number tags: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - name - bounceCount - clickCount - deliverCount - description - enabled - openCount - optOutCount - replyCount - scheduleCount - sequenceStepCount - tags - createdAt - updatedAt relationships: type: object properties: {} required: - id - attributes - relationships examples: example-1: value: data: id: -88688637.86527786 attributes: name: ex veniam dolor in bounceCount: -84594399.34797852 clickCount: -67364965.20228843 deliverCount: 59766267.891215146 description: null enabled: false openCount: 89312604.12766996 optOutCount: -33785129.26377697 replyCount: 55594000.38105786 scheduleCount: -15140271.236715779 sequenceStepCount: 42862179.63476524 tags: - reprehenderit ullamco do Lorem createdAt: '1962-07-27T19:01:29.0Z' updatedAt: '1997-11-28T05:51:44.0Z' relationships: {} requestBody: content: application/json: schema: type: object properties: id: type: number examples: example-1: value: id: 23070234.56027913 operationId: find-sequence parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/sequences/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: allOf: - type: object properties: data: type: array items: type: object properties: id: type: number attributes: type: object properties: name: type: string bounceCount: type: number clickCount: type: number deliverCount: type: number description: type: - string - 'null' enabled: type: boolean openCount: type: number optOutCount: type: number replyCount: type: number scheduleCount: type: number sequenceStepCount: type: number tags: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - name - bounceCount - clickCount - deliverCount - description - enabled - openCount - optOutCount - replyCount - scheduleCount - sequenceStepCount - tags - createdAt - updatedAt relationships: type: object properties: {} required: - id - attributes - relationships required: - data - type: object properties: links: anyOf: - type: object properties: next: type: - string - 'null' - type: 'null' examples: example-1: value: data: - id: -4317515.007753372 attributes: name: non proident incididunt ipsum laborum bounceCount: 2645223.4464615136 clickCount: 86024256.1611695 deliverCount: 25691750.276609376 description: null enabled: true openCount: -37314450.80330684 optOutCount: 10295368.58562529 replyCount: 66884542.30809149 scheduleCount: 54406252.23085269 sequenceStepCount: 72393889.40702525 tags: - Duis occaecat magna createdAt: '1950-06-23T15:23:55.0Z' updatedAt: '1969-04-07T20:05:22.0Z' relationships: {} links: next: null requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: irure reprehenderit elit officia ullamco operationId: list-sequences parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/users/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: firstName: type: string lastName: type: string email: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - firstName - lastName - email - createdAt - updatedAt relationships: type: object properties: {} required: - id - attributes - relationships examples: example-1: value: data: id: -30901637.883632958 attributes: firstName: tempor lastName: ad laborum consequat email: est Duis occaecat createdAt: '1963-01-08T13:01:41.0Z' updatedAt: '1975-02-17T21:42:10.0Z' relationships: {} requestBody: content: application/json: schema: type: object properties: id: type: number examples: example-1: value: id: -88922724.81974715 operationId: find-user parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/users/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: allOf: - type: object properties: data: type: array items: type: object properties: id: type: number attributes: type: object properties: firstName: type: string lastName: type: string email: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - firstName - lastName - email - createdAt - updatedAt relationships: type: object properties: {} required: - id - attributes - relationships required: - data - type: object properties: links: anyOf: - type: object properties: next: type: - string - 'null' - type: 'null' examples: example-1: value: data: - id: -17979996.475858465 attributes: firstName: nostrud et in ex enim lastName: Ut laboris amet ipsum email: Duis aute nulla Lorem createdAt: '2010-02-10T04:26:16.0Z' updatedAt: '1993-08-07T21:22:04.0Z' relationships: {} links: next: fugiat culpa requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: enim operationId: list-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/sequences/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number attributes: type: object properties: name: type: string bounceCount: type: number clickCount: type: number deliverCount: type: number description: type: - string - 'null' enabled: type: boolean openCount: type: number optOutCount: type: number replyCount: type: number scheduleCount: type: number sequenceStepCount: type: number tags: type: array items: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - name - bounceCount - clickCount - deliverCount - description - enabled - openCount - optOutCount - replyCount - scheduleCount - sequenceStepCount - tags - createdAt - updatedAt relationships: type: object properties: {} required: - id - attributes - relationships examples: example-1: value: data: id: -63777477.74138864 attributes: name: dolore in bounceCount: -98350643.1525964 clickCount: 74572831.23432362 deliverCount: 2726754.36776568 description: null enabled: false openCount: 3765773.9645832926 optOutCount: 99843628.57939288 replyCount: 19056627.477946937 scheduleCount: 80495941.69729298 sequenceStepCount: 84887685.23504916 tags: - fugiat ut est createdAt: '2018-04-30T08:35:51.0Z' updatedAt: '1982-07-28T04:57:44.0Z' relationships: {} requestBody: content: application/json: schema: type: object properties: attributes: type: object properties: name: type: string sequenceType: type: string enum: - date - interval shareType: type: string enum: - private - read_only - shared required: - name - sequenceType - shareType examples: example-1: value: attributes: name: non in sequenceType: interval shareType: shared operationId: create-sequence parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/templates/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number required: - id examples: example-1: value: data: id: 67955629.79071575 requestBody: content: application/json: schema: type: object properties: attributes: type: object properties: bodyHtml: type: string name: type: string subject: type: - string - 'null' trackOpens: type: boolean required: - bodyHtml - name examples: example-1: value: attributes: bodyHtml: eiusmod nulla anim eu name: Excepteur trackOpens: true subject: nisi minim consectetur irure operationId: create-template parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/outreach/sequence-templates/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number required: - id examples: example-1: value: data: id: 52648232.56628111 requestBody: content: application/json: schema: type: object properties: attributes: type: object properties: isReply: type: boolean required: - isReply relationships: type: object properties: sequenceStepId: type: number templateId: type: number required: - sequenceStepId - templateId examples: example-1: value: attributes: isReply: false relationships: sequenceStepId: -25342478.74707681 templateId: 88822467.83166945 operationId: create-sequence-template parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/extensions/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string extensionNumber: type: string contact: type: object properties: firstName: type: string lastName: type: string email: type: string company: type: string jobTitle: type: string businessPhone: type: string required: - firstName - lastName - email - company - jobTitle - businessPhone status: type: string type: type: string permissions: type: object properties: admin: type: object properties: enabled: type: boolean required: - enabled internationalCalling: type: object properties: enabled: type: boolean required: - enabled required: - admin - internationalCalling examples: example-1: value: id: dolor id pariatur consequat Lorem extensionNumber: sunt labore aliqua mollit contact: firstName: culpa lastName: commodo ullamco aute email: culpa voluptate company: aliqua sed sint jobTitle: sed businessPhone: velit pariatur status: deserunt laboris eu velit type: quis aliqua mollit laborum permissions: admin: enabled: true internationalCalling: enabled: true requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: qui mollit do magna pariatur operationId: find-extension parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/extensions/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: records: type: array items: type: object properties: id: type: string extensionNumber: type: string contact: type: object properties: firstName: type: string lastName: type: string email: type: string company: type: string jobTitle: type: string businessPhone: type: string required: - firstName - lastName - email - company - jobTitle - businessPhone status: type: string type: type: string permissions: type: object properties: admin: type: object properties: enabled: type: boolean required: - enabled internationalCalling: type: object properties: enabled: type: boolean required: - enabled required: - admin - internationalCalling required: - id - extensionNumber - status - type - permissions navigation: type: object properties: firstPage: type: object properties: uri: type: string required: - uri lastPage: type: object properties: uri: type: string required: - uri required: - firstPage - lastPage paging: type: object properties: page: type: number totalPages: type: number perPage: type: number totalElements: type: number pageStart: type: number pageEnd: type: number required: - page - totalPages - perPage - totalElements - pageStart - pageEnd examples: example-1: value: records: - id: tempor nulla officia extensionNumber: cupidatat amet qui in status: consequat type: quis nulla laborum laboris incididunt permissions: admin: enabled: false internationalCalling: enabled: true contact: firstName: sint nostrud lastName: nulla email: dolor aute officia pariatur company: sint quis jobTitle: ullamco businessPhone: Excepteur amet navigation: firstPage: uri: eu Lorem aliquip et proident lastPage: uri: ad cupidatat Ut incididunt voluptate paging: page: 33072865.43367645 totalPages: -60870314.004288994 perPage: 25910406.691145703 totalElements: 84326421.54368293 pageStart: -38641881.53976351 pageEnd: 10083083.209457293 requestBody: content: application/json: schema: type: object properties: page: type: number perPage: type: number examples: example-1: value: page: 47116707.53491646 perPage: 6726509.48037678 operationId: list-extensions parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/extensions/ring-out: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: uri: type: string id: type: string status: type: object properties: callStatus: type: string callerStatus: type: string calleeStatus: type: string required: - callStatus - callerStatus - calleeStatus examples: example-1: value: uri: adipisicing id: veniam dolore minim aute amet status: callStatus: anim do proident callerStatus: do aliqua eu calleeStatus: labore reprehenderit enim eu veniam requestBody: content: application/json: schema: type: object properties: extensionId: type: string default: '~' from: type: object properties: phoneNumber: type: string required: - phoneNumber to: type: object properties: phoneNumber: type: string required: - phoneNumber playPrompt: type: boolean callerId: type: object properties: phoneNumber: type: string required: - phoneNumber callId: type: string sipInfo: type: array items: type: object properties: transport: type: string uri: type: string username: type: string password: type: string required: - transport - uri - username - password examples: example-1: value: extensionId: labore Excepteur est aliquip ut from: phoneNumber: minim Lorem dolore elit est to: phoneNumber: ex ullamco veniam playPrompt: false callerId: phoneNumber: voluptate mollit aliquip proident callId: sunt nostrud aute cillum labore sipInfo: - transport: dolor consectetur ea uri: ea username: consectetur password: velit veniam in magna proident operationId: extension-ring-out parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/call-logs/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: records: type: array items: type: object properties: id: type: string sessionId: type: string startTime: type: string format: date-time duration: type: number type: type: string direction: type: string enum: - Inbound - Outbound action: type: string result: type: string from: type: object properties: phoneNumber: type: string extensionId: type: string name: type: string required: - phoneNumber to: type: object properties: phoneNumber: type: string extensionId: type: string name: type: string required: - phoneNumber required: - id - sessionId - startTime - duration - type - direction - action - result - from - to navigation: type: object properties: firstPage: type: object properties: uri: type: string required: - uri lastPage: type: object properties: uri: type: string required: - uri required: - firstPage - lastPage paging: type: object properties: page: type: number totalPages: type: number perPage: type: number totalElements: type: number pageStart: type: number pageEnd: type: number required: - page - totalPages - perPage - totalElements - pageStart - pageEnd examples: example-1: value: records: - id: aliquip Ut nisi aliqua consectetur sessionId: id incididunt ex startTime: '1968-03-21T05:33:09.0Z' duration: 93187647.87376991 type: culpa direction: Inbound action: cillum velit sunt result: ex commodo est laborum from: phoneNumber: nisi quis deserunt Ut extensionId: ex elit aliqua id name: pariatur mollit sed to: phoneNumber: fugiat elit id extensionId: ut name: Duis ea navigation: firstPage: uri: ex sint laborum non reprehenderit lastPage: uri: consectetur quis velit paging: page: 36495239.3854146 totalPages: -2248060.29560183 perPage: -11657628.161641657 totalElements: -5697191.809851572 pageStart: -7964861.725046158 pageEnd: 50683088.381227255 requestBody: content: application/json: schema: type: object properties: page: type: number perPage: type: number examples: example-1: value: page: 5457071.296896696 perPage: 75920347.9896104 operationId: list-call-logs parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/call-logs/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string sessionId: type: string startTime: type: string format: date-time duration: type: number type: type: string direction: type: string enum: - Inbound - Outbound action: type: string result: type: string from: type: object properties: phoneNumber: type: string extensionId: type: string name: type: string required: - phoneNumber to: type: object properties: phoneNumber: type: string extensionId: type: string name: type: string required: - phoneNumber examples: example-1: value: id: ad commodo culpa sessionId: nulla startTime: '2011-04-30T05:03:08.0Z' duration: 53759700.54297939 type: occaecat dolor amet velit direction: Outbound action: pariatur dolor officia laborum result: nostrud from: phoneNumber: ullamco quis extensionId: sed name: mollit est nostrud occaecat to: phoneNumber: irure in name: ea extensionId: fugiat eiusmod requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: cupidatat fugiat esse ex operationId: find-call-log parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/contacts/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: records: type: array items: type: object properties: id: type: string firstName: type: string lastName: type: string company: type: string email: type: string businessPhone: type: string required: - id - firstName - lastName - businessPhone navigation: type: object properties: firstPage: type: object properties: uri: type: string required: - uri lastPage: type: object properties: uri: type: string required: - uri required: - firstPage - lastPage paging: type: object properties: page: type: number totalPages: type: number perPage: type: number totalElements: type: number pageStart: type: number pageEnd: type: number required: - page - totalPages - perPage - totalElements - pageStart - pageEnd examples: example-1: value: records: - id: nisi firstName: ipsum lastName: ea businessPhone: laboris ex dolore velit email: consectetur sint incididunt magna company: incididunt dolor esse pariatur et navigation: firstPage: uri: consectetur lastPage: uri: exercitation ex mollit aliqua eu paging: page: 94186522.12574443 totalPages: 84738298.98033732 perPage: -75460480.56643744 totalElements: 34088262.239090115 pageStart: 79835565.66606507 pageEnd: 15002986.66306512 requestBody: content: application/json: schema: type: object properties: page: type: number perPage: type: number examples: example-1: value: page: 45710349.24480158 perPage: -86985892.37188657 operationId: list-contacts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/contacts/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string company: type: string email: type: string businessPhone: type: string examples: example-1: value: id: consectetur est Ut firstName: reprehenderit in officia Lorem lastName: in company: tempor amet deserunt adipisicing email: voluptate veniam sed in businessPhone: dolor eiusmod requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: Duis sint et esse est operationId: find-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/contacts/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string company: type: string email: type: string businessPhone: type: string examples: example-1: value: id: velit firstName: ipsum eiusmod lastName: proident sit magna company: culpa nisi ea aliqua email: amet nostrud irure businessPhone: Ut requestBody: content: application/json: schema: type: object properties: firstName: type: string lastName: type: string company: type: string email: type: string businessPhone: type: string examples: example-1: value: firstName: ullamco lastName: in id sunt magna company: dolor aliquip email: nostrud cillum businessPhone: dolore dolor ullamco operationId: create-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/ringcentral/contacts/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string company: type: string email: type: string businessPhone: type: string examples: example-1: value: id: irure et dolor magna qui firstName: commodo lastName: amet Ut Lorem sit in company: pariatur voluptate email: in non dolore businessPhone: mollit dolore requestBody: content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string company: type: string email: type: string businessPhone: type: string examples: example-1: value: id: incididunt minim cillum Excepteur Lorem firstName: Excepteur anim nulla id dolor lastName: velit laborum sint nostrud company: cupidatat cillum magna veniam culpa email: officia Excepteur esse exercitation businessPhone: aliquip elit ea cupidatat operationId: update-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/soql/query: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object examples: example-1: value: records: - id: 123123 requestBody: content: application/json: schema: type: object properties: query: type: string required: - query examples: example-1: value: query: SELECT FIELDS(ALL) FROM Account LIMIT 200 operationId: query-soql parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/contacts/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: incididunt amet requestBody: content: application/json: schema: type: object properties: email: type: string format: email firstName: type: string lastName: type: string title: type: string phone: type: string mobilePhone: type: string accountId: type: string ownerId: type: string examples: example-1: value: email: LjNrr@LrrFgCyBnuLYB.jq firstName: do labore minim sed et lastName: culpa pariatur quis magna eu title: do consequat non phone: nostrud consequat dolore ea amet mobilePhone: adipisicing esse ullamco accountId: consequat quis dolore laborum tempor ownerId: do operationId: create-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/contacts/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string title: type: string email: type: string format: email phone: type: string mobilePhone: type: string createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time accountId: type: string ownerId: type: string examples: example-1: value: id: proident amet aute firstName: enim proident lastName: aute nulla nisi title: dolore velit esse ipsum email: UYHWlhtmc5V-Bw@xRhixCoQDAvCPPMqLEqRjtz.idt phone: aliquip laboris Duis mobilePhone: in in createdDate: '1979-10-07T13:17:14.0Z' lastModifiedDate: '1948-11-29T05:09:02.0Z' accountId: do ex ownerId: Excepteur pariatur requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: minim tempor Excepteur adipisicing operationId: find-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/contacts/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: records: type: array items: type: object properties: id: type: string firstName: type: string lastName: type: string title: type: string email: type: string format: email phone: type: string mobilePhone: type: string createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time accountId: type: string ownerId: type: string required: - Id - FirstName - LastName - Title - Email - Phone - MobilePhone - CreatedDate - LastModifiedDate - AccountId - OwnerId totalSize: type: number examples: example-1: value: records: - mobilePhone: est lastName: do eu nisi sed title: cillum enim ex sint ownerId: Ut phone: dolor sit nostrud irure createdDate: '1950-02-25T16:34:16.0Z' id: ex nisi email: yKE4mgV@bixrK.oj lastModifiedDate: '2014-06-08T19:31:49.0Z' firstName: sed ut voluptate in accountId: commodo Lorem tempor reprehenderit pariatur totalSize: -40874731.60621861 requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: consectetur in enim nulla occaecat operationId: list-contacts parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/contacts/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string title: type: string email: type: string format: email phone: type: string mobilePhone: type: string createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time accountId: type: string ownerId: type: string examples: example-1: value: id: anim firstName: commodo nisi ex lastName: veniam minim eiusmod in velit title: occaecat tempor sed email: 8fGmgOB3g3@WCdbTLhGhPvjNLbPE.iyo phone: Lorem do ut mobilePhone: aliqua labore dolore eiusmod createdDate: '1965-01-19T17:20:36.0Z' lastModifiedDate: '2008-09-11T07:16:49.0Z' accountId: officia adipisicing eiusmod ownerId: sint in deserunt sit voluptate requestBody: content: application/json: schema: type: object properties: id: type: string contact: type: object properties: email: type: string format: email firstName: type: string lastName: type: string title: type: string phone: type: string mobilePhone: type: string accountId: type: string ownerId: type: string examples: example-1: value: id: nostrud proident do aliqua contact: lastName: minim sed firstName: in veniam voluptate Lorem adipisicing phone: ad labore do minim pariatur email: h-NsmggtDj@ydCskIbOHlwtzcEfgcjIVuLFJYcvD.rv title: quis veniam id exercitation accountId: quis occaecat labore Ut ea mobilePhone: quis sunt ea ownerId: exercitation sed nulla sint et operationId: update-contact parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/list-views/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time createdById: type: string examples: example-1: value: id: consectetur dolor minim ea in name: ex sit ut qui officia createdDate: '1989-08-24T05:06:45.0Z' lastModifiedDate: '1963-07-03T11:25:18.0Z' createdById: culpa laborum Lorem anim requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: dolor commodo sint incididunt operationId: find-list-view parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/list-views/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: records: type: array items: type: object properties: id: type: string name: type: string createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time createdById: type: string required: - Id - Name - CreatedDate - LastModifiedDate - CreatedById totalSize: type: number examples: example-1: value: records: - createdById: culpa proident lastModifiedDate: '1947-12-22T17:17:44.0Z' name: Lorem dolor eu Ut createdDate: '1992-06-23T04:42:21.0Z' id: do esse totalSize: 22160176.21787159 requestBody: content: application/json: schema: type: object properties: cursor: type: string objectType: type: string examples: example-1: value: cursor: consectetur objectType: pariatur in operationId: list-list-views parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/list-view-results/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: developerName: type: string done: type: boolean id: type: string label: type: string records: type: array items: type: object properties: columns: type: array items: type: object properties: fieldNameOrPath: type: string value: type: string required: - fieldNameOrPath - value required: - columns size: type: number examples: example-1: value: developerName: cupidatat magna non mollit culpa done: false id: nulla reprehenderit ullamco consectetur adipisicing label: enim records: - columns: - fieldNameOrPath: proident quis tempor ipsum id value: ea aliqua ut in do size: 11093394.578945532 requestBody: content: application/json: schema: type: object properties: id: type: string objectType: type: string examples: example-1: value: id: et velit dolor proident objectType: exercitation operationId: find-list-view-results parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/users/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: records: type: array items: type: object properties: id: type: string firstName: type: string lastName: type: string email: type: string format: email createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time required: - Id - FirstName - LastName - Email - CreatedDate - LastModifiedDate totalSize: type: number examples: example-1: value: records: - email: HUp@WhLSrUPqDJLAqsEYiGAIcxFkwUoha.wtwr lastName: nostrud veniam consequat ad id: exercitation Ut lastModifiedDate: '1966-12-31T10:48:54.0Z' createdDate: '1951-04-12T18:32:40.0Z' firstName: labore ut totalSize: -31617201.024693653 requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: elit Duis tempor operationId: list-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesforce/users/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string email: type: string format: email createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time examples: example-1: value: id: dolore dolor ex occaecat firstName: cillum labore Duis reprehenderit Ut lastName: commodo laboris do email: bvH@K.regs createdDate: '1990-05-03T09:31:29.0Z' lastModifiedDate: '1969-01-06T02:10:47.0Z' requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: sit ipsum Duis operationId: find-user parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/cadence-memberships/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number addedAt: type: string createdAt: type: string updatedAt: type: string personDeleted: type: - boolean - 'null' currentlyOnCadence: type: - boolean - 'null' currentState: type: - string - 'null' cadence: type: object properties: id: type: number required: - id person: anyOf: - type: object properties: id: type: number required: - id - type: 'null' user: anyOf: - type: object properties: id: type: number required: - id - type: 'null' latestAction: anyOf: - type: object properties: id: type: number required: - id - type: 'null' counts: anyOf: - type: object properties: views: type: - number - 'null' clicks: type: - number - 'null' replies: type: - number - 'null' calls: type: - number - 'null' sentEmails: type: - number - 'null' bounces: type: - number - 'null' - type: 'null' required: - id - added_at - created_at - updated_at - cadence examples: example-1: value: data: id: -56851202.11291372 cadence: id: 68386379.95007396 person: id: 64496267.23127252 addedAt: proident labore fugiat currentlyOnCadence: null counts: clicks: 56202174.847684234 views: 47311405.75283393 sentEmails: -5865150.638498351 bounces: -63153875.96998745 replies: 23815749.55406536 calls: -54771481.02616862 updatedAt: aliqua pariatur personDeleted: null currentState: null user: null createdAt: occaecat Lorem in exercitation cupidatat latestAction: null requestBody: content: application/json: schema: type: object properties: cadenceId: type: string personId: type: string userId: type: string examples: example-1: value: cadenceId: laboris dolore in sit personId: exercitation ut non ullamco userId: cupidatat anim dolore irure operationId: create-cadence-memberships parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/cadences/import: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: cadence: type: object properties: id: type: number required: - id required: - cadence examples: example-1: value: data: cadence: id: 99533124.307352 requestBody: content: application/json: schema: type: object properties: settings: type: object properties: name: type: string targetDailyPeople: type: number removeReplied: type: boolean removeBounced: type: boolean externalIdentifier: type: string cadenceFunction: type: string required: - name - target_daily_people - remove_replied - remove_bounced - cadence_function sharingSettings: type: object properties: teamCadence: type: boolean shared: type: boolean required: - team_cadence - shared cadenceContent: type: object properties: cadenceId: type: string stepGroups: type: array items: type: object properties: day: type: number dueImmediately: type: boolean automated: type: boolean referenceId: type: number steps: type: array items: type: object properties: enabled: type: boolean name: type: string type: type: string typeSettings: type: object properties: previousEmailStepGroupReferenceId: type: number emailTemplate: type: object properties: title: type: string subject: type: string body: type: string openTracking: type: boolean clickTracking: type: boolean required: - title - body required: - email_template required: - enabled - type - type_settings required: - day - due_immediately - automated - steps required: - cadence_id - step_groups examples: example-1: value: settings: name: reprehenderit ea id in targetDailyPeople: -76813105.53799015 removeReplied: true externalIdentifier: quis non exercitation ullamco aliqua removeBounced: false cadenceFunction: velit Duis sharingSettings: shared: true teamCadence: false cadenceContent: stepGroups: - day: 14706746.434673995 automated: false steps: - enabled: false type: Ut officia qui ea name: nostrud incididunt dolore typeSettings: emailTemplate: title: veniam nisi cillum dolore body: labore ut quis dolore tempor openTracking: true subject: exercitation clickTracking: false previousEmailStepGroupReferenceId: -14174382.60233967 referenceId: 58640405.702331275 dueImmediately: true cadenceId: magna qui sint in dolor operationId: import-cadences parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/cadences/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: - string - 'null' archivedAt: type: - string - 'null' teamCadence: type: - boolean - 'null' shared: type: - boolean - 'null' removeBouncesEnabled: type: - boolean - 'null' removeRepliesEnabled: type: - boolean - 'null' optOutLinkIncluded: type: - boolean - 'null' draft: type: - boolean - 'null' cadenceFrameworkId: type: - number - 'null' cadenceFunction: type: - string - 'null' externalIdentifier: type: - string - 'null' tags: type: array items: type: string counts: anyOf: - type: object properties: cadencePeople: type: - number - 'null' peopleActedOnCount: type: - number - 'null' targetDailyPeople: type: - number - 'null' opportunitiesCreated: type: - number - 'null' meetingsBooked: type: - number - 'null' - type: 'null' required: - id - created_at - updated_at - tags metadata: type: object properties: paging: type: object properties: perPage: type: number currentPage: type: number nextPage: type: - number - 'null' prevPage: type: - number - 'null' required: - per_page - current_page required: - paging examples: example-1: value: data: - id: -47475417.66640424 tags: - eu dolor labore quis laboris archivedAt: null shared: null cadenceFrameworkId: -89350510.1160029 teamCadence: null externalIdentifier: null cadenceFunction: null counts: cadencePeople: null opportunitiesCreated: -5111985.282995328 targetDailyPeople: 45759963.530312896 meetingsBooked: -94575881.1425458 peopleActedOnCount: -99701569.85847223 updatedAt: '2014-03-12T16:22:10.0Z' draft: false optOutLinkIncluded: false name: null removeRepliesEnabled: false createdAt: '1961-11-21T08:20:20.0Z' removeBouncesEnabled: null metadata: paging: prevPage: null nextPage: null perPage: -70282356.7250379 currentPage: 21899870.526472658 requestBody: content: application/json: schema: type: object properties: perPage: type: number page: type: number examples: example-1: value: perPage: -85979398.3336393 page: -20861037.012846455 operationId: list-cadences parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/custom-fields/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number name: type: string fieldType: type: string valueType: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - field_type - value_type - created_at - updated_at examples: example-1: value: data: id: 998397.7575469464 name: ad proident Duis in fieldType: consectetur irure updatedAt: '2009-10-20T12:55:45.0Z' createdAt: '1990-01-27T09:01:35.0Z' valueType: ipsum reprehenderit esse in requestBody: content: application/json: schema: type: object properties: name: type: string fieldType: type: string examples: example-1: value: name: sed fieldType: voluptate ad velit ex Ut operationId: create-custom-field parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/custom-fields/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: number name: type: string fieldType: type: string valueType: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - field_type - value_type - created_at - updated_at metadata: type: object properties: paging: type: object properties: perPage: type: number currentPage: type: number nextPage: type: - number - 'null' prevPage: type: - number - 'null' required: - per_page - current_page required: - paging examples: example-1: value: data: - id: 93178606.11422518 name: aliqua sunt laborum updatedAt: '2022-04-01T01:17:56.0Z' fieldType: proident cillum exercitation createdAt: '1998-09-24T10:31:27.0Z' valueType: pariatur laboris metadata: paging: perPage: -5327694.842459872 currentPage: 35961918.416861 prevPage: 11707237.020071521 nextPage: -11343082.460922897 requestBody: content: application/json: schema: type: object properties: perPage: type: number page: type: number fieldType: type: string examples: example-1: value: perPage: 54485764.757252544 page: 69047773.496629 fieldType: esse operationId: list-custom-fields parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/emailBodies/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number mailbox: type: - string - 'null' messageId: type: - string - 'null' raw: type: string required: - id - raw examples: example-1: value: data: id: 42741382.09717527 raw: aliqua mailbox: aliquip elit sint sit anim messageId: tempor nulla requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: elit officia dolore ea deserunt operationId: find-email-body parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/emails/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time recipientEmailAddress: type: - string - 'null' status: type: - string - 'null' bounced: type: boolean sendAfter: type: string format: date-time sentAt: type: string format: date-time viewTracking: type: boolean clickTracking: type: boolean subject: type: - string - 'null' errorMessage: type: - string - 'null' counts: anyOf: - type: object properties: clicks: type: - number - 'null' views: type: - number - 'null' replies: type: - number - 'null' uniqueDevices: type: - number - 'null' uniqueLocations: type: - number - 'null' attachments: type: - number - 'null' - type: 'null' user: anyOf: - type: object properties: id: type: number required: - id - type: 'null' cadence: anyOf: - type: object properties: id: type: number required: - id - type: 'null' required: - id - created_at - updated_at - bounced - send_after - sent_at - view_tracking - click_tracking metadata: type: object properties: paging: type: object properties: perPage: type: number currentPage: type: number nextPage: type: - number - 'null' prevPage: type: - number - 'null' required: - per_page - current_page required: - paging examples: example-1: value: data: - id: 50774689.744436145 bounced: true sentAt: '2005-07-26T20:32:31.0Z' status: null user: id: -9480558.144495845 errorMessage: eiusmod recipientEmailAddress: null createdAt: '1992-04-04T05:55:29.0Z' updatedAt: '2010-07-26T21:03:47.0Z' clickTracking: false cadence: null sendAfter: '1951-06-25T07:42:25.0Z' viewTracking: true subject: null counts: null metadata: paging: prevPage: null currentPage: -61910627.88594857 perPage: -5534388.110851824 nextPage: null requestBody: content: application/json: schema: type: object properties: perPage: type: number page: type: number personId: type: string cadenceId: type: string examples: example-1: value: perPage: 2707097.9769516736 page: -47577699.74596724 personId: mollit reprehenderit cadenceId: eiusmod nostrud operationId: list-emails parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/emails/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time recipientEmailAddress: type: - string - 'null' status: type: - string - 'null' bounced: type: boolean sendAfter: type: string format: date-time sentAt: type: string format: date-time viewTracking: type: boolean clickTracking: type: boolean subject: type: - string - 'null' errorMessage: type: - string - 'null' counts: anyOf: - type: object properties: clicks: type: - number - 'null' views: type: - number - 'null' replies: type: - number - 'null' uniqueDevices: type: - number - 'null' uniqueLocations: type: - number - 'null' attachments: type: - number - 'null' - type: 'null' user: anyOf: - type: object properties: id: type: number required: - id - type: 'null' cadence: anyOf: - type: object properties: id: type: number required: - id - type: 'null' required: - id - created_at - updated_at - bounced - send_after - sent_at - view_tracking - click_tracking examples: example-1: value: data: id: -61966070.53410075 bounced: true errorMessage: Excepteur in cillum ut sentAt: '1960-04-04T15:58:59.0Z' updatedAt: '2016-11-26T14:49:01.0Z' user: null counts: clicks: null replies: null views: -26029381.309456617 uniqueLocations: 56275534.15917128 uniqueDevices: null attachments: null status: null clickTracking: true viewTracking: false sendAfter: '2017-09-29T11:55:04.0Z' cadence: null recipientEmailAddress: null createdAt: '1966-02-10T04:19:08.0Z' subject: null requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: ut operationId: find-email parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/people/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number firstName: type: - string - 'null' lastName: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' country: type: - string - 'null' title: type: - string - 'null' owner: anyOf: - type: object properties: id: type: number required: - id - type: 'null' account: anyOf: - type: object properties: id: type: number required: - id - type: 'null' phone: type: - string - 'null' homePhone: type: - string - 'null' mobilePhone: type: - string - 'null' emailAddress: type: - string - 'null' secondaryEmailAddress: type: - string - 'null' personalEmailAddress: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time counts: type: object properties: emailsSent: type: - number - 'null' emailsViewed: type: - number - 'null' emailsClicked: type: - number - 'null' emailsRepliedTo: type: - number - 'null' emailsBounced: type: - number - 'null' calls: type: - number - 'null' customFields: type: object properties: {} required: - id - created_at - updated_at - counts - custom_fields examples: example-1: value: data: id: -92336448.50582077 counts: emailsViewed: -17944090.491637483 calls: null emailsSent: null emailsClicked: null emailsRepliedTo: 15606480.892245814 emailsBounced: -27334315.826718524 customFields: {} secondaryEmailAddress: sit adipisicing mobilePhone: deserunt quis enim account: id: -24525475.420395225 createdAt: '1956-07-19T23:44:09.0Z' firstName: null phone: null emailAddress: aliqua culpa laborum title: do dolore culpa sint minim state: null homePhone: incididunt id ex lastName: null owner: id: -57797586.78436493 updatedAt: '1995-01-10T17:40:45.0Z' city: anim personalEmailAddress: sed country: cillum sint elit cupidatat requestBody: content: application/json: schema: type: object properties: firstName: type: string lastName: type: string city: type: string state: type: string country: type: string title: type: string owner: type: object properties: id: type: string required: - id account: type: object properties: id: type: string required: - id emailAddress: type: string secondaryEmailAddress: type: string personalEmailAddress: type: string customFields: type: object properties: {} examples: example-1: value: firstName: adipisicing Duis amet fugiat sunt lastName: ipsum Ut city: velit enim reprehenderit state: sint magna esse aute country: dolore title: laboris adipisicing owner: id: ipsum labore sed est_e1f: -58512857 account: id: quis incididunt commodo eu esse emailAddress: laborum cupidatat aute Excepteur secondaryEmailAddress: laborum mollit magna cupidatat deserunt personalEmailAddress: id in eu customFields: {} operationId: create-people parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/people/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: number firstName: type: - string - 'null' lastName: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' country: type: - string - 'null' title: type: - string - 'null' owner: anyOf: - type: object properties: id: type: number required: - id - type: 'null' account: anyOf: - type: object properties: id: type: number required: - id - type: 'null' phone: type: - string - 'null' homePhone: type: - string - 'null' mobilePhone: type: - string - 'null' emailAddress: type: - string - 'null' secondaryEmailAddress: type: - string - 'null' personalEmailAddress: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time counts: type: object properties: emailsSent: type: - number - 'null' emailsViewed: type: - number - 'null' emailsClicked: type: - number - 'null' emailsRepliedTo: type: - number - 'null' emailsBounced: type: - number - 'null' calls: type: - number - 'null' customFields: type: object properties: {} required: - id - created_at - updated_at - counts - custom_fields metadata: type: object properties: paging: type: object properties: perPage: type: number currentPage: type: number nextPage: type: - number - 'null' prevPage: type: - number - 'null' required: - per_page - current_page required: - paging examples: example-1: value: data: - id: -55963748.18681875 counts: emailsBounced: 57427186.693143725 emailsViewed: 72481928.11805823 calls: null emailsSent: -82559208.09864339 emailsClicked: null emailsRepliedTo: null updatedAt: '1961-06-18T15:48:26.0Z' account: id: -85895580.83249034 firstName: null customFields: {} emailAddress: in adipisicing commodo ut laboris homePhone: null createdAt: '2008-08-02T10:40:30.0Z' country: minim sit in Duis city: null title: null lastName: null owner: null mobilePhone: null phone: null personalEmailAddress: Excepteur minim secondaryEmailAddress: null state: dolor in do ullamco enim metadata: paging: prevPage: 46108441.09997162 perPage: -83362988.7435222 currentPage: 38063242.9352926 nextPage: -90476444.6773323 requestBody: content: application/json: schema: type: object properties: perPage: type: number page: type: number examples: example-1: value: perPage: -67092425.651655674 page: 69361004.11237502 operationId: list-people parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/people/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number firstName: type: - string - 'null' lastName: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' country: type: - string - 'null' title: type: - string - 'null' owner: anyOf: - type: object properties: id: type: number required: - id - type: 'null' account: anyOf: - type: object properties: id: type: number required: - id - type: 'null' phone: type: - string - 'null' homePhone: type: - string - 'null' mobilePhone: type: - string - 'null' emailAddress: type: - string - 'null' secondaryEmailAddress: type: - string - 'null' personalEmailAddress: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time counts: type: object properties: emailsSent: type: - number - 'null' emailsViewed: type: - number - 'null' emailsClicked: type: - number - 'null' emailsRepliedTo: type: - number - 'null' emailsBounced: type: - number - 'null' calls: type: - number - 'null' customFields: type: object properties: {} required: - id - created_at - updated_at - counts - custom_fields examples: example-1: value: data: id: -75808608.35234779 counts: emailsViewed: 70008951.97278965 calls: null emailsSent: null emailsRepliedTo: null emailsBounced: -60175904.974657394 emailsClicked: 90963790.01933578 secondaryEmailAddress: null mobilePhone: Ut in irure sint city: sit dolore country: commodo dolor sint laboris firstName: veniam updatedAt: '2013-07-02T14:17:21.0Z' account: null lastName: sed enim phone: consectetur aliquip cupidatat consequat elit homePhone: null personalEmailAddress: magna emailAddress: Excepteur tempor esse customFields: {} createdAt: '2001-08-09T03:30:52.0Z' state: null owner: id: 61348502.3221409 title: null requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: aliquip occaecat operationId: find-people parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/people/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number firstName: type: - string - 'null' lastName: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' country: type: - string - 'null' title: type: - string - 'null' owner: anyOf: - type: object properties: id: type: number required: - id - type: 'null' account: anyOf: - type: object properties: id: type: number required: - id - type: 'null' phone: type: - string - 'null' homePhone: type: - string - 'null' mobilePhone: type: - string - 'null' emailAddress: type: - string - 'null' secondaryEmailAddress: type: - string - 'null' personalEmailAddress: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time counts: type: object properties: emailsSent: type: - number - 'null' emailsViewed: type: - number - 'null' emailsClicked: type: - number - 'null' emailsRepliedTo: type: - number - 'null' emailsBounced: type: - number - 'null' calls: type: - number - 'null' customFields: type: object properties: {} required: - id - created_at - updated_at - counts - custom_fields examples: example-1: value: data: id: -17721806.93246855 counts: calls: null emailsRepliedTo: 68786868.18103987 emailsClicked: 64482383.55830318 emailsSent: null emailsViewed: -12214551.915072918 emailsBounced: null emailAddress: null country: null firstName: nostrud officia account: null createdAt: '2017-12-03T13:06:32.0Z' customFields: {} title: Duis ut ipsum sit updatedAt: '1981-06-08T18:38:58.0Z' lastName: nisi in secondaryEmailAddress: null mobilePhone: null owner: id: 95769841.54799911 homePhone: Lorem do city: null personalEmailAddress: null phone: null state: in ut aliquip elit requestBody: content: application/json: schema: type: object properties: id: type: string firstName: type: string lastName: type: string city: type: string state: type: string country: type: string title: type: string owner: type: object properties: id: type: string required: - id account: type: object properties: id: type: string required: - id emailAddress: type: string secondaryEmailAddress: type: string personalEmailAddress: type: string customFields: type: object properties: {} examples: example-1: value: id: Excepteur proident sint firstName: mollit ex dolor commodo esse lastName: fugiat est quis Duis dolor city: incididunt state: veniam Lorem sit commodo consequat country: anim laboris officia nostrud title: dolore ut owner: id: velit deserunt sint ea cillum exercitationa: true account: id: quis emailAddress: labore ullamco secondaryEmailAddress: velit aute enim ea personalEmailAddress: commodo est aliquip occaecat deserunt customFields: {} operationId: update-people parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/users/find: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: number guid: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time firstName: type: - string - 'null' name: type: - string - 'null' lastName: type: - string - 'null' jobRole: type: - string - 'null' active: type: boolean timeZone: type: - string - 'null' slackUsername: type: - string - 'null' twitterHandle: type: - string - 'null' email: type: - string - 'null' emailClientEmailAddress: type: - string - 'null' sendingEmailAddress: type: - string - 'null' fromAddress: type: - string - 'null' fullEmailAddress: type: - string - 'null' bccEmailAddress: type: - string - 'null' workCountry: type: - string - 'null' emailSignature: type: - string - 'null' emailSignatureType: type: - string - 'null' emailSignatureClickTrackingDisabled: type: - boolean - 'null' teamAdmin: type: - boolean - 'null' localDialEnabled: type: - boolean - 'null' clickToCallEnabled: type: - boolean - 'null' emailClientConfigured: type: - boolean - 'null' crmConnected: type: - boolean - 'null' required: - id - guid - created_at - updated_at - active examples: example-1: value: data: id: 23291559.595152125 guid: est active: false jobRole: ex nostrud sed sendingEmailAddress: null emailSignature: null slackUsername: null fromAddress: amet dolor tempor id emailClientEmailAddress: qui updatedAt: '1989-08-10T17:14:27.0Z' fullEmailAddress: null teamAdmin: null name: null firstName: null emailSignatureType: nulla localDialEnabled: true email: null lastName: null workCountry: reprehenderit dolor aliqua ad clickToCallEnabled: false emailClientConfigured: null twitterHandle: sint sunt veniam emailSignatureClickTrackingDisabled: false createdAt: '1998-05-07T17:21:06.0Z' crmConnected: null bccEmailAddress: exercitation enim dolor timeZone: dolore fugiat velit requestBody: content: application/json: schema: type: object properties: id: type: string examples: example-1: value: id: sit enim sed in operationId: find-user parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/salesloft/users/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: number guid: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time firstName: type: - string - 'null' name: type: - string - 'null' lastName: type: - string - 'null' jobRole: type: - string - 'null' active: type: boolean timeZone: type: - string - 'null' slackUsername: type: - string - 'null' twitterHandle: type: - string - 'null' email: type: - string - 'null' emailClientEmailAddress: type: - string - 'null' sendingEmailAddress: type: - string - 'null' fromAddress: type: - string - 'null' fullEmailAddress: type: - string - 'null' bccEmailAddress: type: - string - 'null' workCountry: type: - string - 'null' emailSignature: type: - string - 'null' emailSignatureType: type: - string - 'null' emailSignatureClickTrackingDisabled: type: - boolean - 'null' teamAdmin: type: - boolean - 'null' localDialEnabled: type: - boolean - 'null' clickToCallEnabled: type: - boolean - 'null' emailClientConfigured: type: - boolean - 'null' crmConnected: type: - boolean - 'null' required: - id - guid - created_at - updated_at - active metadata: type: object properties: paging: type: object properties: perPage: type: number currentPage: type: number nextPage: type: - number - 'null' prevPage: type: - number - 'null' required: - per_page - current_page required: - paging examples: example-1: value: data: - id: -53321045.920108065 guid: Ut adipisicing in voluptate mollit active: true email: ad velit name: null createdAt: '1991-10-09T02:24:37.0Z' emailClientEmailAddress: null updatedAt: '2002-01-22T18:24:47.0Z' teamAdmin: true twitterHandle: amet in timeZone: voluptate ullamco fugiat sint sendingEmailAddress: null clickToCallEnabled: true emailClientConfigured: false fullEmailAddress: null emailSignatureType: nisi esse amet aliqua emailSignature: labore occaecat sed dolore aliqua jobRole: tempor eu pariatur consectetur slackUsername: null localDialEnabled: null workCountry: ex magna fromAddress: null firstName: null bccEmailAddress: null lastName: in in aute cillum Lorem crmConnected: null emailSignatureClickTrackingDisabled: null metadata: paging: nextPage: -98302654.8809748 currentPage: -55761408.21831794 perPage: -13145009.649252474 prevPage: null requestBody: content: application/json: schema: type: object properties: perPage: type: number page: type: number examples: example-1: value: perPage: 27213817.92262952 page: 44822802.619262755 operationId: list-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/slack/messages/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: ts: type: string examples: example-1: value: ts: sit ullamco consectetur requestBody: content: application/json: schema: type: object properties: text: type: string channel: type: string examples: example-1: value: text: ipsum in channel: minim operationId: create-message parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/slack/messages/update: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: ts: type: string examples: example-1: value: ts: exercitation eiusmod requestBody: content: application/json: schema: type: object properties: ts: type: string text: type: string channel: type: string examples: example-1: value: ts: deserunt pariatur eiusmod esse text: reprehenderit enim channel: minim ex sunt aliquip operationId: update-message parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/slack/users/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: members: type: array items: type: object properties: id: type: string name: type: string deleted: type: boolean required: - id - name - deleted responseMetadata: type: object properties: nextCursor: type: string required: - next_cursor examples: example-1: value: members: - id: sint laborum name: sint consectetur aliquip laboris commodo deleted: false responseMetadata: nextCursor: mollit commodo dolore requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: do operationId: list-users parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/slack/conversations/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: channels: type: array items: type: object properties: id: type: string name: type: string created: type: number required: - id - name - created responseMetadata: type: object properties: nextCursor: type: string required: - next_cursor examples: example-1: value: channels: - id: nisi name: reprehenderit labore created: -11244916.177287444 responseMetadata: nextCursor: ea commodo nisi proident sunt requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: et operationId: list-conversations parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/teams/messages/create: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string createdDateTime: type: string format: date-time body: type: object properties: content: type: string required: - content channelIdentity: type: object properties: teamId: type: string channelId: type: string required: - teamId - channelId examples: example-1: value: id: elit incididunt createdDateTime: '1956-05-16T12:13:57.0Z' body: content: exercitation est laborum irure quis channelIdentity: teamId: enim channelId: dolor sint ea tempor requestBody: content: application/json: schema: type: object properties: text: type: string channelId: type: string teamId: type: string examples: example-1: value: text: sunt enim consequat ea dolore channelId: fugiat cupidatat teamId: enim commodo eiusmod laborum in operationId: create-message parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/teams/channels/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: value: type: array items: type: object properties: id: type: string displayName: type: string createdDateTime: type: string format: date-time required: - id - displayName - createdDateTime '@odataNextLink': type: string examples: example-1: value: value: - id: aliquip displayName: in Duis velit pariatur irure createdDateTime: '2012-06-04T02:06:01.0Z' idea_: false '@odataNextLink': laboris Excepteur dolor cillum requestBody: content: application/json: schema: type: object properties: teamId: type: string cursor: type: string examples: example-1: value: teamId: sint dolor consequat ex cursor: mollit non cillum operationId: list-channels parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/teams/members/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: value: type: array items: type: object properties: id: type: string displayName: type: string required: - id - displayName '@odataNextLink': type: string examples: example-1: value: value: - id: sit in voluptate velit displayName: magna laboris sint Lorem elit '@odataNextLink': ea reprehenderit laboris Lorem dolore requestBody: content: application/json: schema: type: object properties: teamId: type: string cursor: type: string examples: example-1: value: teamId: incididunt Lorem ad ex Ut cursor: aute Duis dolore anim operationId: list-members parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev /api/actions/teams/teams/list: parameters: [] post: responses: '200': description: OK content: application/json: schema: type: object properties: value: type: array items: type: object properties: id: type: string displayName: type: string required: - id - displayName '@odataNextLink': type: string examples: example-1: value: value: - id: in sunt displayName: sunt amet dolore '@odataNextLink': Excepteur non laboris requestBody: content: application/json: schema: type: object properties: cursor: type: string examples: example-1: value: cursor: ea commodo irure in operationId: list-teams parameters: - name: x-vessel-access-token in: header description: Access Token required: true schema: type: string tags: - Actions servers: - url: https://api.vessel.dev x-refined-from: - vessel-activecampaign-actions-openapi.yml - vessel-aircall-actions-openapi.yml - vessel-apollo-actions-openapi.yml - vessel-dialpad-actions-openapi.yml - vessel-mailchimp-actions-openapi.yml - vessel-monday-actions-openapi.yml - vessel-outreach-actions-openapi.yml - vessel-ringcentral-actions-openapi.yml - vessel-salesforce-actions-openapi.yml - vessel-salesloft-actions-openapi.yml - vessel-slack-actions-openapi.yml - vessel-teams-actions-openapi.yml