openapi: 3.2.0
info:
  title: Vessel Unifications API
  version: '1.0'
  description: 'Operations tagged Unifications across 5 of this provider''s published API definitions: vessel-chat-openapi.yml, vessel-crm-openapi.yml, vessel-dialer-openapi.yml, vessel-engagement-openapi.yml, vessel-marketing-automation-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.vessel.dev
security:
- VesselAPIToken: []
tags:
- name: Unifications
paths:
  /api/unifications/chat/users/list:
    parameters: []
    post:
      summary: List Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    users:
                    - id: e5f32d4fd2115220bd20a2ccf81210ec
                      name: Tom Haverford
                      isDeleted: false
                      createdTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: '123123'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      operationId: get-all-users
      description: List Users
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/chat/channels/list:
    parameters: []
    post:
      summary: List Channels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  channels:
                    type: array
                    items:
                      $ref: '#/components/schemas/Channel'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    channels:
                    - id: e5f32d4fd2115220bd20a2ccf81210ec
                      name: Paper updates
                      createdTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: '123123'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      operationId: get-all-channels
      description: List Channel
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/chat/messages/create:
    parameters: []
    post:
      summary: Create Message
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: e5f32d4fd2115220bd20a2ccf81210ec
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: object
                  properties:
                    text:
                      type: string
                    channelId:
                      type: string
                    $native:
                      ref: '#/components/schemas/NativeData'
            examples:
              example-1:
                value:
                  message:
                    text: New paper order
                    channelId: 34f5b4b0b6b650c981a174b02753c390
                    $native: {}
      operationId: post-message
      description: Create Message
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/chat/messages/update:
    parameters: []
    post:
      summary: Update Message
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: e5f32d4fd2115220bd20a2ccf81210ec
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                message:
                  type: object
                  properties:
                    text:
                      type: string
                    channelId:
                      type: string
                    $native:
                      ref: '#/components/schemas/NativeData'
            examples:
              example-1:
                value:
                  id: e5f32d4fd2115220bd20a2ccf81210ec
                  message:
                    text: New paper order
                    channelId: 34f5b4b0b6b650c981a174b02753c390
                    $native: {}
      operationId: put-message
      description: Update Message
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/info/find:
    parameters: []
    post:
      summary: Get Connection Info
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  url:
                    type: string
                  orgId:
                    type: string
                  userId:
                    type: string
                  currency:
                    type: string
                    description: The default currency for the organization in ISO format
              examples:
                example-1:
                  value:
                    url: https://xyz.my.salesforce.com
                    orgId: org_1234
                    userId: user_1234
                    currency: USD
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      operationId: get-info
      description: Get Connection Info
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/users/list:
    parameters: []
    post:
      summary: List Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User_2'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    users:
                    - id: '12'
                      firstName: Micheal
                      lastName: Scott
                      email: micheal@dundermifflin.com
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: string
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    firstName:
                      $ref: '#/components/schemas/StringFilter'
                    lastName:
                      $ref: '#/components/schemas/StringFilter'
                    email:
                      $ref: '#/components/schemas/StringFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $native: false
                  cursor: '123123'
      operationId: list-users
      description: List Users
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/users/batch-read:
    parameters: []
    post:
      summary: Batch Read Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User_2'
              examples:
                example-1:
                  value:
                    users:
                    - id: '12'
                      firstName: Micheal
                      lastName: Scott
                      email: micheal@dundermifflin.com
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
            examples:
              example-1:
                value:
                  include:
                    $native: false
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
      operationId: batch-read-users
      description: "Batch Read Users\n*CRM Caveats*:\n  Not supported for HubSpot."
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/users/find:
    parameters: []
    post:
      summary: Get User
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User_2'
              examples:
                example-1:
                  value:
                    user:
                      id: '12'
                      firstName: Micheal
                      lastName: Scott
                      email: micheal@dundermifflin.com
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
      operationId: get-user
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a single User by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/users/details:
    post:
      summary: Get User Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: firstName
                      name: First name
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-user
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all users.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/contacts/list:
    parameters: []
    post:
      summary: List Contacts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contacts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    contacts:
                    - id: '23'
                      email: tom@bluecross.com
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      phone: '2101128833'
                      mobilePhone: '2106541111'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: .56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-contacts
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    email:
                      type: object
                      properties:
                        equals:
                          type: string
                        in:
                          type: array
                          items:
                            type: string
                    firstName:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    lastName:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    jobTitle:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    phone:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    mobilePhone:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                      description: Requires enabling Synced-cache
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                      description: Requires enabling Synced-cache
                  description: If you are using filters for HubSpot, associations cannot be provided unless sync-cache is enabled.
                  required: email
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: accounts, deals, leads.

                    ownerUserId is always included in the response in the response.

                    '
            examples:
              example-1:
                value:
                  cursor: '123123'
                  filters:
                    email:
                      equals: michael@dunder.mifflin
                  include:
                    $native: false
                  associations:
                  - accounts
                  - deals
      description: Retrieve all Contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/contacts/batch-read:
    parameters: []
    post:
      summary: Batch Read Contacts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contacts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
              examples:
                example-1:
                  value:
                    contacts:
                    - id: '23'
                      email: tom@bluecross.com
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      phone: '2101128833'
                      mobilePhone: '2106541111'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: .56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-contacts
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - accounts
                  - deals
      description: Fetch Contacts by Ids
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/contacts/find:
    post:
      summary: Get Contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contact:
                    $ref: '#/components/schemas/Contact'
              examples:
                example-1:
                  value:
                    contact:
                      id: '23'
                      email: tom@bluecross.com
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      phone: '2101128833'
                      mobilePhone: '2106541111'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-contact
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: accounts, deals, leads.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - accounts
                  - deals
      description: Retrieve a Contact by either Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/contacts/create:
    post:
      summary: Create Contact
      operationId: create-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contact:
                  $ref: '#/components/schemas/ContactCreate'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
              required:
              - contact
            examples:
              example-1:
                value:
                  contact:
                    email: tom@bluecross.com
                    firstName: Tom
                    lastName: Smith
                    jobTitle: Director of Operations
                    phone: '2101128833'
                    mobilePhone: '2106541111'
                    $native: {}
      description: Create a new contact.
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/contacts/update:
    post:
      summary: Update Contact
      operationId: update-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                contact:
                  $ref: '#/components/schemas/ContactUpdate'
              required:
              - id
              - contact
            examples:
              example-1:
                value:
                  id: string
                  contact:
                    email: tom@bluecross.com
                    firstName: Tom
                    lastName: Smith
                    jobTitle: Director of Operations
                    phone: '2101128833'
                    mobilePhone: '2106541111'
                    $native: {}
          application/xml:
            schema:
              type: object
              properties: {}
        description: ''
      description: Update an existing Contact.
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/contacts/details:
    post:
      summary: Get Contact Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: firstName
                      name: First name
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-contact
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all contacts.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/deals/list:
    parameters: []
    post:
      summary: List Deals
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  deals:
                    type: array
                    items:
                      $ref: '#/components/schemas/Deal'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    deals:
                    - id: '84'
                      name: Blue Cross Deal
                      stage: demo
                      amount: 10000
                      closeDate: '2020-08-23T00:00:00Z'
                      probability: '0.4'
                      expectedRevenue: 4000
                      isWon: false
                      isClosed: false
                      currency: USD
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-deals
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    closeDate:
                      $ref: '#/components/schemas/DateFilter'
                    name:
                      $ref: '#/components/schemas/StringFilter'
                    amount:
                      $ref: '#/components/schemas/NumberFilter'
                    probability:
                      $ref: '#/components/schemas/NumberFilter'
                    stage:
                      $ref: '#/components/schemas/StringFilter'
                    isWon:
                      $ref: '#/components/schemas/BooleanFilter'
                    isClosed:
                      $ref: '#/components/schemas/BooleanFilter'
                    expectedRevenue:
                      $ref: '#/components/schemas/NumberFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: accounts, contacts.

                    ownerUserId is always included in the response.

                    '
      description: Retrieve all Deals
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/deals/batch-read:
    parameters: []
    post:
      summary: Batch Read Deals
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  deals:
                    type: array
                    items:
                      $ref: '#/components/schemas/Deal'
              examples:
                example-1:
                  value:
                    deals:
                    - id: '84'
                      name: Blue Cross Deal
                      stage: demo
                      amount: 10000
                      closeDate: '2020-08-23T00:00:00Z'
                      probability: '0.4'
                      expectedRevenue: 4000
                      isWon: false
                      isClosed: false
                      currency: USD
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-deals
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: accounts, contacts.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - accounts
                  - contacts
      description: Fetch Deals by Ids
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/deals/find:
    parameters: []
    post:
      summary: Get Deal
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  deal:
                    $ref: '#/components/schemas/Deal'
              examples:
                example-1:
                  value:
                    deal:
                      id: '84'
                      name: Blue Cross Deal
                      stage: demo
                      amount: 10000
                      closeDate: '2020-08-23T00:00:00Z'
                      probability: '0.4'
                      expectedRevenue: 4000
                      isWon: false
                      isClosed: false
                      currency: USD
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-deal
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: accounts, contacts.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - accounts
                  - contacts
      description: Retrieve a single Deal by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/deals/create:
    post:
      summary: Create Deal
      operationId: create-deal
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                deal:
                  $ref: '#/components/schemas/DealCreate'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
              required:
              - deal
            examples:
              example-1:
                value:
                  deal:
                    name: Blue Cross Deal
                    amount: 10000
                    closeDate: '2020-08-23T00:00:00Z'
                    probability: '0.4'
                    stage: closedwon
                    $native: {}
                    associations:
                      accountId: 0dcb45e051315a6ea63b0f16e73689d9
      description: Create a new Deal
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/deals/update:
    post:
      summary: Update Deal
      operationId: update-deal
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                deal:
                  $ref: '#/components/schemas/DealUpdate'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
              required:
              - id
              - deal
            examples:
              example-1:
                value:
                  id: string
                  deal:
                    name: Blue Cross Deal
                    amount: 10000
                    closeDate: '2020-08-23T00:00:00Z'
                    probability: '0.4'
                    $native: {}
                    associations:
                      accountId: 0dcb45e051315a6ea63b0f16e73689d9
        description: ''
      description: Update an existing Deal
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/deals/details:
    post:
      summary: Get Deal Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: stage
                      name: Stage
                      type: enum
                      options:
                      - OPEN
                      - CLOSED_WON
                      - CLOSED_LOST
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: false
                      updatable: false
                    nextPageCursor: string
      operationId: get-details-crm-deal
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all deals.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/accounts/list:
    parameters: []
    post:
      summary: List Accounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  accounts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Account'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    accounts:
                    - id: '344'
                      name: Blue Cross
                      description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
                      industry: TV and Media
                      annualRevenue: 10000000
                      numberOfEmployees: 100
                      website: www.bluecross.penn
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      phone: '8192223333'
                      address:
                        street: 100 Blue Dr
                        city: Scranton
                        state: Pennsylvania
                        postalCode: '281332'
                        country: USA
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-accounts
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    name:
                      $ref: '#/components/schemas/StringFilter'
                    description:
                      $ref: '#/components/schemas/StringFilter'
                    industry:
                      $ref: '#/components/schemas/StringFilter'
                    website:
                      $ref: '#/components/schemas/StringFilter'
                    street:
                      $ref: '#/components/schemas/StringFilter'
                    city:
                      $ref: '#/components/schemas/StringFilter'
                    state:
                      $ref: '#/components/schemas/StringFilter'
                    postalCode:
                      $ref: '#/components/schemas/StringFilter'
                    country:
                      $ref: '#/components/schemas/StringFilter'
                    phone:
                      $ref: '#/components/schemas/StringFilter'
                    annualRevenue:
                      $ref: '#/components/schemas/NumberFilter'
                    numberOfEmployees:
                      $ref: '#/components/schemas/NumberFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, leads.

                    ownerUserId is always included in the response.

                    '
      description: Retrieve all Accounts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/accounts/batch-read:
    parameters: []
    post:
      summary: Batch Read Accounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  accounts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Account'
              examples:
                example-1:
                  value:
                    accounts:
                    - id: '344'
                      name: Blue Cross
                      description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
                      industry: TV and Media
                      annualRevenue: 10000000
                      numberOfEmployees: 100
                      website: www.bluecross.penn
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      phone: '8192223333'
                      address:
                        street: 100 Blue Dr
                        city: Scranton
                        state: Pennsylvania
                        postalCode: '281332'
                        country: USA
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-accounts
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, leads.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      description: Fetch Accounts by Ids
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/accounts/find:
    parameters: []
    post:
      summary: Get Account
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  account:
                    $ref: '#/components/schemas/Account'
              examples:
                example-1:
                  value:
                    account:
                      id: '344'
                      name: Blue Cross
                      description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
                      industry: TV and Media
                      annualRevenue: 10000000
                      numberOfEmployees: 100
                      website: www.bluecross.penn
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      phone: '8192223333'
                      address:
                        street: 100 Blue Dr
                        city: Scranton
                        state: Pennsylvania
                        postalCode: '281332'
                        country: USA
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-account
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, leads.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      description: Retrieve a single Account by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/accounts/create:
    post:
      summary: Create Account
      operationId: create-account
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                account:
                  $ref: '#/components/schemas/AccountCreate'
              required:
              - account
            examples:
              example-1:
                value:
                  account:
                    name: Blue Cross
                    description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
                    industry: TV and Media
                    annualRevenue: 10000000
                    numberOfEmployees: 100
                    website: www.bluecross.penn
                    phone: '8192223333'
                    address:
                      street: 100 Blue Dr
                      city: Scranton
                      state: Pennsylvania
                      postalCode: '281332'
                      country: USA
                    $native: {}
      description: Create a new Account
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/accounts/details:
    post:
      summary: Get Account Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: name
                      name: Name
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-account
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all accounts.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/leads/list:
    post:
      summary: List Leads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  leads:
                    type: array
                    items:
                      $ref: '#/components/schemas/Lead'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    leads:
                    - id: '23'
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      email: tom@bluecross.com
                      accountName: Blue Cross
                      phone: '1234445555'
                      mobilePhone: '2338889999'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-leads
      description: 'Retrieve all leads.

        *CRM Caveats*:

        - Pipedrive: Only `jobTitle` is returned when querying for all leads'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    email:
                      type: object
                      properties:
                        equals:
                          type: string
                        in:
                          type: array
                          items:
                            type: string
                    lastName:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    firstName:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    jobTitle:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    account:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    phone:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    mobilePhone:
                      $ref: '#/components/schemas/StringFilter'
                      description: Requires enabling Synced-cache
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                      description: Requires enabling Synced-cache
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                      description: Requires enabling Synced-cache
                  description: If you are using filters for HubSpot, associations cannot be provided unless you enable Synced-cache
                  required: email
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: contacts, accounts.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
                  filters:
                    email:
                      equals: michael@dunder.mifflin
                  associations:
                  - contacts
                  - accounts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/leads/batch-read:
    post:
      summary: Batch Read Leads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  leads:
                    type: array
                    items:
                      $ref: '#/components/schemas/Lead'
              examples:
                example-1:
                  value:
                    leads:
                    - id: '23'
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      email: tom@bluecross.com
                      accountName: Blue Cross
                      phone: '1234445555'
                      mobilePhone: '2338889999'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-leads
      description: 'Fetch Leads by Ids

        *CRM Caveats*:

        - Pipedrive: Only `jobTitle` is returned when querying for all leads'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: contacts, accounts.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - contacts
                  - accounts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/leads/find:
    post:
      summary: Get Lead
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  lead:
                    $ref: '#/components/schemas/Lead'
              examples:
                example-1:
                  value:
                    lead:
                      id: '23'
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      email: tom@bluecross.com
                      accountName: Blue Cross
                      phone: '1234445555'
                      mobilePhone: '2338889999'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-lead
      description: Retrieve a single Lead by Id
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: contacts, accounts.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - contacts
                  - accounts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/leads/create:
    post:
      summary: Create Lead
      operationId: create-lead
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: string
      description: Create a new Lead
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                lead:
                  $ref: '#/components/schemas/LeadCreate'
              required:
              - lead
            examples:
              example-1:
                value:
                  lead:
                    firstName: Tom
                    lastName: Smith
                    jobTitle: Director of Operations
                    email: tom@bluecross.com
                    accountName: Blue Cross
                    phone: '1234445555'
                    mobilePhone: '2338889999'
                    $native: {}
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/leads/update:
    post:
      summary: Update Lead
      operationId: update-lead
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      description: Update an existing Lead by Id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                lead:
                  $ref: '#/components/schemas/LeadUpdate'
              required:
              - id
              - lead
            examples:
              example-1:
                value:
                  id: '1231232'
                  lead:
                    firstName: Tom
                    lastName: Smith
                    jobTitle: Director of Operations
                    email: tom@bluecross.com
                    accountName: Blue Cross
                    phone: '1234445555'
                    mobilePhone: '2338889999'
                    $native: {}
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/custom-fields/create:
    post:
      summary: Create Custom Field
      description: Supported for HubSpot
      operationId: create-lead-custom-field
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    key: hs_custom_field_123
                properties:
                  key:
                    type: string
                    description: The key used to access the custom field
              examples:
                example-1:
                  value:
                    key: hs_custom_field_123
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                objectType:
                  type: string
                  description: 'Allowed values: contacts, leads

                    '
                customField:
                  $ref: '#/components/schemas/CustomFieldCreate'
              required:
              - objectType
              - customField
            examples:
              example-1:
                value:
                  objectType: leads
                  customField:
                    name: new field
                    type: singleselect
                    $native: {}
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/leads/details:
    post:
      summary: Get Lead Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: firstName
                      name: First name
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-lead
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all leads.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/notes/list:
    post:
      summary: List Notes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  notes:
                    type: array
                    items:
                      $ref: '#/components/schemas/Note'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    notes:
                    - id: '34'
                      contentText: This note has some interesting content in it!
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-notes
      description: Retrieve all Notes
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    content:
                      $ref: '#/components/schemas/StringFilter'
                    contentText:
                      $ref: '#/components/schemas/StringFilter'
                    contentHtml:
                      $ref: '#/components/schemas/StringFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/notes/batch-read:
    post:
      summary: Batch Read Notes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  notes:
                    type: array
                    items:
                      $ref: '#/components/schemas/Note'
              examples:
                example-1:
                  value:
                    notes:
                    - id: '34'
                      contentText: This note has some interesting content in it!
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-notes
      description: Fetch Notes by Ids
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/notes/find:
    post:
      summary: Get Note
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  note:
                    $ref: '#/components/schemas/Note'
              examples:
                example-1:
                  value:
                    note:
                      id: '34'
                      contentText: This note has some interesting content in it!
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-note
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      description: Retrieve a single Note by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/notes/create:
    post:
      summary: Create Note
      operationId: create-note
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                note:
                  $ref: '#/components/schemas/NoteCreate'
              required:
              - note
            examples:
              example-1:
                value:
                  note:
                    contentText: This note has some interesting content in it!
                    $native: {}
                    associations:
                      ownerUserId: 79d154aa0c7a571295a157369d448e65
                      dealId: 497fb529e6805351b5dc8057c74a4a52
                      leadId: d08f345ace24509e911a0ea8e3d2203c
                      accountId: 0dcb45e051315a6ea63b0f16e73689d9
                      contactId: e5f32d4fd2115220bd20a2ccf81210ec
        description: ''
      description: 'Create a new Note.

        *CRM Caveats*:

        - Salesforce: You may only associate a Note with one entity.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/notes/update:
    post:
      summary: Update Note
      operationId: update-note
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                note:
                  $ref: '#/components/schemas/NoteUpdate'
              required:
              - id
              - note
            examples:
              example-1:
                value:
                  id: string
                  note:
                    contentText: This note has some interesting content in it!
                    $native: {}
                    associations:
                      ownerUserId: 79d154aa0c7a571295a157369d448e65
      description: Update an existing Note by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/notes/details:
    post:
      summary: Get Note Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: contentText
                      name: Content Text
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-note
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all notes.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/tasks/list:
    parameters: []
    post:
      summary: List Tasks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  tasks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Task'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    tasks:
                    - id: '122'
                      body: This task needs to be done very soon!
                      subject: High Priority Task
                      isDone: false
                      dueDate: '2019-09-24T14:15:22Z'
                      status: Not Done
                      priority: High
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-tasks
      description: Retrieve all Tasks
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    body:
                      $ref: '#/components/schemas/StringFilter'
                    subject:
                      $ref: '#/components/schemas/StringFilter'
                    dueDate:
                      $ref: '#/components/schemas/DateFilter'
                    priority:
                      $ref: '#/components/schemas/StringFilter'
                    status:
                      $ref: '#/components/schemas/StringFilter'
                    isDone:
                      $ref: '#/components/schemas/BooleanFilter'
                    ownerUserId:
                      $ref: '#/components/schemas/StringFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/tasks/batch-read:
    parameters: []
    post:
      summary: Batch Read Tasks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  tasks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Task'
              examples:
                example-1:
                  value:
                    tasks:
                    - id: '122'
                      body: This task needs to be done very soon!
                      subject: High Priority Task
                      isDone: false
                      dueDate: '2019-09-24T14:15:22Z'
                      status: Not Done
                      priority: High
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-tasks
      description: Fetch Tasks by Ids
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/tasks/find:
    post:
      summary: Get Task
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  task:
                    $ref: '#/components/schemas/Task'
              examples:
                example-1:
                  value:
                    task:
                      id: '122'
                      body: This task needs to be done very soon!
                      subject: High Priority Task
                      isDone: false
                      dueDate: '2019-09-24T14:15:22Z'
                      status: Not Done
                      priority: High
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-task
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      description: Retrieve a single Task by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/tasks/create:
    post:
      summary: Create Task
      operationId: create-task
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                task:
                  $ref: '#/components/schemas/TaskCreate'
              required:
              - task
            examples:
              example-1:
                value:
                  task:
                    body: This task needs to be done very soon!
                    subject: High Priority Task
                    dueDate: '2019-09-24T14:15:22Z'
                    priority: High
                    status: Not Done
                    isDone: false
                    $native: {}
                    associations:
                      ownerUserId: 79d154aa0c7a571295a157369d448e65
                      leadId: d08f345ace24509e911a0ea8e3d2203c
                      dealId: 497fb529e6805351b5dc8057c74a4a52
                      accountId: 0dcb45e051315a6ea63b0f16e73689d9
                      contactId: e5f32d4fd2115220bd20a2ccf81210ec
        description: ''
      description: 'Create a new Task.

        *CRM Caveats*:

        - Salesforce: You may only associate a Task with either a Lead or a Contact *and* either a Deal or an Account.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/tasks/update:
    parameters: []
    post:
      summary: Update Task
      operationId: update-task
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                task:
                  $ref: '#/components/schemas/TaskUpdate'
              required:
              - id
              - task
            examples:
              example-1:
                value:
                  id: string
                  task:
                    body: This task needs to be done very soon!
                    subject: High Priority Task
                    dueDate: '2019-09-24T14:15:22Z'
                    isDone: false
                    priority: High
                    status: Not Done
                    $native: {}
                    associations:
                      ownerUserId: 79d154aa0c7a571295a157369d448e65
      description: Update an existing Task by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/tasks/details:
    post:
      summary: Get Task Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: subject
                      name: Subject
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-task
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all tasks.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/events/list:
    post:
      summary: List Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  events:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    events:
                    - id: '19'
                      subject: Meeting with Blue Cross
                      description: Going to get tea with Tom from Blue Cross to discuss his paper needs
                      type: Meeting
                      location: 1122 Tea Dr
                      startDateTime: '2019-08-24T14:15:22Z'
                      endDateTime: '2019-08-24T14:15:22Z'
                      isAllDayEvent: true
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        eventAttendeeIds:
                        - f63c1bd7215f5150b332d31d9509752f
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-events
      description: Retrieve all Events
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    subject:
                      $ref: '#/components/schemas/StringFilter'
                    description:
                      $ref: '#/components/schemas/StringFilter'
                    type:
                      $ref: '#/components/schemas/StringFilter'
                    location:
                      $ref: '#/components/schemas/StringFilter'
                    endDateTime:
                      $ref: '#/components/schemas/DateFilter'
                    startDateTime:
                      $ref: '#/components/schemas/DateFilter'
                    isAllDayEvent:
                      $ref: '#/components/schemas/BooleanFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads, eventAttendees.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/events/batch-read:
    post:
      summary: Batch Read Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  events:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
              examples:
                example-1:
                  value:
                    events:
                    - id: '19'
                      subject: Meeting with Blue Cross
                      description: Going to get tea with Tom from Blue Cross to discuss his paper needs
                      type: Meeting
                      location: 1122 Tea Dr
                      startDateTime: '2019-08-24T14:15:22Z'
                      endDateTime: '2019-08-24T14:15:22Z'
                      isAllDayEvent: true
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        eventAttendeeIds:
                        - f63c1bd7215f5150b332d31d9509752f
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-events
      description: Fetch Events by Ids
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads, eventAttendees.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/events/find:
    post:
      summary: Get Event
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  event:
                    $ref: '#/components/schemas/Event'
              examples:
                example-1:
                  value:
                    event:
                      id: '19'
                      subject: Meeting with Blue Cross
                      description: Going to get tea with Tom from Blue Cross to discuss his paper needs
                      type: Meeting
                      location: 1122 Tea Dr
                      startDateTime: '2019-08-24T14:15:22Z'
                      endDateTime: '2019-08-24T14:15:22Z'
                      isAllDayEvent: true
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        eventAttendeeIds:
                        - f63c1bd7215f5150b332d31d9509752f
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-event
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads, eventAttendees.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      description: Retrieve a single Event by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/events/create:
    post:
      summary: Create Event
      operationId: create-event
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                event:
                  $ref: '#/components/schemas/EventCreate'
              required:
              - event
            examples:
              example-1:
                value:
                  event:
                    subject: Meeting with Blue Cross
                    description: Going to get tea with Tom from Blue Cross to discuss his paper needs
                    type: Meeting
                    location: 1122 Tea Dr
                    startDateTime: '2019-08-24T14:15:22Z'
                    endDateTime: '2019-08-24T14:15:22Z'
                    isAllDayEvent: true
                    $native: {}
                    associations:
                      dealId: 497fb529e6805351b5dc8057c74a4a52
                      accountId: 0dcb45e051315a6ea63b0f16e73689d9
                      contactId: e5f32d4fd2115220bd20a2ccf81210ec
                      leadId: d08f345ace24509e911a0ea8e3d2203c
                      ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
        description: ''
      description: Create a new Event.
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/events/update:
    parameters: []
    post:
      summary: Update Event
      operationId: update-event
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                event:
                  $ref: '#/components/schemas/EventUpdate'
              required:
              - id
              - event
            examples:
              example-1:
                value:
                  id: string
                  event:
                    subject: Meeting with Blue Cross
                    description: Going to get tea with Tom from Blue Cross to discuss his paper needs
                    type: Meeting
                    location: 1122 Tea Dr
                    startDateTime: '2019-08-24T14:15:22Z'
                    endDateTime: '2019-08-24T14:15:22Z'
                    isAllDayEvent: true
                    $native: {}
                    associations:
                      ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      description: Update an existing Event by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/events/details:
    post:
      summary: Get Event Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: subject
                      name: Subject
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-event
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all events.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/attendees/list:
    post:
      summary: List Event Attendees
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  eventAttendees:
                    type: array
                    items:
                      $ref: '#/components/schemas/EventAttendee'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    eventAttendees:
                    - id: '1234'
                      associatedObjectType: contacts
                      status: Confirmed
                      email: null
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        eventId: 0000d2e83d6c5d52a61f2fb860666477
                        associationId: fbdb8b1e827609f50c25b4d52a7b6f57
                    nextPageCursor: string
      operationId: list-event-attendees
      description: Retrieve all Attendees for all Events
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    email:
                      $ref: '#/components/schemas/StringFilter'
                    status:
                      $ref: '#/components/schemas/StringFilter'
                    associatedObjectType:
                      $ref: '#/components/schemas/StringFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/attendees/batch-read:
    post:
      summary: Batch Read Event Attendees
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  eventAttendees:
                    type: array
                    items:
                      $ref: '#/components/schemas/EventAttendee'
              examples:
                example-1:
                  value:
                    eventAttendees:
                    - id: '1234'
                      associatedObjectType: contacts
                      status: Confirmed
                      email: null
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        eventId: 0000d2e83d6c5d52a61f2fb860666477
                        associationId: fbdb8b1e827609f50c25b4d52a7b6f57
      operationId: batch-read-event-attendees
      description: Fetch Attendees by Ids
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/attendees/find:
    parameters: []
    post:
      summary: Get Event Attendee
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  eventAttendee:
                    $ref: '#/components/schemas/EventAttendee'
              examples:
                example-1:
                  value:
                    eventAttendee:
                      id: '34054'
                      associatedObjectType: contacts
                      status: Confirmed
                      email: null
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        eventId: 0000d2e83d6c5d52a61f2fb860666477
                        associationId: fbdb8b1e827609f50c25b4d52a7b6f57
      operationId: get-event-attendee
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a single Event Attendee by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/attendees/create:
    post:
      summary: Create Event Attendee
      operationId: create-event-attendee
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              title: responseBody
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                eventAttendee:
                  $ref: '#/components/schemas/EventAttendeeCreate'
                required:
                - eventAttendee
            examples:
              example-1:
                value:
                  eventAttendee:
                    email: null
                    associatedObjectType: contacts
                    status: Declined
                    $native: {}
                    associations:
                      associationId: 98201f83c3f1c36dbcb36804c572c3ca
                      eventId: 0000d2e83d6c5d52a61f2fb860666477
      description: Add an Attendee to an Event
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/attendees/update:
    post:
      summary: Update Event Attendee
      operationId: update-event-attendee
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                eventAttendee:
                  $ref: '#/components/schemas/EventAttendeeUpdate'
              required:
              - id
              - eventAttendee
            examples:
              example-1:
                value:
                  id: string
                  eventAttendee:
                    status: Declined
                    $native: {}
      description: Update the status of an event attendee
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/attendees/details:
    post:
      summary: Get Attendee Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: status
                      name: Status
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: false
                      updatable: false
                    nextPageCursor: string
      operationId: get-details-crm-attendee
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all attendees.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/emails/list:
    parameters: []
    post:
      summary: List Emails
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  emails:
                    type: array
                    items:
                      $ref: '#/components/schemas/Email'
                  nextPageCursor:
                    type: string
                title: responseBody
              examples:
                example-1:
                  value:
                    emails:
                    - id: '23'
                      from: michael@dunder.mifflin
                      to:
                      - greg@bluecross.com
                      cc:
                      - betty@bluecross.com
                      bcc:
                      - carl@bluecross.com
                      subject: BlueCross <> Dunder Mifflin
                      bodyText: Hi Greg, need any paper? - Michael
                      bodyHtml: <p>Hi Greg, need any paper? - Michael</p>
                      messageDate: '2019-08-24T14:15:22Z'
                      isIncoming: false
                      isBounced: false
                      hasAttachment: false
                      status: SENT
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-emails
      description: Retrieve all Emails
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    from:
                      $ref: '#/components/schemas/StringFilter'
                    to:
                      $ref: '#/components/schemas/StringListFilter'
                    cc:
                      $ref: '#/components/schemas/StringListFilter'
                    bcc:
                      $ref: '#/components/schemas/StringListFilter'
                    subject:
                      $ref: '#/components/schemas/StringFilter'
                    body:
                      $ref: '#/components/schemas/StringFilter'
                    bodyHtml:
                      $ref: '#/components/schemas/StringFilter'
                    messageDate:
                      $ref: '#/components/schemas/DateFilter'
                    isIncoming:
                      $ref: '#/components/schemas/BooleanFilter'
                    isBounced:
                      $ref: '#/components/schemas/BooleanFilter'
                    hasAttachment:
                      $ref: '#/components/schemas/BooleanFilter'
                    status:
                      $ref: '#/components/schemas/StringFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/emails/batch-read:
    parameters: []
    post:
      summary: Batch Read Emails
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  emails:
                    type: array
                    items:
                      $ref: '#/components/schemas/Email'
                title: responseBody
              examples:
                example-1:
                  value:
                    emails:
                    - id: '23'
                      from: michael@dunder.mifflin
                      to:
                      - greg@bluecross.com
                      cc:
                      - betty@bluecross.com
                      bcc:
                      - carl@bluecross.com
                      subject: BlueCross <> Dunder Mifflin
                      bodyText: Hi Greg, need any paper? - Michael
                      bodyHtml: <p>Hi Greg, need any paper? - Michael</p>
                      messageDate: '2019-08-24T14:15:22Z'
                      isIncoming: false
                      isBounced: false
                      hasAttachment: false
                      status: SENT
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-emails
      description: Fetch Emails by Ids
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/emails/find:
    post:
      summary: Get Email
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  email:
                    $ref: '#/components/schemas/Email'
                title: responseBody
              examples:
                example-1:
                  value:
                    email:
                      id: '23'
                      from: michael@dunder.mifflin
                      to:
                      - greg@bluecross.com
                      cc:
                      - betty@bluecross.com
                      bcc:
                      - carl@bluecross.com
                      subject: BlueCross <> Dunder Mifflin
                      bodyText: Hi Greg, need any paper? - Michael
                      bodyHtml: <p>Hi Greg, need any paper? - Michael</p>
                      messageDate: '2019-08-24T14:15:22Z'
                      isIncoming: false
                      isBounced: false
                      hasAttachment: false
                      status: SENT
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-email
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      description: Retrieve a single Task by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/emails/create:
    post:
      summary: Create Email
      operationId: create-email
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                email:
                  $ref: '#/components/schemas/EmailCreate'
              required:
              - email
            examples:
              example-1:
                value:
                  email:
                    from: michael@dunder.mifflin
                    to:
                    - greg@bluecross.com
                    cc:
                    - betty@bluecross.com
                    bcc:
                    - carl@bluecross.com
                    subject: BlueCross <> Dunder Mifflin
                    bodyText: Hi Greg, need any paper? - Michael
                    bodyHtml: <p>Hi Greg, need any paper? - Michael</p>
                    messageDate: '2019-08-24T14:15:22Z'
                    isIncoming: false
                    status: SENT
                    $native: {}
                    associations:
                      accountId: 0dcb45e051315a6ea63b0f16e73689d9
                      dealId: 497fb529e6805351b5dc8057c74a4a52
                      leads:
                      - id: d08f345ace24509e911a0ea8e3d2203c
                        role: to
                      contacts:
                      - id: e5f32d4fd2115220bd20a2ccf81210ec
                        role: cc
                      ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
        description: ''
      description: Create a new Email.
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/emails/update:
    post:
      summary: Update Email
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      operationId: update-email
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                email:
                  $ref: '#/components/schemas/EmailUpdate'
              required:
              - id
              - email
            examples:
              example-1:
                value:
                  id: string
                  email:
                    isIncoming: false
                    status: SENT
                    $native: {}
                    associations:
                      ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      description: 'Update an Email by Id.

        *CRM Caveats*:

        - Pipedrive: Not supported.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/emails/details:
    post:
      summary: Get Email Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: subject
                      name: Subject
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-email
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all emails.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/calls/list:
    post:
      summary: List Calls
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  calls:
                    type: array
                    items:
                      $ref: '#/components/schemas/Call'
                  nextPageCursor:
                    type: string
                title: responseBody
              examples:
                example-1:
                  value:
                    calls:
                    - id: '23'
                      subject: BlueCross <> Dunder Mifflin
                      disposition: ANSWERED
                      direction: inbound
                      description: Call from Greg
                      date: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: list-calls
      description: Retrieve all Calls
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                filters:
                  type: object
                  description: Requires enabling Synced-cache
                  properties:
                    id:
                      $ref: '#/components/schemas/StringFilter'
                    disposition:
                      $ref: '#/components/schemas/StringFilter'
                    direction:
                      $ref: '#/components/schemas/StringFilter'
                    subject:
                      $ref: '#/components/schemas/StringFilter'
                    description:
                      $ref: '#/components/schemas/StringFilter'
                    date:
                      $ref: '#/components/schemas/DateFilter'
                    status:
                      $ref: '#/components/schemas/StringFilter'
                    duration:
                      $ref: '#/components/schemas/NumberFilter'
                    from:
                      $ref: '#/components/schemas/StringFilter'
                    to:
                      $ref: '#/components/schemas/StringFilter'
                    recordingUrl:
                      $ref: '#/components/schemas/StringFilter'
                    createdTime:
                      $ref: '#/components/schemas/DateFilter'
                    modifiedTime:
                      $ref: '#/components/schemas/DateFilter'
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/calls/batch-read:
    post:
      summary: Batch Read Calls
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  calls:
                    type: array
                    items:
                      $ref: '#/components/schemas/Call'
                title: responseBody
              examples:
                example-1:
                  value:
                    calls:
                    - id: '23'
                      subject: BlueCross <> Dunder Mifflin
                      disposition: ANSWERED
                      direction: inbound
                      description: Call from Greg
                      date: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: batch-read-calls
      description: Fetch Calls by Ids
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                ids:
                  type: array
                  items:
                    type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
            examples:
              example-1:
                value:
                  ids:
                  - '123123'
                  - '456456'
                  - '567567'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/calls/find:
    post:
      summary: Get Call
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  call:
                    $ref: '#/components/schemas/Call'
                title: responseBody
              examples:
                example-1:
                  value:
                    call:
                      id: '23'
                      subject: BlueCross <> Dunder Mifflin
                      disposition: ANSWERED
                      direction: inbound
                      description: Call from Greg
                      date: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountIds:
                        - 0dcb45e051315a6ea63b0f16e73689d9
                        contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        leadIds:
                        - d08f345ace24509e911a0ea8e3d2203c
                        dealIds:
                        - 497fb529e6805351b5dc8057c74a4a52
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-call
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                id:
                  type: string
                associations:
                  type: array
                  items:
                    type: string
                  description: 'Array of associations to include in the response.

                    Allowed values: deals, contacts, accounts, leads.

                    ownerUserId is always included in the response.

                    '
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
                  associations:
                  - deals
                  - contacts
      description: Retrieve a single Call by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/calls/create:
    post:
      summary: Create Call
      operationId: create-call
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                call:
                  $ref: '#/components/schemas/CallCreate'
              required:
              - call
            examples:
              example-1:
                value:
                  call:
                    subject: BlueCross <> Dunder Mifflin
                    disposition: ANSWERED
                    direction: inbound
                    description: Call from Greg
                    date: '2019-08-24T14:15:22Z'
                    $native: {}
                    associations:
                      accountId: 0dcb45e051315a6ea63b0f16e73689d9
                      contactIds:
                      - e5f32d4fd2115220bd20a2ccf81210ec
                      ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
        description: ''
      description: Create a new Call.
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/calls/update:
    post:
      summary: Update Call
      operationId: update-call
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                synced:
                  $ref: '#/components/schemas/SyncedCache'
                call:
                  $ref: '#/components/schemas/CallUpdate'
              required:
              - id
              - call
            examples:
              example-1:
                value:
                  id: string
                  call:
                    disposition: ANSWERED
                    $native: {}
                    associations:
                      ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      description: Update an Call by Id.
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/calls/details:
    post:
      summary: Get Call Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: subject
                      name: Subject
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-call
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all calls.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/lists/list:
    post:
      summary: List Lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  lists:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListWithoutAssociations'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    lists:
                    - id: '34'
                      name: California Leads
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: string
      operationId: list-lists
      description: Retrieve all Lists
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                objectType:
                  type: string
                  enum:
                  - contacts
                  - leads
                  description: 'The type of object to return lists for.

                    '
              required:
              - objectType
            examples:
              example-1:
                value:
                  cursor: '123123'
                  objectType: contacts
                  include:
                    $native: false
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/lists/find:
    post:
      summary: Get List
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  list:
                    $ref: '#/components/schemas/ListWithAssociations'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    list:
                    - id: '34'
                      name: California Leads
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                      - contactIds:
                        - e5f32d4fd2115220bd20a2ccf81210ec
                        - 2d20a2ccf81210ecddf32d4fd2115221
                    nextPageCursor: string
      operationId: get-list
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
                objectType:
                  type: string
                  enum:
                  - contacts
                  - leads
                  description: 'Used to retrieve the correct list.

                    '
              required:
              - id
              - objectType
            examples:
              example-1:
                value:
                  id: '123123'
                  objectType: contacts
                  include:
                    $native: false
      description: Retrieve a single List by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/crm/lists/details:
    post:
      summary: Get List Details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/Field'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    fields:
                    - key: name
                      name: Name
                      type: string
                      options: null
                      isArray: false
                      custom: false
                      universal: true
                      required: false
                      creatable: true
                      updatable: true
                    nextPageCursor: string
      operationId: get-details-crm-list
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  include:
                    $include: false
                  cursor: '123123'
      description: 'Get details about all lists.

        Details include the type, possible values, and other meta data about the fields.'
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/users/list:
    parameters: []
    post:
      summary: List Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User_3'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    users:
                    - id: 56f653659ea9524b9e0fb0ba67e6f8a0
                      firstName: Micheal
                      lastName: Scott
                      email: micheal@dundermifflin.com
                      role: agent
                      isAvailable: true
                      availabilityStatus: available
                      createdTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: string
      operationId: get-all-users
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      description: Retrieve all Users
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/users/find:
    parameters: []
    post:
      summary: Get User
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User_3'
              examples:
                example-1:
                  value:
                    user:
                      id: 56f653659ea9524b9e0fb0ba67e6f8a0
                      firstName: Micheal
                      lastName: Scott
                      email: micheal@dundermifflin.com
                      role: agent
                      isAvailable: true
                      availabilityStatus: available
                      createdTime: '2019-08-24T14:15:22Z'
      operationId: get-one-user
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a single User by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/contacts/list:
    parameters: []
    post:
      summary: List Contacts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contacts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact_2'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    contacts:
                    - id: e5f32d4fd2115220bd20a2ccf81210ec
                      firstName: Tom
                      lastName: Smith
                      companyName: Dunder Mifflin
                      description: Tom Smith is a sales rep at Dunder Mifflin
                      phones:
                      - number: '8192223333'
                        type: work
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: string
      operationId: get-all-contacts
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      description: Retrieve all Contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/contacts/find:
    parameters: []
    post:
      summary: Get Contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contact:
                    $ref: '#/components/schemas/Contact_2'
              examples:
                example-1:
                  value:
                    contact:
                      id: e5f32d4fd2115220bd20a2ccf81210ec
                      firstName: Tom
                      lastName: Smith
                      companyName: Dunder Mifflin
                      description: Tom Smith is a sales rep at Dunder Mifflin
                      phones:
                      - number: '8192223333'
                        type: work
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
      operationId: get-one-contact
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a single Contact by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/contacts/create:
    post:
      summary: Create Contact
      operationId: post-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contact:
                  $ref: '#/components/schemas/ContactCreate_2'
              required:
              - contact
            examples:
              example-1:
                value:
                  contact:
                    firstName: Tom
                    lastName: Smith
                    companyName: Dunder Mifflin
                    description: Tom Smith is a sales rep at Dunder Mifflin
                    phones:
                    - number: '8192223333'
                      type: work
                    createdTime: '2019-08-24T14:15:22Z'
                    modifiedTime: '2019-08-24T14:15:22Z'
                    $native: {}
      description: Create a Contact
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/contacts/update:
    parameters: []
    post:
      summary: Update Contact
      operationId: put-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                contact:
                  $ref: '#/components/schemas/ContactCreate_2'
              required:
              - id
              - contact
            examples:
              example-1:
                value:
                  id: string
                  contact:
                    firstName: Tom
                    lastName: Smith
                    companyName: Dunder Mifflin
                    description: Tom Smith is a sales rep at Dunder Mifflin
                    phones:
                    - number: '8192223333'
                      type: work
                    createdTime: '2019-08-24T14:15:22Z'
                    modifiedTime: '2019-08-24T14:15:22Z'
                    $native: {}
          application/xml:
            schema:
              type: object
              properties: {}
        description: ''
      description: Update an existing Contact
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/calls/list:
    parameters: []
    post:
      summary: List Calls
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  calls:
                    type: array
                    items:
                      $ref: '#/components/schemas/Call_2'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    calls:
                    - id: e5f32d4fd2115220bd20a2ccf81210ec
                      to:
                      - number: '8192223333'
                      from:
                      - number: '8192223333'
                      startTime: '2019-08-24T14:15:22Z'
                      connectedTime: '2019-08-24T14:15:22Z'
                      endTime: '2019-08-24T14:15:22Z'
                      recordingUrl: www.example.com/recording.mp3
                      voicemailUrl: www.example.com/voicemail.mp3
                      direction: outbound
                      status: completed
                      answered: true
                      inProgress: false
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        users:
                        - id: 34f5b4b0b6b650c981a174b02753c390
                          number: '8192223333'
                        contacts:
                        - id: 56f653659ea9524b9e0fb0ba67e6f8a0
                          number: '8192223334'
                    nextPageCursor: string
      operationId: get-all-calls
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      description: Retrieve all Calls
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/calls/find:
    parameters: []
    post:
      summary: Get Call
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  call:
                    $ref: '#/components/schemas/Call_2'
              examples:
                example-1:
                  value:
                    call:
                      id: e5f32d4fd2115220bd20a2ccf81210ec
                      to:
                      - number: '8192223333'
                      from:
                      - number: '8192223333'
                      startTime: '2019-08-24T14:15:22Z'
                      connectedTime: '2019-08-24T14:15:22Z'
                      endTime: '2019-08-24T14:15:22Z'
                      recordingUrl: www.example.com/recording.mp3
                      voicemailUrl: www.example.com/voicemail.mp3
                      direction: outbound
                      status: completed
                      answered: true
                      inProgress: false
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        users:
                        - id: 34f5b4b0b6b650c981a174b02753c390
                          number: '8192223333'
                        contacts:
                        - id: 56f653659ea9524b9e0fb0ba67e6f8a0
                          number: '8192223334'
      operationId: get-one-call
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a single Call by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/dialer/calls/start:
    parameters: []
    post:
      summary: Start a Call
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  call:
                    $ref: '#/components/schemas/Call_2'
              examples:
                example-1:
                  value:
                    call:
                      id: e5f32d4fd2115220bd20a2ccf81210ec
                      to:
                      - number: '8192223333'
                      from:
                      - number: '8192223333'
                      direction: outbound
                      startTime: '2019-08-24T14:15:22Z'
                      connectedTime: '2019-08-24T14:15:22Z'
                      endTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        users:
                        - id: 34f5b4b0b6b650c981a174b02753c390
                          number: '8192223333'
                        contacts:
                        - id: 56f653659ea9524b9e0fb0ba67e6f8a0
                          number: '8192223334'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      operationId: start-call
      description: Start a Call
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/users/list:
    parameters: []
    post:
      summary: List Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User_4'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    users:
                    - id: 34f5b4b0b6b650c981a174b02753c390
                      firstName: Micheal
                      lastName: Scott
                      email: micheal@dundermifflin.com
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: string
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      operationId: get-all-users
      description: Retrieve all Users
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/users/find:
    parameters: []
    post:
      summary: Get User
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User_4'
              examples:
                example-1:
                  value:
                    user:
                      id: 34f5b4b0b6b650c981a174b02753c390
                      firstName: Micheal
                      lastName: Scott
                      email: micheal@dundermifflin.com
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
      operationId: get-one-user
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a single User by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/accounts/list:
    parameters: []
    post:
      summary: List Accounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  accounts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Account_2'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    accounts:
                    - id: 59f5b4b0b6b650c981a174b02753c390
                      name: Blue Cross
                      description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
                      industry: TV and Media
                      numberOfEmployees: 100
                      website: www.bluecross.penn
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      phone: '8192223333'
                      locality: Scranton
                      address:
                        line1: 100 Blue Dr
                        line2: Suite 100
                        city: Scranton
                        state: Pennsylvania
                        postalCode: '281332'
                        country: USA
                      associations:
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: get-all-accounts
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                filters:
                  type: object
                  properties:
                    name:
                      type: object
                      properties:
                        equals:
                          type: string
                      required: equals
                    domain:
                      type: object
                      properties:
                        equals:
                          type: string
                      required: equals
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
                  filters:
                    name:
                      equals: Acme Co.
      description: Retrieve all Accounts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/accounts/find:
    post:
      summary: Get Account
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  account:
                    $ref: '#/components/schemas/Account_2'
              examples:
                example-1:
                  value:
                    account:
                    - id: 59f5b4b0b6b650c981a174b02753c390
                      name: Blue Cross
                      description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
                      industry: TV and Media
                      numberOfEmployees: 100
                      website: www.bluecross.penn
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      phone: '8192223333'
                      locality: Scranton
                      address:
                        line1: 100 Blue Dr
                        line2: Suite 100
                        city: Scranton
                        state: Pennsylvania
                        postalCode: '281332'
                        country: USA
                      associations:
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-one-account
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a single Account by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/accounts/create:
    post:
      summary: Create Account
      operationId: post-account
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account:
                  $ref: '#/components/schemas/AccountCreate_2'
              required:
              - account
            examples:
              example-1:
                value:
                  account:
                    name: Blue Cross
                    description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
                    industry: TV and Media
                    numberOfEmployees: 100
                    website: www.bluecross.penn
                    phone: '8192223333'
                    $native: {}
                    address:
                      line1: 100 Blue Dr
                      line2: Suite 100
                      city: Scranton
                      state: Pennsylvania
                      postalCode: '281332'
                      country: USA
      description: Create a new Account
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/contacts/list:
    parameters: []
    post:
      summary: List Contacts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contacts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact_3'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    contacts:
                    - id: 34f5b4b0b6b650c981a174b02753c390
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      phones:
                      - number: '8192223333'
                        type: work
                        isPrimary: true
                      emails:
                      - address: tom@dunder.com
                        type: work
                        isPrimary: true
                      address:
                        line1: 100 Blue Dr
                        line2: Suite 100
                        city: Scranton
                        state: Pennsylvania
                        postalCode: '281332'
                        country: USA
                      openCount: 0
                      clickCount: 3
                      replyCount: 1
                      bouncedCount: 1
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountId: 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                      customFields: {}
                    nextPageCursor: string
      operationId: get-all-contacts
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                filters:
                  type: object
                  properties:
                    emails:
                      type: object
                      properties:
                        address:
                          type: object
                          properties:
                            equals:
                              type: string
                          required: equals
                      required: address
                    tagIds:
                      type: object
                      properties:
                        in:
                          type: array
                          items:
                            type: string
                      required: in
                    sequenceIds:
                      type: object
                      properties:
                        in:
                          type: array
                          items:
                            type: string
                      required: in
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
                  filters:
                    emails:
                      address:
                        equals: fake@email.com
                    tagIds:
                      in:
                      - some_tag
                    sequenceIds:
                      in:
                      - '123'
      description: Retrieve all Contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/contacts/find:
    post:
      summary: Get Contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contact:
                    $ref: '#/components/schemas/Contact_3'
              examples:
                example-1:
                  value:
                    contact:
                      id: 34f5b4b0b6b650c981a174b02753c390
                      firstName: Tom
                      lastName: Smith
                      jobTitle: Director of Operations
                      phones:
                      - number: '8192223333'
                        type: work
                        isPrimary: true
                      emails:
                      - address: tom@dunder.com
                        type: work
                        isPrimary: true
                      address:
                        line1: 100 Blue Dr
                        line2: Suite 100
                        city: Scranton
                        state: Pennsylvania
                        postalCode: '281332'
                        country: USA
                      openCount: 0
                      clickCount: 3
                      replyCount: 1
                      bouncedCount: 1
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                      associations:
                        accountId: 0dcb45e051315a6ea63b0f16e73689d9
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                      customFields: {}
      operationId: get-one-contact
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a Contact by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/contacts/create:
    post:
      summary: Create Contact
      operationId: post-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contact:
                  $ref: '#/components/schemas/ContactCreate_3'
              required:
              - contact
            examples:
              example-1:
                value:
                  contact:
                    firstName: Tom
                    lastName: Smith
                    jobTitle: Director of Operations
                    address:
                      line1: 100 Blue Dr
                      line2: Suite 100
                      city: Scranton
                      state: Pennsylvania
                      postalCode: '281332'
                      country: USA
                    customFields: {}
                    $native: {}
      description: Create a Contact
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/contacts/update:
    parameters: []
    post:
      summary: Update Contact
      operationId: put-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                contact:
                  $ref: '#/components/schemas/ContactUpdate_2'
              required:
              - id
              - contact
            examples:
              example-1:
                value:
                  id: string
                  contact:
                    firstName: Tom
                    lastName: Smith
                    jobTitle: Director of Operations
                    address:
                      line1: 100 Blue Dr
                      line2: Suite 100
                      city: Scranton
                      state: Pennsylvania
                      postalCode: '281332'
                      country: USA
                    customFields: {}
                    $native: {}
          application/xml:
            schema:
              type: object
              properties: {}
        description: ''
      description: Update an existing Contact
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/contacts/list-custom-fields:
    post:
      summary: List Custom Fields
      operationId: get-all-customFields
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  customFields:
                    type: array
                    items:
                      $ref: '#/components/schemas/ContactCustomField'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    customFields:
                    - key: customField1
                      name: Custom Field
                      type: string
                    nextPageCursor: d9806400e2daa25de2322707bbc41577
      description: Get all Contact Custom Fields
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/contacts/create-custom-field:
    post:
      summary: Create Custom Field
      operationId: post-customFields
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  name:
                    type: string
              examples:
                example-1:
                  value:
                    key: customField1
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customField:
                  $ref: '#/components/schemas/ContactCustomFieldCreate'
              required:
              - customField
            examples:
              example-1:
                value:
                  customField:
                    name: customField1
                    $native: {}
      description: Create a Contact Custom Field
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/emails/list:
    parameters: []
    post:
      summary: List Emails
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  emails:
                    type: array
                    items:
                      $ref: '#/components/schemas/Email_2'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    emails:
                    - id: 2322707bbc41577d9806400e2daa25de
                      subject: 'Re: Paper renewal'
                      hasReplied: true
                      isBounced: false
                      openCount: 1
                      clickCount: 2
                      replyCount: null
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        sequenceId: d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
                    nextPageCursor: string
      operationId: get-all-emails
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
                filters:
                  type: object
                  properties:
                    sequenceId:
                      type: object
                      properties:
                        equals:
                          type: string
                    contactId:
                      type: object
                      properties:
                        equals:
                          type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
                  filters:
                    sequenceId:
                      equals: d08f345ace24509e911a0ea8e3d2203c
      description: Retrieve all Emails
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/emails/find:
    parameters: []
    post:
      summary: Get Email
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  email:
                    $ref: '#/components/schemas/Email_2'
              examples:
                example-1:
                  value:
                    email:
                      id: 2322707bbc41577d9806400e2daa25de
                      subject: 'Re: Paper renewal'
                      hasReplied: true
                      isBounced: false
                      openCount: 1
                      clickCount: 2
                      replyCount: null
                      modifiedTime: '2019-08-24T14:15:22Z'
                      createdTime: '2019-08-24T14:15:22Z'
                      associations:
                        sequenceId: d08f345ace24509e911a0ea8e3d2203c
                        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      operationId: get-one-email
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      description: Retrieve a Email by Id
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/sequences/list:
    parameters: []
    post:
      summary: List Sequences
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  sequences:
                    type: array
                    items:
                      $ref: '#/components/schemas/Sequence'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    sequences:
                    - id: 2322707bbc41577d9806400e2daa25de
                      isEnabled: true
                      name: Reaching out about My Company
                      tags:
                      - cold
                      numSteps: 1
                      scheduledCount: 0
                      openedCount: 0
                      optedOutCount: 0
                      repliedCount: 0
                      clickedCount: 0
                    nextPageCursor: d9806400e2daa25de2322707bbc41577
      operationId: get-all-sequences
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      description: Retrieve all Sequences
      security:
      - VesselAPIToken: []
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/sequence/start:
    parameters: []
    post:
      summary: Start Sequence
      operationId: post-start-sequence
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                fields:
                  $ref: '#/components/schemas/SequenceStart'
              required:
              - id
              - fields
            examples:
              example-1:
                value:
                  id: 939f3f91233b4b0e8f0f2a0f2a0f2a0f
                  fields:
                    contactId: 233b4b8f0f2910ea0f2a0f2a0f939f3f
                    mailboxId: 8f0f2a0f2a0f2a0f939f3f91233b4b0e
      description: Start a contact on a sequence.
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/sequences/create:
    parameters: []
    post:
      summary: Create Sequence
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: 2322707bbc41577d9806400e2daa25de
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sequence:
                  $ref: '#/components/schemas/SequenceCreate'
              required:
              - sequence
            examples:
              example-1:
                value:
                  sequence:
                    name: Email Sequence
                    shareType: team
                    $native: {}
      operationId: post-sequences
      description: Create an empty Sequence. To add steps to the sequence, use the /engagement/sequence-steps/batch-create endpoint.
      security:
      - VesselAPIToken: []
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/sequence-steps/batch-create:
    parameters: []
    post:
      summary: Batch Create Sequence Steps
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sequenceId:
                  type: string
                  description: The id of the sequence to add steps to.
                steps:
                  type: array
                  items:
                    $ref: '#/components/schemas/SequenceStepCreate'
              required:
              - steps
            examples:
              example-1:
                value:
                  sequenceId: 2322707bbc41577d9806400e2daa25de
                  steps:
                  - name: Step 1 (Automated Email)
                    type: auto_email
                    daysAfter: 2
                    $native: {}
                    settings:
                      templateName: Email Template
                      isReply: false
                      subject: Hello from Dunder!
                      body: Hi {{first_name}}! I'm reaching out to ask you about your paper needs.
                      $native: {}
      operationId: post-sequences-steps
      description: Create one or more steps in a sequence. Some providers, such as Salesloft, only allow you to call this endpoint once.
      security:
      - VesselAPIToken: []
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/mailboxes/list:
    parameters: []
    post:
      summary: List Mailboxes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  mailboxes:
                    type: array
                    items:
                      $ref: '#/components/schemas/Mailbox'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    mailboxes:
                    - id: 2322707bbc41577d9806400e2daa25de
                      email: fake@email.com
                      isDefault: true
                      associations:
                        ownerUserId: d9806400e2daa25de2322707bbc41577
                    nextPageCursor: d9806400e2daa25de2322707bbc41577
      operationId: get-all-mailboxes
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      description: Retrieve all Mailboxes
      security:
      - VesselAPIToken: []
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/engagement/tags/list:
    parameters: []
    post:
      summary: List Tags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  tags:
                    type: array
                    items:
                      $ref: '#/components/schemas/Tag'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    tags:
                    - id: 34f5b4b0b6b650c981a174b02753c390
                      name: Tag 1
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: string
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      operationId: get-all-tags
      description: Retrieve all Tags
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/marketing/users/list:
    parameters: []
    post:
      summary: List Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User_5'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    users:
                    - id: e5f32d4fd2115220bd20a2ccf81210ec
                      email: tom@dundermifflin.com
                      firstName: Tom
                      lastName: Haverford
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: '123123'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      operationId: get-all-users
      description: List Users
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/marketing/contacts/list:
    parameters: []
    post:
      summary: List Contacts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contacts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact_4'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    contacts:
                    - id: e5f32d4fd2115220bd20a2ccf81210ec
                      email: tom@dundermifflin.com
                      firstName: Tom
                      lastName: Haverford
                      phone: '8192223333'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: '123123'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      operationId: get-all-contacts
      description: List Contacts
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/marketing/contacts/find:
    parameters: []
    post:
      summary: Find Contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  contact:
                    $ref: '#/components/schemas/Contact_4'
              examples:
                example-1:
                  value:
                    contact:
                      id: e5f32d4fd2115220bd20a2ccf81210ec
                      email: tom@dundermifflin.com
                      firstName: Tom
                      lastName: Haverford
                      phone: '8192223333'
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      operationId: get-one-contact
      description: Find Contact
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/marketing/contacts/create:
    post:
      summary: Create Contact
      operationId: post-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  id:
                    type: string
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contact:
                  $ref: '#/components/schemas/ContactCreate_4'
              required:
              - contact
            examples:
              example-1:
                value:
                  contact:
                    email: tom@dundermifflin.com
                    firstName: Tom
                    lastName: Haverford
                    phone: '8192223333'
                    listId: '12'
                    $native: {}
      description: Create a Contact
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/marketing/contacts/update:
    parameters: []
    post:
      summary: Update Contact
      operationId: put-contact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: '0'
                properties:
                  id:
                    type: string
                required:
                - id
              examples:
                example-1:
                  value:
                    id: '0'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                contact:
                  $ref: '#/components/schemas/ContactUpdate_3'
              required:
              - id
              - contact
            examples:
              example-1:
                value:
                  id: string
                  contact:
                    email: tom@dundermifflin.com
                    firstName: Tom
                    lastName: Haverford
                    phone: '8192223333'
                    $native: {}
          application/xml:
            schema:
              type: object
              properties: {}
        description: ''
      description: Update an existing Contact
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/marketing/lists/list:
    parameters: []
    post:
      summary: List Lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  lists:
                    type: array
                    items:
                      $ref: '#/components/schemas/List'
                  nextPageCursor:
                    type: string
              examples:
                example-1:
                  value:
                    lists:
                    - id: e5f32d4fd2115220bd20a2ccf81210ec
                      name: Paper leads
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
                    nextPageCursor: '123123'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                cursor:
                  type: string
            examples:
              example-1:
                value:
                  cursor: '123123'
                  include:
                    $native: false
      operationId: get-all-lists
      description: List Lists
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
  /api/unifications/marketing/lists/find:
    parameters: []
    post:
      summary: Find List
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: responseBody
                type: object
                properties:
                  list:
                    $ref: '#/components/schemas/List'
              examples:
                example-1:
                  value:
                    list:
                      id: e5f32d4fd2115220bd20a2ccf81210ec
                      name: Paper leads
                      createdTime: '2019-08-24T14:15:22Z'
                      modifiedTime: '2019-08-24T14:15:22Z'
      parameters:
      - name: x-vessel-access-token
        in: header
        description: Access Token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  $ref: '#/components/schemas/IncludeFields'
                id:
                  type: string
              required:
              - id
            examples:
              example-1:
                value:
                  id: '123123'
                  include:
                    $native: false
      operationId: get-one-list
      description: Find List
      tags:
      - Unifications
    servers:
    - url: https://api.vessel.dev
components:
  schemas:
    IncludeFields:
      title: Include Fields
      type: object
      examples:
      - $native: true
      properties:
        $native:
          type: boolean
          description: Set to true if you want to include all native fields.
    User:
      title: User
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        name: Tom Haverford
        isDeleted: false
        createdTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Chat tool.
        name:
          type: string
        isDeleted:
          type: boolean
        createdTime:
          type: string
          description: The timestamp that the user was created
        $native:
          ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
    Channel:
      title: Channel
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        name: Paper updates
        createdTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Chat tool.
        name:
          type: string
        createdTime:
          type: string
          description: The timestamp that the channel was created
        $native:
          ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
    DateFilter:
      type: object
      properties:
        equals:
          type: string
        gt:
          type: string
        lt:
          type: string
        lte:
          type: string
        gte:
          type: string
        not:
          type: string
        in:
          type: array
          items:
            type: string
        notIn:
          type: array
          items:
            type: string
    StringListFilter:
      type: object
      properties:
        has:
          type: string
        hasEvery:
          type: array
          items:
            type: string
        hasSome:
          type: array
          items:
            type: string
        isEmpty:
          type: boolean
    Contact:
      title: Contact
      type: object
      description: Information about an individual affiliated with another CRM Object (e.g., a Lead, a Deal, etc)
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
          description: Not supported by Pipedrive
        phone:
          type: string
          description: The primary phone number for this contact
        mobilePhone:
          type: string
          description: The primary mobile phone number for this contact. Possibly the same as the phone number.
        createdTime:
          type: string
          description: The timestamp that the contact was created
        modifiedTime:
          type: string
          description: The timestamp the contact was last modified
        associations:
          type: object
          required:
          - accountIds
          - dealIds
          - leadIds
          - ownerUserId
          properties:
            accountIds:
              type: array
              items:
                type: string
            dealIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    ListWithAssociations:
      title: List
      type: object
      description: A List or View in a CRM
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        name:
          type: string
          description: The name of the list
        createdTime:
          type: string
          description: The timestamp that the list was created
        modifiedTime:
          type: string
          description: The timestamp the list was last modified
        associations:
          type: object
          required:
          - contactIds
          - leadIds
          - ownerUserId
          properties:
            contactIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this list
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - name
      - createdTime
      - modifiedTime
      - associations
    ContactUpdate:
      title: ContactUpdate
      type: object
      description: Update a Contact.
      properties:
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
          description: Not supported by Pipedrive
        phone:
          type: string
          description: The primary phone
        mobilePhone:
          type: string
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
              description: The Id of the User to assign this Contact to
        $native:
          $ref: '#/components/schemas/NativeData'
    LeadUpdate:
      description: ''
      type: object
      title: LeadUpdate
      properties:
        firstName:
          type: string
          description: Not supported for Pipedrive
        lastName:
          type: string
          description: Not supported for Pipedrive
        jobTitle:
          type: string
        email:
          type: string
          description: Not supported for Pipedrive
        accountName:
          type: string
          description: Name of the Account associated with this lead. Not supported for Pipedrive
        phone:
          type: string
          description: The primary phone. Not supported for Pipedrive
        mobilePhone:
          type: string
          description: The primary mobile phone number for this lead. Possibly the same as the phone number. Not supported for Pipedrive
        $native:
          $ref: '#/components/schemas/NativeData'
    SyncedCache:
      title: Use Synced Cache
      type: boolean
      description: If true, will hit the [synced-cache](/pages/home/synced-cache)
    NoteCreate:
      title: NoteCreate
      type: object
      description: Create a new Note. You may only associate a note with at most one entity of each type upon creation.
      properties:
        contentText:
          type: string
          description: The body of the note as text
        contentHtml:
          type: string
          description: The body of the note as HTML.
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
              description: The user to assign this note to. If there is no ownerUserId provided, the behavior is defined by the downstream system (either assigned to no user or to the user that installed the app).
            dealId:
              type: string
              description: Required unless leadId/accountId/contactId are specified.
            leadId:
              type: string
              description: Required unless dealId/accountId/contactId are specified.
            accountId:
              type: string
              description: Required unless leadId/dealId/contactId are specified.
            contactId:
              type: string
              description: Required unless leadId/accountId/dealId are specified.
        $native:
          $ref: '#/components/schemas/NativeData'
    DealCreate:
      title: DealCreate
      type: object
      properties:
        name:
          type: string
        amount:
          type: number
        closeDate:
          type: string
        probability:
          type: string
          description: Decimal probability of closing the deal
        stage:
          type: string
          description: The stage the deal is in. See /deal/details for possible value
        associations:
          type: object
          properties:
            accountId:
              type: string
              description: The Id of the account to associate this deal with
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - name
      - closeDate
    AccountCreate:
      title: AccountCreate
      type: object
      properties:
        name:
          type: string
        description:
          type: string
          description: Not supported by Pipedrive
        industry:
          type: string
          description: Not supported by Pipedrive
        website:
          type: string
          description: Not supported by Pipedrive
        numberOfEmployees:
          type: number
          description: Not supported by Pipedrive
        annualRevenue:
          type: number
          description: Not supported by Pipedrive
        phone:
          type: string
          description: The primary phone | Not supported by Pipedrive
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
              description: The Id of the User to assign this Account to
        address:
          $ref: '#/components/schemas/Address'
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - name
    Address:
      title: Address
      type: object
      properties:
        street:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
      examples:
      - street: 123 Main St
        city: San Francisco
        state: CA
        postalCode: 94105
        country: US
    Deal:
      title: Deal
      type: object
      description: '(Alias: Opportunity) An object representing either the opportunity to sell a product to an Account, or in the case of an `isWon` deal, a product sold to an Account.

        *CRM Caveats*:

        - Pipedrive: Users must have "Deal probability" turned on for the given pipeline for probability to be configurable and returned.'
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        name:
          type: string
          description: Optional name for this deal
        stage:
          type: string
          description: The stage of the pipeline the deal is in. See /deal/details for possible values
        amount:
          type: number
          description: Total deal money value
        closeDate:
          type: string
          description: When this deal is projected to be closed
        probability:
          type: string
          description: Decimal probability of closing this deal.
        expectedRevenue:
          type: number
          description: probability * amount. This is a computed property
        isWon:
          type: boolean
          description: If this deal has been won. This is a computed property based on stage
        isClosed:
          type: boolean
          description: If this deal is closed (either closed-won or closed-lost). This is a computed property based on stage
        currency:
          type: string
          description: The currency of the deal in ISO format. This can be null if the CRM does not support multiple currencies. See `/info/find` for default currency value
        createdTime:
          type: string
          description: The timestamp that the deal was created
        modifiedTime:
          type: string
          description: The timestamp the deal was last modified
        associations:
          type: object
          required:
          - contactIds
          - accountIds
          - ownerUserId
          properties:
            contactIds:
              type: array
              items:
                type: string
            accountIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this Deal
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - name
      - closeDate
      - createdTime
      - modifiedTime
      - associations
    Task:
      title: Task
      type: object
      description: A task attached to some CRM object
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        body:
          type: string
        subject:
          type: string
        isDone:
          type: boolean
        dueDate:
          type: string
        status:
          type: string
          description: Not supported by Pipedrive
        priority:
          type: string
          description: Not supported by Pipedrive
        createdTime:
          type: string
          description: The timestamp that the task was created
        modifiedTime:
          type: string
          description: The timestamp the task was last modified
        associations:
          type: object
          required:
          - dealIds
          - contactIds
          - accountIds
          - leadIds
          - ownerUserId
          properties:
            dealIds:
              type: array
              items:
                type: string
            contactIds:
              type: array
              items:
                type: string
            accountIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this Task
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    BooleanFilter:
      type: object
      properties:
        equals:
          type: boolean
        not:
          type: boolean
    Email:
      title: Email
      type: object
      description: An email is a message sent from one person to another through an email service. Emails involve participants - the person who the email was sent to, or the person that sent it. Participants are usually a Contact, Lead, or User but in certain CRMs, can be a person not yet associated with a CRM object.
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        from:
          type: string
          description: The email address that sent the email
        to:
          type: array
          description: The email addresses that received the email
          items:
            type: string
        cc:
          type: array
          description: The email addresses that received a copy of the email
          items:
            type: string
        bcc:
          type: array
          description: The email addresses that received a blind copy of the email
          items:
            type: string
        subject:
          type: string
          description: The subject of the email
        bodyText:
          type: string
          description: The text formatted body of the email
        bodyHtml:
          type: string
          description: The html formatted body of the email
        messageDate:
          type: string
          description: The date the email was created. This can be set when creating the email object and is not necessarily the same as the `createdTime` field.
        isIncoming:
          type: boolean
          description: If this email was sent to the user or sent by the user
        isBounced:
          type: boolean
          description: If this email was bounced
        hasAttachment:
          type: boolean
          description: If this email has attachment(s)
        status:
          type: string
          description: The status of the email (CRM specific, see /details).
        createdTime:
          type: string
          description: The timestamp that the email object was created
        modifiedTime:
          type: string
          description: The timestamp the email object was last modified
        associations:
          type: object
          required:
          - accountIds
          - leadIds
          - contactIds
          - dealIds
          - ownerUserId
          properties:
            accountIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            contactIds:
              type: array
              items:
                type: string
            dealIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this email
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - from
      - to
      - subject
      - createdTime
      - modifiedTime
      - associations
    CallCreate:
      title: CallCreate
      type: object
      properties:
        subject:
          type: string
        disposition:
          type: string
          description: See /details endpoint for possible values.
        direction:
          type: string
          enum:
          - inbound
          - outbound
          - internal
        description:
          type: string
        date:
          type: string
          description: ISO Formatted date for when the call occurred
        associations:
          type: object
          properties:
            contactIds:
              type: array
              description: The participants involved in this call. If this is an inbound call, this is the contacts that called, if this is an outbound call, this is the contacts that were called.
              items:
                type: string
            accountId:
              type: string
            ownerUserId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - disposition
      - direction
      - date
    EmailUpdate:
      title: EmailUpdate
      type: object
      description: ''
      examples:
      - isIncoming: false
        status: SENT
        ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      properties:
        isIncoming:
          type: boolean
          description: If this email was sent to the user or sent by the user
        status:
          type: string
          description: The status of the email (CRM specific, see /details).
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
              description: The Id of the User that owns this email
        $native:
          $ref: '#/components/schemas/NativeData'
    EventUpdate:
      title: EventUpdate
      type: object
      properties:
        subject:
          type: string
        description:
          type: string
        type:
          type: string
        location:
          type: string
        startDateTime:
          type: string
        endDateTime:
          type: string
        isAllDayEvent:
          type: boolean
          description: Not supported by HubSpot and Pipedrive
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
    Lead:
      title: Lead
      type: object
      description: 'A Lead represents an individual, or sometimes an organization, that is interested in purchasing your product (i.e., is a potential Deal).

        *CRM Caveats*:

        - HubSpot: we consider contacts with the `leadStatus` set to be leads.'
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        email:
          type: string
        accountName:
          type: string
          description: Name of the Account associated with this lead
        phone:
          type: string
          description: The primary phone
        mobilePhone:
          type: string
          description: The primary mobile phone number for this lead. Possibly the same as the phone number
        createdTime:
          type: string
          description: The timestamp that the lead was created
        modifiedTime:
          type: string
          description: The timestamp the lead was last modified
        associations:
          type: object
          required:
          - contactIds
          - accountIds
          - ownerUserId
          properties:
            contactIds:
              type: array
              items:
                type: string
            accountIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this Lead
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    EventAttendee:
      title: EventAttendee
      type: object
      description: Event Attendees hold information about someone who attendee or was invited to an event. Attendees are always associated with some Event and another person object such as a Contact, Lead, or Other.
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        status:
          type: string
        associatedObjectType:
          type: string
          description: The object type of the associated object (e.g., Contact, Lead, etc) or Other if this Attendee is not associated with a CRM object
          enum:
          - contacts
          - leads
          - other
        email:
          type: string
          description: Optional unless `associationId` is null
        createdTime:
          type: string
          description: The timestamp that the event attendee was created
        modifiedTime:
          type: string
          description: The timestamp the event attendee was last modified
        associations:
          type: object
          required:
          - eventId
          - associationId
          properties:
            eventId:
              type: string
            associationId:
              type: string
              description: The id of the associated object, if this Attendee is not associated with a CRM object, this id is null and the `email` field will be present
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - associatedObjectType
      - createdTime
      - modifiedTime
      - associations
    DealUpdate:
      title: DealUpdate
      type: object
      properties:
        name:
          type: string
        amount:
          type: number
        closeDate:
          type: string
        probability:
          type: string
          description: Decimal probability of closing the deal
        stage:
          type: string
          description: The stage the deal is in. See /deal/details for possible values
        associations:
          type: object
          properties:
            accountId:
              type: string
              description: Update the account this deal is associated with.
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - closeDate
    StringFilter:
      type: object
      properties:
        equals:
          type: string
        contains:
          type: string
        startsWith:
          type: string
        endsWith:
          type: string
        not:
          type: string
        in:
          type: array
          items:
            type: string
        notIn:
          type: array
          items:
            type: string
        mode:
          type: string
          enum:
          - insensitive
    Note:
      title: Note
      type: object
      description: 'A Note attached to some CRM Object. '
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        contentHtml:
          type: string
          description: The body of the note (populated if CRM notes support html)
        contentText:
          type: string
          description: The body of the note (populated if CRM notes only support plaintext)
        createdTime:
          type: string
          description: The timestamp that the note was created
        modifiedTime:
          type: string
          description: The timestamp the note was last modified
        associations:
          type: object
          required:
          - dealIds
          - contactIds
          - accountIds
          - leadIds
          - ownerUserId
          properties:
            dealIds:
              type: array
              items:
                type: string
            contactIds:
              type: array
              items:
                type: string
            accountIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this note
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    ContactCreate:
      title: ContactCreate
      type: object
      description: Properties that a contact can be created with
      properties:
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
          description: Not supported by Pipedrive
        phone:
          type: string
          description: The primary phone
        mobilePhone:
          type: string
        associations:
          type: object
          properties:
            accountId:
              type: string
              description: The Id of the account to associate this contact with
            ownerUserId:
              type: string
              description: The Id of the User to assign this Contact to
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - lastName
    EventAttendeeCreate:
      title: EventAttendeeCreate
      type: object
      description: ''
      properties:
        email:
          type: string
          description: 'Required if associationId is not present and the CRM supports "Other" for attendee associatedObjectType '
        associatedObjectType:
          type: string
          description: The object type of the associated object (e.g., Contact, Lead, etc) or Other if this Attendee is not associated with a CRM object
          enum:
          - contacts
          - leads
          - other
        status:
          type: string
        associations:
          type: object
          required:
          - eventId
          properties:
            associationId:
              type: string
              description: Required unless email is present and CRM supports "Other" for associatedObjectType
            eventId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - associatedObjectType
      - associations
    CustomFieldCreate:
      type: object
      description: ''
      properties:
        customKey:
          type: string
          description: Used for overriding the default key generated from the name of the field. Not supported for Close
        name:
          type: string
        type:
          type: string
          enum:
          - singleselect
          - text
          - number
          - percentage
          - currency
        options:
          type: array
          description: Required when `type = singleselect`
          items:
            type: object
            properties:
              name:
                type: string
              key:
                type: string
            required:
            - name
            - key
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - name
      - type
    Event:
      title: Event
      type: object
      description: 'Events are a type of activity that has attendees and takes place at a certain point in time (i.e., has a start and end date).

        For the currently supported CRMs, these are the objects Events most closely maps to:

        - Salesforce = Events

        - HubSpot = Meetings

        - Pipedrive = Activities

        - Zoho = Events'
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        subject:
          type: string
        description:
          type: string
        type:
          type: string
        location:
          type: string
          description: Where this event takes place. Can be virtual
        startDateTime:
          type: string
        endDateTime:
          type: string
        isAllDayEvent:
          type: boolean
        createdTime:
          type: string
          description: The timestamp that the event was created
        modifiedTime:
          type: string
          description: The timestamp the event was last modified
        associations:
          type: object
          required:
          - accountIds
          - leadIds
          - contactIds
          - dealIds
          - eventAttendeeIds
          - ownerUserId
          properties:
            accountIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            contactIds:
              type: array
              items:
                type: string
            dealIds:
              type: array
              items:
                type: string
            eventAttendeeIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this event
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    EmailCreate:
      title: EmailCreate
      type: object
      properties:
        from:
          type: string
          description: The email address that sent the email
        to:
          type: array
          description: The email addresses that received the email
          items:
            type: string
        cc:
          type: array
          description: The email addresses that received a copy of the email
          items:
            type: string
        bcc:
          type: array
          description: The email addresses that received a blind copy of the email
          items:
            type: string
        subject:
          type: string
          description: The subject of the email
        bodyText:
          type: string
          description: The text formatted body of the email
        bodyHtml:
          type: string
          description: The html formatted body of the email
        messageDate:
          type: string
          description: The date the email was created. This can be set when creating the email object and is not necessarily the same as the `createdTime` field.
        isIncoming:
          type: boolean
          description: If this email was sent to the user or sent by the user
        status:
          type: string
          description: The status of the email (CRM specific, see /details).
        associations:
          type: object
          properties:
            accountId:
              type: string
            dealId:
              type: string
            lead:
              type: object
              description: Associated Leads must participate in the email (i.e., have a role).
              properties:
                id:
                  type: string
                role:
                  enum:
                  - from
                  - to
                  - cc
                  - bcc
            contact:
              type: object
              description: Associated Contacts must participate in the email (i.e., have a role).
              properties:
                id:
                  type: string
                role:
                  enum:
                  - from
                  - to
                  - cc
                  - bcc
            ownerUserId:
              type: string
              description: The Id of the User that owns this email
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - from
      - to
      - subject
    EventAttendeeUpdate:
      title: EventAttendeeUpdate
      type: object
      properties:
        status:
          type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      description: ''
    Field:
      title: Field
      type: object
      description: '(Alias: property) A field is a key-value pair on a CRM Object that provides information about that object.'
      properties:
        key:
          type: string
          description: 'The key in the CRM object (ex: annualRevenue, numberOfEmployees, etc)'
        name:
          type: string
          description: 'The display name of this field (ex: number of employees, annual revenue, etc)'
        type:
          type: string
          enum:
          - string
          - number
          - datetime
          - date
          - boolean
          - reference
          - phone
          - url
          - id
          - email
          - percent
          - singleselect
          - multiselect
          - address
          - decimal
          - time
          - daterange
          - object
        options:
          type: array
          description: Possible options for this field
          items:
            type: object
            properties:
              key:
                oneOf:
                - type: string
                - type: number
              name:
                type: string
        isArray:
          type: boolean
          description: If this field is an array
        custom:
          type: boolean
          description: If this field is a custom field
        universal:
          type: boolean
          description: If this is a field we've unified across CRMs
        required:
          type: boolean
          description: If this field is required when creating the object
        creatable:
          type: boolean
          description: If this field can be used when creating the object
        updatable:
          type: boolean
          description: If this field can be updated
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - key
      - name
      - type
      - custom
      - universal
      - required
      - creatable
      - updatable
      examples:
      - key: numberOfEmployees
        name: number of employees
        type: number
        options: null
        isArray: false
        custom: false
        universal: true
        required: false
        creatable: true
        updatable: true
    CallUpdate:
      title: CallUpdate
      type: object
      properties:
        disposition:
          type: string
          description: See /details endpoint for possible values.
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - disposition
    LeadCreate:
      description: ''
      type: object
      title: LeadCreate
      properties:
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        email:
          type: string
        accountName:
          type: string
          description: 'Name of the Account associated with this lead. Not supported for Pipedrive. Defaults to `[TODO]: Fill in Company Name` in Salesforce'
        phone:
          type: string
          description: The primary phone number for this lead
        mobilePhone:
          type: string
          description: The primary mobile phone number for this lead. Possibly the same as the phone number.
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - lastName
    User_2:
      title: User
      type: object
      description: Users of the connected CRM platform. These are *not* the contacts or leads, but rather the user accounts from the connected CRM.
      examples:
      - id: '12'
        firstName: Micheal
        lastName: Scott
        email: micheal@dundermifflin.com
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        firstName:
          type: string
        lastName:
          type: string
        email:
          format: email
          type: string
        createdTime:
          type: string
          description: The timestamp that the user was created
        modifiedTime:
          type: string
          description: The timestamp the user was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    NativeData:
      title: Native Data
      type: object
      description: Native fields for the connected platform. For reads, this object is only returned if the include.$native field is set to true in the request body.
    Call:
      title: Call
      type: object
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        subject:
          type: string
        disposition:
          type: string
          description: Possibly an enum, See /details endpoint for values.
        direction:
          type: string
          enum:
          - inbound
          - outbound
          - internal
        description:
          type: string
        date:
          type: string
          description: The date the call occurred
        createdTime:
          type: string
          description: The timestamp that the call object was created
        modifiedTime:
          type: string
          description: The timestamp the call object was last modified
        associations:
          type: object
          required:
          - accountIds
          - leadIds
          - contactIds
          - dealIds
          - ownerUserId
          properties:
            accountIds:
              type: array
              items:
                type: string
            contactIds:
              type: array
              items:
                type: string
            dealIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this call
        $native:
          $ref: '#/components/schemas/NativeData'
    EventCreate:
      title: EventCreate
      type: object
      description: ''
      properties:
        subject:
          type: string
        description:
          type: string
        type:
          type: string
        location:
          type: string
        startDateTime:
          type: string
        endDateTime:
          type: string
        isAllDayEvent:
          type: boolean
          description: Not supported by HubSpot and Pipedrive
        associations:
          type: object
          properties:
            dealId:
              type: string
            accountId:
              type: string
            contactId:
              type: string
            leadId:
              type: string
            ownerUserId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - startDateTime
      - endDateTime
    NoteUpdate:
      title: NoteUpdate
      type: object
      description: Update an existing Note. Please note that updating associations is not currently supported.
      properties:
        contentText:
          type: string
          description: The body of the note as text
        contentHtml:
          type: string
          description: The body of the note as HTML.
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
              description: Only Admins can change this property
        $native:
          $ref: '#/components/schemas/NativeData'
    Account:
      title: Account
      type: object
      description: '(Alias: company, organization) An organization involved with your business.'
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        name:
          type: string
        description:
          type: string
          description: A description of this Company/Account. Not supported by Pipedrive
        industry:
          type: string
          description: Not supported by Pipedrive
        annualRevenue:
          type: number
          description: Not supported by Pipedrive
        numberOfEmployees:
          type: number
          description: Not supported by Pipedrive
        website:
          type: string
          description: Not supported by Pipedrive
        phone:
          type: string
          description: The primary phone number. Not supported by Pipedrive
        address:
          $ref: '#/components/schemas/Address'
        createdTime:
          type: string
          description: The timestamp that the account was created
        modifiedTime:
          type: string
          description: The timestamp the account was last modified
        associations:
          type: object
          required:
          - dealIds
          - contactIds
          - leadIds
          - ownerUserId
          properties:
            dealIds:
              type: array
              items:
                type: string
            contactIds:
              type: array
              items:
                type: string
            leadIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this Account
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    NumberFilter:
      type: object
      properties:
        equals:
          type: number
        gt:
          type: number
        lt:
          type: number
        lte:
          type: number
        gte:
          type: number
        not:
          type: number
        in:
          type: array
          items:
            type: number
        notIn:
          type: array
          items:
            type: number
    TaskUpdate:
      title: TaskUpdate
      type: object
      description: ''
      properties:
        body:
          type: string
        subject:
          type: string
        dueDate:
          type: string
        priority:
          type: string
          description: Not supported by Pipedrive
        status:
          type: string
          description: Not supported by Pipedrive
        isDone:
          type: boolean
          description: If both `isDone` and `status` are included, `isDone` will take precedence and automatically set `status` to either the default or a 'closed' status depending on the `isDone` value.
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
    TaskCreate:
      title: TaskCreate
      type: object
      description: ''
      properties:
        body:
          type: string
        subject:
          type: string
        dueDate:
          type: string
          description: ISO Formatted Date for the due date of the task
        priority:
          type: string
          description: Not supported by Pipedrive
        status:
          type: string
          description: Not supported by Pipedrive
        isDone:
          type: boolean
          description: If both `isDone` and `status` are included, `isDone` will take precedence and automatically set `status` to either the default or a 'closed' status depending on the `isDone` value.
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
              description: The user to assign this note to. If there is no ownerUserId provided, the behavior is defined by the downstream system (either assigned to no user or to the user that installed the app).
            leadId:
              type: string
              description: Can only set either leadId or dealId but not both.
            dealId:
              type: string
              description: Can only set either leadId or dealId but not both.
            accountId:
              type: string
            contactId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
    ListWithoutAssociations:
      title: List
      type: object
      description: A List or View in a CRM
      properties:
        id:
          type: string
          description: Id of the object in the connected CRM.
        name:
          type: string
          description: The name of the list
        createdTime:
          type: string
          description: The timestamp that the list was created
        modifiedTime:
          type: string
          description: The timestamp the list was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - name
      - createdTime
      - modifiedTime
    Contact_2:
      title: Contact
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        firstName: Tom
        lastName: Smith
        companyName: Dunder Mifflin
        description: Tom Smith is a sales rep at Dunder Mifflin
        phones:
        - number: '8192223333'
          type: work
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Dialer.
        firstName:
          type: string
        lastName:
          type: string
        companyName:
          type: string
        description:
          type: string
        phones:
          type: array
          items:
            $ref: '#/components/schemas/Phone'
        createdTime:
          type: string
          description: The timestamp that the contact was created
        modifiedTime:
          type: string
          description: The timestamp the contact was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
    User_3:
      title: User
      type: object
      description: Users of the connected Dialer. These are *not* the contacts, but rather the user accounts from the connected Dialer.
      examples:
      - id: 56f653659ea9524b9e0fb0ba67e6f8a0
        firstName: Micheal
        lastName: Scott
        email: micheal@dundermifflin.com
        role: agent
        isAvailable: true
        availabilityStatus: available
        createdTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Dialer.
        firstName:
          type: string
        lastName:
          type: string
        email:
          format: email
          type: string
        role:
          type: string
          enum:
          - agent
          - admin
        isAvailable:
          type: boolean
        availabilityStatus:
          type: string
        createdTime:
          type: string
          description: The timestamp that the user was created
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
    Call_2:
      title: Call
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        to:
        - number: '8192223333'
        from:
        - number: '8192223333'
        startTime: '2019-08-24T14:15:22Z'
        connectedTime: '2019-08-24T14:15:22Z'
        endTime: '2019-08-24T14:15:22Z'
        recordingUrl: www.example.com/recording.mp3
        voicemailUrl: www.example.com/voicemail.mp3
        direction: outbound
        status: completed
        answered: true
        inProgress: false
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
        associations:
          users:
          - id: 34f5b4b0b6b650c981a174b02753c390
            number: '8192223333'
          contacts:
          - id: 56f653659ea9524b9e0fb0ba67e6f8a0
            number: '8192223334'
      properties:
        id:
          type: string
          description: Id of the object in the connected Dialer.
        to:
          type: array
          items:
          - number:
              type: string
        from:
          type: array
          items:
          - number:
              type: string
        startTime:
          type: string
        connectedTime:
          type: string
        endTime:
          type: string
        createdTime:
          type: string
          description: The timestamp that the contact was created
        modifiedTime:
          type: string
          description: The timestamp the contact was last modified
        recordingUrl:
          type: string
          description: The URL of the recording. Only supported for Aircall and Dialpad.
        voicemailUrl:
          type: string
          description: The URL of the voicemail. Only supported for Aircall and Dialpad.
        direction:
          type: string
          enum:
          - inbound
          - outbound
        status:
          type: string
          description: The status of the call.
        answered:
          type: boolean
        inProgress:
          type: boolean
        associations:
          type: object
          properties:
            users:
              type: array
              items:
              - id:
                  type: string
                number:
                  type: string
            contacts:
              type: array
              items:
              - id:
                  type: string
                number:
                  type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
    Phone:
      title: Phone
      type: object
      properties:
        number:
          type: string
          description: The phone number
        type:
          type: string
      example:
        number: 555-555-5555
        type: work
    ContactCreate_2:
      title: ContactCreate
      type: object
      examples:
      - firstName: Tom
        lastName: Smith
        companyName: Dunder Mifflin
        description: Tom Smith is a sales rep at Dunder Mifflin
        phones:
        - number: '8192223333'
          type: work
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        firstName:
          type: string
        lastName:
          type: string
        companyName:
          type: string
        description:
          type: string
        phones:
          type: array
          items:
            $ref: '#/components/schemas/Phone'
        createdTime:
          type: string
          description: The timestamp that the contact was created
        modifiedTime:
          type: string
          description: The timestamp the contact was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - createdTime
      - modifiedTime
    Contact_3:
      title: Contact
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        firstName: Tom
        lastName: Smith
        jobTitle: Director of Operations
        phones:
        - number: '8192223333'
          type: work
          isPrimary: true
        emails:
        - address: tom@dunder.com
          type: work
          isPrimary: true
        address:
          line1: 100 Blue Dr
          line2: Suite 100
          city: Scranton
          state: Pennsylvania
          postalCode: '281332'
          country: USA
        openCount: 0
        clickCount: 3
        replyCount: 1
        bouncedCount: 1
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
        associations:
          accountId: 0dcb45e051315a6ea63b0f16e73689d9
          ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
        customFields: {}
      description: An known individual affiliated with an Account, Deal, etc
      properties:
        id:
          type: string
          description: Id of the object in the connected Engagement Platform.
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        address:
          $ref: '#/components/schemas/Address_2'
          description: Not supported by Apollo
        emails:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        phones:
          type: array
          items:
            $ref: '#/components/schemas/Phone_2'
        openCount:
          type: number
          description: Not supported by Apollo
        clickCount:
          type: number
          description: Not supported by Apollo
        replyCount:
          type: number
          description: Not supported by Apollo
        bouncedCount:
          type: number
          description: Not supported by Outreach & Apollo
        createdTime:
          type: string
          description: The timestamp that the contact was created
        modifiedTime:
          type: string
          description: The timestamp the contact was last modified
        associations:
          type: object
          required:
          - accountId
          - ownerUserId
          properties:
            accountId:
              type: string
            ownerUserId:
              type: string
        customFields:
          type: object
          description: Any custom fields associated with this contact
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    ContactUpdate_2:
      title: ContactUpdate
      type: object
      examples:
      - firstName: Tom
        lastName: Smith
        jobTitle: Director of Operations
        address:
          line1: 100 Blue Dr
          line2: Suite 100
          city: Scranton
          state: Pennsylvania
          postalCode: '281332'
          country: USA
        customFields: {}
      description: Properties that a contact can be updated with
      properties:
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        address:
          $ref: '#/components/schemas/Address_2'
        customFields:
          type: object
          description: Update any custom fields.
        $native:
          $ref: '#/components/schemas/NativeData'
    SequenceStart:
      title: SequenceStart
      type: object
      description: Start a sequence
      examples:
      - contactId: 233b4b8f0f2910ea0f2a0f2a0f939f3f
        mailboxId: 8f0f2a0f2a0f2a0f939f3f91233b4b0e
      properties:
        contactId:
          type: string
        mailboxId:
          type: string
        $native:
          $ref: '#/components/schemas/NativeData'
    Sequence:
      title: Sequence
      type: object
      description: Properties that a sequence can be created with
      examples:
      - id: 2322707bbc41577d9806400e2daa25de
        isEnabled: true
        name: Reaching out about My Company
        tags:
        - cold
        numSteps: 1
        scheduledCount: 0
        openedCount: 0
        optedOutCount: 0
        repliedCount: 0
        clickedCount: 0
      properties:
        id:
          type: string
        isEnabled:
          type: boolean
        name:
          type: string
        tags:
          type: array
          items:
            type: string
        numSteps:
          type: number
          description: Not supported in Salesloft.
        scheduledCount:
          type: number
        openedCount:
          type: number
          description: Not supported in Salesloft.
        optedOutCount:
          type: number
          description: Not supported in Salesloft.
        repliedCount:
          type: number
          description: Not supported in Salesloft.
        clickedCount:
          type: number
          description: Not supported in Salesloft.
        createdTime:
          type: string
          description: The timestamp that the user was created
        modifiedTime:
          type: string
          description: Not supported by Apollo. The timestamp the user was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
    AccountCreate_2:
      title: AccountCreate
      type: object
      examples:
      - name: Blue Cross
        description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
        industry: TV and Media
        numberOfEmployees: 100
        website: www.bluecross.penn
        phone: '8192223333'
        address:
          line1: 100 Blue Dr
          line2: Suite 100
          city: Scranton
          state: Pennsylvania
          postalCode: '281332'
          country: USA
      description: Properties that an account can be created with
      properties:
        name:
          type: string
        description:
          type: string
          description: A description of this Company/Account.
        industry:
          type: string
          description: The industry that this Account belongs to (e.g. "Healthcare", "Technology", etc.)
        numberOfEmployees:
          type: number
        website:
          type: string
        phone:
          type: string
          description: The primary phone number.
        address:
          $ref: '#/components/schemas/Address_2'
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - name
    Address_2:
      title: Address
      type: object
      properties:
        line1:
          type: string
        line2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      examples:
      - line1: 123 Main St
        line2: Apt 1
        city: San Francisco
        state: CA
        postalCode: 94105
        country: US
    Email_2:
      title: Email
      type: object
      description: A email between a User and an external Contact
      examples:
      - id: 2322707bbc41577d9806400e2daa25de
        subject: 'Re: Paper renewal'
        hasReplied: true
        isBounced: false
        openCount: 1
        clickCount: 2
        replyCount: null
        modifiedTime: '2019-08-24T14:15:22Z'
        createdTime: '2019-08-24T14:15:22Z'
        associations:
          sequenceId: d08f345ace24509e911a0ea8e3d2203c
          ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      properties:
        id:
          type: string
          description: Id of the object in the connected Engagement Platform.
        subject:
          type: string
        isBounced:
          type: boolean
        hasReplied:
          type: boolean
        openCount:
          type: number
        clickCount:
          type: number
        replyCount:
          type: number
          description: Not supported in Outreach & Apollo - use `hasReplied`.
        createdTime:
          type: string
          description: The timestamp that the email was created
        modifiedTime:
          type: string
          description: The timestamp the email was last modified
        associations:
          type: object
          required:
          - sequenceId
          - ownerUserId
          properties:
            sequenceId:
              type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this Action
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    SequenceCreate:
      title: Create Sequence
      type: object
      description: null
      examples:
      - name: Email Sequence
        shareType: team
      properties:
        name:
          type: string
        shareType:
          type: string
          enum:
          - team
          - private
          description: '''team'' will share the sequence with all users in the team. ''private'' will only share the sequence with the user that created it.'
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - name
      - shareType
    ContactCreate_3:
      title: ContactCreate
      type: object
      examples:
      - firstName: Tom
        lastName: Smith
        jobTitle: Director of Operations
        emails:
        - address: fake@email.com
          type: work
          isPrimary: true
        address:
          line1: 100 Blue Dr
          line2: Suite 100
          city: Scranton
          state: Pennsylvania
          postalCode: '281332'
          country: USA
        customFields: {}
      description: Properties that a contact can be created with
      properties:
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        address:
          $ref: '#/components/schemas/Address_2'
        emails:
          type: array
          items:
            type: object
            properties:
              address:
                type: string
              isPrimary:
                type: boolean
              type:
                type: string
                enum:
                - work
                - personal
            required:
            - address
        customFields:
          type: object
          description: Set any custom fields on this contact's creation.
        $native:
          $ref: '#/components/schemas/NativeData'
    ContactCustomFieldCreate:
      title: ContactCustomFieldCreate
      type: object
      examples:
      - name: customField1
      properties:
        name:
          type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - name
    EmailAddress:
      title: EmailAddress
      type: object
      properties:
        address:
          type: string
          description: The email address
        type:
          type: string
          enum:
          - work
          - personal
        isPrimary:
          type: boolean
          description: Whether this is the primary email address
        $native:
          $ref: '#/components/schemas/NativeData'
      example:
        address: tom@dunder.com
        type: work
        isPrimary: true
    SequenceStepSettingsCreate:
      title: Create Sequence Step Settings
      type: object
      properties:
        templateName:
          type: string
          description: The name for this template
        isReply:
          type: boolean
          description: Whether or not this email is a reply to the previous step's email
        subject:
          type: string
          description: The subject line for this email
        body:
          type: string
          description: The body of the email. Can be HTML.
        $native:
          $ref: '#/components/schemas/NativeData'
    Tag:
      title: Tag
      type: object
      description: A tag or label used to categorize objects.
      examples:
      - id: 56f653659ea9524b9e0fb0ba67e6f8a0
        name: Tag 1
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Engagement Platform.
        name:
          type: string
          description: Display name of the tag
        createdTime:
          type: string
          description: The timestamp that the user was created.
        modifiedTime:
          type: string
          description: Not supported by Apollo. The timestamp the user was last modified.
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
    Mailbox:
      title: Mailbox
      type: object
      description: Mailboxes in the connected Engagement platform. These are email accounts that outbound emails will be sent from.
      examples:
      - id: 2322707bbc41577d9806400e2daa25de
        email: fake@email.com
        isDefault: true
        associations:
          ownerUserId: d9806400e2daa25de2322707bbc41577
      properties:
        id:
          type: string
        email:
          type: string
        isDefault:
          type: boolean
          description: Not supported by Outreach.
        createdTime:
          type: string
          description: Not supported by Apollo. The timestamp that the user was created
        modifiedTime:
          type: string
          description: Not supported by Apollo. The timestamp the user was last modified
        associations:
          type: object
          properties:
            ownerUserId:
              type: string
        $native:
          $ref: '#/components/schemas/NativeData'
    SequenceStepCreate:
      title: Create Sequence Steps
      type: object
      description: properties that a sequence step can be created with
      examples:
      - name: Step 1 (Automated Email)
        type: auto_email
        daysAfter: 2
        settings:
          templateName: Email Template
          isReply: false
          subject: Hello from Dunder!
          body: Hi {{first_name}}! I'm reaching out to ask you about your paper needs.
      properties:
        name:
          type: string
        type:
          type: string
          enum:
          - auto_email
          - manual_email
        daysAfter:
          type: number
          description: The number of days after the previous step that this step should be sent.
        settings:
          $ref: '#/components/schemas/SequenceStepSettingsCreate'
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - name
      - type
      - settings
      - shareType
    User_4:
      title: User
      type: object
      description: Users of the connected Engagement platform. These are *not* the contacts or leads, but rather the user accounts from the connected Engagement Platform.
      examples:
      - id: 56f653659ea9524b9e0fb0ba67e6f8a0
        firstName: Micheal
        lastName: Scott
        email: micheal@dundermifflin.com
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Engagement Platform.
        firstName:
          type: string
        lastName:
          type: string
        email:
          format: email
          type: string
        createdTime:
          type: string
          description: The timestamp that the user was created.
        modifiedTime:
          type: string
          description: Not supported by Apollo. The timestamp the user was last modified.
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
    ContactCustomField:
      title: ContactCustomField
      type: object
      examples:
      - key: customField1
        name: Custom Field
        type: string
      properties:
        key:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - string
          description: Only string custom fields are currently supported
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - key
      - type
    Account_2:
      title: Account
      type: object
      examples:
      - id: '344'
        name: Blue Cross
        description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton
        industry: TV and Media
        numberOfEmployees: 100
        website: www.bluecross.penn
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
        phone: '8192223333'
        locality: Scranton
        address:
          line1: 100 Blue Dr
          line2: Suite 100
          city: Scranton
          state: Pennsylvania
          postalCode: '281332'
          country: USA
        associations:
          contactIds:
          - e5f32d4fd2115220bd20a2ccf81210ec
          ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
      description: '(Alias: company, organization) An organization involved with your business.'
      properties:
        id:
          type: string
          description: Id of the object in the connected Engagement Platform.
        name:
          type: string
        description:
          type: string
          description: A description of this Company/Account.
        industry:
          type: string
          description: The industry that this Account belongs to (e.g. "Healthcare", "Technology", etc.)
        locality:
          type: string
        numberOfEmployees:
          type: number
        website:
          type: string
        phone:
          type: string
          description: The primary phone number.
        address:
          $ref: '#/components/schemas/Address_2'
        createdTime:
          type: string
          description: The timestamp that the account was created
        modifiedTime:
          type: string
          description: The timestamp the account was last modified
        associations:
          type: object
          required:
          - contactIds
          - ownerUserId
          properties:
            contactIds:
              type: array
              items:
                type: string
            ownerUserId:
              type: string
              description: The Id of the User that owns this Account
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
      - associations
    Phone_2:
      title: Phone
      type: object
      properties:
        number:
          type: string
          description: The phone number
        type:
          type: string
          enum:
          - work
          - personal
          - other
        isPrimary:
          type: boolean
          description: Whether this is the primary phone number
        $native:
          $ref: '#/components/schemas/NativeData'
      example:
        number: 555-555-5555
        type: work
        isPrimary: true
    Contact_4:
      title: Contact
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        email: tom@dundermifflin.com
        firstName: Tom
        lastName: Haverford
        phone: '8192223333'
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Marketing tool.
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        phone:
          type: string
        createdTime:
          type: string
          description: The timestamp that the contact was created
        modifiedTime:
          type: string
          description: The timestamp the contact was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
    ContactUpdate_3:
      title: ContactUpdate
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        email: tom@dundermifflin.com
        firstName: Tom
        lastName: Haverford
        phone: '8192223333'
      properties:
        id:
          type: string
          description: Id of the object in the connected Marketing tool.
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        phone:
          type: string
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
    User_5:
      title: User
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        email: tom@dundermifflin.com
        firstName: Tom
        lastName: Haverford
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Marketing tool.
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        createdTime:
          type: string
          description: The timestamp that the user was created
        modifiedTime:
          type: string
          description: The timestamp the user was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
    List:
      title: List
      type: object
      examples:
      - id: e5f32d4fd2115220bd20a2ccf81210ec
        name: Paper leads
        createdTime: '2019-08-24T14:15:22Z'
        modifiedTime: '2019-08-24T14:15:22Z'
      properties:
        id:
          type: string
          description: Id of the object in the connected Marketing tool.
        name:
          type: string
        createdTime:
          type: string
          description: The timestamp that the list was created
        modifiedTime:
          type: string
          description: The timestamp the list was last modified
        $native:
          $ref: '#/components/schemas/NativeData'
      required:
      - id
      - createdTime
      - modifiedTime
    ContactCreate_4:
      title: ContactCreate
      type: object
      examples:
      - email: tom@dundermifflin.com
        firstName: Tom
        lastName: Haverford
        phone: '8192223333'
        listId: '12'
      properties:
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        phone:
          type: string
        listId:
          type: string
        $native:
          $ref: '#/components/schemas/NativeData'
x-refined-from:
- vessel-chat-openapi.yml
- vessel-crm-openapi.yml
- vessel-dialer-openapi.yml
- vessel-engagement-openapi.yml
- vessel-marketing-automation-openapi.yml