Zywave Activities API

openapi: 3.2.0
info:
  title: BKB Activities API
  version: v2.0
servers:
- url: https://api.zywave.com
security:
- oidc:
  - api.bkb
  - api.bkb:read
tags:
- name: Activities
paths:
  /bkb/v2.0/activities/search:
    post:
      tags:
      - Activities
      summary: Search for activities using criteria
      operationId: Activities_SearchActivities
      requestBody:
        x-name: model
        description: The ActivitySearchModel.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivitySearchModel'
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfActivity'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /bkb/v2.0/activities/activitytypes/search:
    post:
      tags:
      - Activities
      summary: Search for activity types using criteria
      operationId: Activities_SearchActivityTypes
      requestBody:
        x-name: model
        description: The ActivityTypeSearchModel.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityTypeSearchModel'
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfActivity'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /bkb/v2.0/activities:
    post:
      tags:
      - Activities
      summary: Create an activity
      operationId: Activities_AddActivity
      requestBody:
        x-name: model
        description: The ActivityUpdateModel.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityUpdateModel'
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /bkb/v2.0/activities/{activityId}:
    get:
      tags:
      - Activities
      summary: Get an activity by id
      operationId: Activities_GetActivityById
      parameters:
      - name: activityId
        in: path
        required: true
        description: The activity id.
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: includeCustomFields
        in: query
        description: '"To include custom fields or not".'
        schema:
          type:
          - boolean
          - 'null'
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activity'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - Activities
      summary: Update an activity
      operationId: Activities_UpdateActivity
      parameters:
      - name: activityId
        in: path
        required: true
        description: The activity id.
        schema:
          type: integer
          format: int32
        x-position: 1
      requestBody:
        x-name: model
        description: The ActivityUpdateModel.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityUpdateModel'
        required: true
        x-position: 2
      responses:
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '204':
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    delete:
      tags:
      - Activities
      summary: Delete an activity
      operationId: Activities_DeleteActivity
      parameters:
      - name: activityId
        in: path
        required: true
        description: The activity id.
        schema:
          type: integer
          format: int32
        x-position: 1
      requestBody:
        x-name: options
        description: The options.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrudOptions'
        x-position: 2
      responses:
        '204':
          description: ''
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    ActivityUsers:
      type: object
      description: Users class for Notified and Assigned users
      additionalProperties: false
      properties:
        id:
          type: integer
          description: Gets or sets the id.
          format: int32
        brokerContactId:
          type: integer
          description: Gets or sets the broker contact id.
          format: int32
        activityId:
          type: integer
          description: Gets or sets the activity id.
          format: int32
    ValueSearchCriteriaOfInteger:
      allOf:
      - $ref: '#/components/schemas/SearchCriteriaBase'
      - type: object
        additionalProperties: false
        properties:
          rangeEndValue:
            type:
            - integer
            - 'null'
            format: int32
          rangeStartValue:
            type:
            - integer
            - 'null'
            format: int32
          searchType:
            $ref: '#/components/schemas/ValueSearchType'
          value:
            type:
            - integer
            - 'null'
            format: int32
    SearchCriteriaBase:
      type: object
      x-abstract: true
      additionalProperties: false
      properties:
        sort:
          $ref: '#/components/schemas/SortType'
        sortOrder:
          type: integer
          format: int32
    ValueSearchCriteriaOfDateTime:
      allOf:
      - $ref: '#/components/schemas/SearchCriteriaBase'
      - type: object
        additionalProperties: false
        properties:
          rangeEndValue:
            type:
            - string
            - 'null'
            format: date-time
          rangeStartValue:
            type:
            - string
            - 'null'
            format: date-time
          searchType:
            $ref: '#/components/schemas/ValueSearchType'
          value:
            type:
            - string
            - 'null'
            format: date-time
    ActivitiySearchCriteria:
      type: object
      additionalProperties: false
      properties:
        id:
          description: Search Criteria for Id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        activityBaseType:
          description: Gets or sets the type of the activity base.
          oneOf:
          - $ref: '#/components/schemas/EnumSearchCriteriaOfBaseType'
        customFields:
          type:
          - array
          - 'null'
          description: Gets or sets the custom fields.
          items:
            $ref: '#/components/schemas/CustomFieldSearchValue'
        activityTypeId:
          description: Gets or sets the activity type id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        accountId:
          description: Gets or sets the account id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        censusId:
          description: Gets or sets the census id. This can also be refered to as the EmployeeId.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        businessEntityId:
          description: Gets or sets the business entity id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        accountContactId:
          description: Gets or sets the account contact id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        rfpId:
          description: Gets or sets the RFP id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        planId:
          description: Gets or sets the plan id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        proposalId:
          description: Gets or sets the proposal id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        massActivityId:
          description: Gets or sets the mass activity id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        timeSpent:
          description: Gets or sets the time spent.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        dueDate:
          description: Gets or sets the due date.
          oneOf:
          - $ref: '#/components/schemas/DateTimeSearchCriteria'
        isOpen:
          description: Gets or sets the is open.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        closedDate:
          description: Gets or sets the closed date.
          oneOf:
          - $ref: '#/components/schemas/DateTimeSearchCriteria'
        subject:
          description: Gets or sets the subject.
          oneOf:
          - $ref: '#/components/schemas/StringSearchCriteria'
        createdById:
          description: Gets or sets the created by id.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        createdByType:
          description: Gets or sets the type of the created by.
          oneOf:
          - $ref: '#/components/schemas/StringSearchCriteria'
        createDate:
          description: Gets or sets the create date.
          oneOf:
          - $ref: '#/components/schemas/DateTimeSearchCriteria'
        lastUpdatedById:
          description: Gets or sets the last updated by id.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        lastUpdatedByType:
          description: Gets or sets the last type of the updated by.
          oneOf:
          - $ref: '#/components/schemas/StringSearchCriteria'
        lastUpdate:
          description: Gets or sets the last update.
          oneOf:
          - $ref: '#/components/schemas/DateTimeSearchCriteria'
        assignedUsers:
          description: Gets or sets the assigned users.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        notifiedUsers:
          description: Gets or sets the notified users.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        hasWorkflowItems:
          description: Gets or sets the has workflow items.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        recurrenceId:
          description: Gets or sets the recurrence id.
          oneOf:
          - $ref: '#/components/schemas/NullableIdListSearchCriteria'
        brokerCarrierLinkId:
          description: Gets or sets the broker carrier link id.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        employeeName:
          description: Gets or sets the name of the employee.
          oneOf:
          - $ref: '#/components/schemas/StringSearchCriteria'
        accountLocationId:
          description: Gets or sets the account location id.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        opportunityId:
          description: Gets or sets the opportunity id.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
    PagedResultOfActivity:
      type: object
      additionalProperties: false
      properties:
        hasMoreResults:
          type: boolean
        pageIndex:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        skip:
          type: integer
          format: int32
        take:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
        items:
          type: array
          items:
            $ref: '#/components/schemas/Activity'
    StringSearchCriteria:
      allOf:
      - $ref: '#/components/schemas/SearchCriteriaBase'
      - type: object
        additionalProperties: false
        properties:
          searchType:
            $ref: '#/components/schemas/StringSearchType'
          value:
            type:
            - string
            - 'null'
    BooleanSearchType:
      type: string
      description: ''
      x-enumNames:
      - None
      - Equals
      - NotEquals
      enum:
      - None
      - Equals
      - NotEquals
    EnumSearchType:
      type: string
      description: ''
      x-enumNames:
      - None
      - Equals
      - NotEquals
      - Contains
      enum:
      - None
      - Equals
      - NotEquals
      - Contains
    StringSearchType:
      type: string
      description: ''
      x-enumNames:
      - None
      - Equals
      - NotEquals
      - Contains
      - IsNullOrEmpty
      - StartsWith
      - EndsWith
      enum:
      - None
      - Equals
      - NotEquals
      - Contains
      - IsNullOrEmpty
      - StartsWith
      - EndsWith
    NullableIdListSearchCriteria:
      allOf:
      - $ref: '#/components/schemas/IdListSearchCriteria'
      - type: object
        additionalProperties: false
    IdListSearchType:
      type: string
      description: ''
      x-enumNames:
      - None
      - Equals
      - NotEquals
      - Contains
      enum:
      - None
      - Equals
      - NotEquals
      - Contains
    DateTimeSearchCriteria:
      allOf:
      - $ref: '#/components/schemas/ValueSearchCriteriaOfDateTime'
      - type: object
        additionalProperties: false
    ActivityTypeSearchCriteria:
      type: object
      additionalProperties: false
      properties:
        id:
          description: Gets or sets the id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        name:
          description: Gets or sets the name.
          oneOf:
          - $ref: '#/components/schemas/StringSearchCriteria'
        brokerId:
          description: Gets or sets the broker id.
          oneOf:
          - $ref: '#/components/schemas/IdListSearchCriteria'
        sortOrder:
          description: Gets or sets the sort order.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        isDeleted:
          description: Gets or sets the is deleted.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        followUpDateInterval:
          description: Gets or sets the follow up date interval.
          oneOf:
          - $ref: '#/components/schemas/IntSearchCriteria'
        allowOverride:
          description: Gets or sets the allow override.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        isReserved:
          description: Gets or sets the is reserved.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        defaultClosed:
          description: Gets or sets the default closed.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        showOnBenefitClients:
          description: Gets or sets the show on benefit clients.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        showOnPCClients:
          description: Gets or sets the show on PC clients.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        showOnBenefitProspects:
          description: Gets or sets the show on benefit prospects.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        showOnPCProspects:
          description: Gets or sets the show on PC prospects.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        showOnLeads:
          description: Gets or sets the show on leads.
          oneOf:
          - $ref: '#/components/schemas/BooleanSearchCriteria'
        activityBaseType:
          description: Gets or sets the type of the activity base.
          oneOf:
          - $ref: '#/components/schemas/EnumSearchCriteriaOfBaseType'
    ActivityTypeSearchModel:
      type: object
      additionalProperties: false
      properties:
        searchCriteria:
          oneOf:
          - $ref: '#/components/schemas/ActivityTypeSearchCriteria'
        searchOptions:
          oneOf:
          - $ref: '#/components/schemas/SearchOptions'
    SortType:
      type: string
      description: ''
      x-enumNames:
      - None
      - Ascending
      - Descending
      enum:
      - None
      - Ascending
      - Descending
    ActivityUpdateModel:
      type: object
      additionalProperties: false
      properties:
        activity:
          oneOf:
          - $ref: '#/components/schemas/Activity'
        crudOptions:
          oneOf:
          - $ref: '#/components/schemas/CrudOptions'
    BaseType:
      type: string
      description: Indicates the base type of an activity
      x-enumNames:
      - Account
      - Carrier
      - Basic
      enum:
      - Account
      - Carrier
      - Basic
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
        extensions:
          type: object
          additionalProperties: {}
    CustomFieldSearchValue:
      type: object
      additionalProperties: false
      properties:
        customFieldId:
          type: integer
          format: int32
        searchCriteria:
          oneOf:
          - $ref: '#/components/schemas/SearchCriteriaBase'
    BooleanSearchCriteria:
      allOf:
      - $ref: '#/components/schemas/SearchCriteriaBase'
      - type: object
        additionalProperties: false
        properties:
          searchType:
            $ref: '#/components/schemas/BooleanSearchType'
          value:
            type: boolean
    EnumSearchCriteriaOfBaseType:
      allOf:
      - $ref: '#/components/schemas/SearchCriteriaBase'
      - type: object
        additionalProperties: false
        properties:
          searchType:
            $ref: '#/components/schemas/EnumSearchType'
          value:
            $ref: '#/components/schemas/BaseType'
          valueList:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/BaseType'
    Activity:
      type: object
      description: Represents a full activity object used for adding, editing and viewing a single item.
      additionalProperties: false
      properties:
        id:
          type: integer
          description: 'Gets or sets the activity id.

            This field is ready-only.  Any data modified in this field will not be saved.'
          format: int32
        activityTypeId:
          type: integer
          description: Gets or sets the activity type id.
          format: int32
        timeSpent:
          type:
          - integer
          - 'null'
          description: Gets or sets the time spent completing the activity.  Time is represented in minutes.
          format: int32
        dueDate:
          type:
          - string
          - 'null'
          description: Gets or sets the due date of the activity.
          format: date-time
        isOpen:
          type: boolean
          description: Gets or sets a value indicating whether this activity is open or closed.
        subject:
          type:
          - string
          - 'null'
          description: Gets or sets the activity subject.
        notes:
          type:
          - string
          - 'null'
          description: 'Gets or sets the saved activity notes.

            This field is ready-only.  Any data modified in this field will not be saved.'
        first25Notes:
          type:
          - string
          - 'null'
          description: 'Gets or sets the first 25 characters of the activity notes.

            This field is ready-only.  Any data modified in this field will not be saved.'
        createdById:
          type:
          - integer
          - 'null'
          description: 'Gets or sets the id of the user who created the activity.

            This field is ready-only.  Any data modified in this field will not be saved.'
          format: int32
        createDate:
          type:
          - string
          - 'null'
          description: 'Gets or sets the create date.

            This field is ready-only.  Any data modified in this field will not be saved.'
          format: date-time
        createdByType:
          description: Gets or sets the type of the created by.
          oneOf:
          - $ref: '#/components/schemas/UserType'
        lastUpdatedById:
          type:
          - integer
          - 'null'
          description: 'Gets or sets the id of the user who last updated information on the activity.

            This field is ready-only.  Any data modified in this field will not be saved.'
          format: int32
        lastUpdateDate:
          type:
          - string
          - 'null'
          description: 'Gets or sets the last update date.

            This field is ready-only.  Any data modified in this field will not be saved.'
          format: date-time
        lastUpdatedByType:
          description: Gets or sets the last type of the updated by.
          oneOf:
          - $ref: '#/components/schemas/UserType'
        closedDate:
          type:
          - string
          - 'null'
          description: 'Gets or sets the date the activity was closed.

            This field is ready-only.  Any data modified in this field will not be saved.'
          format: date-time
        assignedUsers:
          type:
          - array
          - 'null'
          description: Gets or sets the list of users who are assigned to the activity.   List contains brokercontact ids.
          items:
            $ref: '#/components/schemas/ActivityUsers'
        notifiedUsers:
          type:
          - array
          - 'null'
          description: Gets or sets the list of users who get notified on activity updates.   List contains brokercontact ids.
          items:
            $ref: '#/components/schemas/ActivityUsers'
        accountId:
          type:
          - integer
          - 'null'
          description: Gets or sets the account id.
          format: int32
        businessEntityId:
          type:
          - integer
          - 'null'
          description: Gets or sets the related business entity id.
          format: int32
        planId:
          type:
          - integer
          - 'null'
          description: Gets or sets the related plan id.
          format: int32
        opportunityId:
          type:
          - integer
          - 'null'
          description: Gets or sets the related opportunity id.
          format: int32
        accountContactId:
          type:
          - integer
          - 'null'
          description: Gets or sets the id of the related account contact.
          format: int32
        censusId:
          type:
          - integer
          - 'null'
          description: Gets or sets the related census id. This can also be refered to as the EmployeeId.
          format: int32
        employeeName:
          type:
          - string
          - 'null'
          description: Gets or sets the name of the related employee.
        accountLocationId:
          type:
          - integer
          - 'null'
          description: Gets or sets the related account location id.
          format: int32
        rfpId:
          type:
          - integer
          - 'null'
          description: Gets or sets the related RFP id.
          format: int32
        proposalId:
          type:
          - integer
          - 'null'
          description: Gets or sets the related proposal id.
          format: int32
        recurrenceId:
          type:
          - integer
          - 'null'
          description: Gets or sets the recurrence id.
          format: int32
        recurrenceType:
          type:
          - string
          - 'null'
          description: Gets or sets the text describing the recurrence.
        massAddId:
          type:
          - integer
          - 'null'
          description: Gets or sets the id indicating which mass add process created the activity.
          format: int32
        brokerCarrierLinkId:
          type:
          - integer
          - 'null'
          description: Gets or sets the broker carrier link id.
          format: int32
        activityBaseType:
          description: Gets or sets the base type.
          oneOf:
          - $ref: '#/components/schemas/BaseType'
        hasWorkflowItems:
          type:
          - boolean
          - 'null'
          description: Gets or sets a value indicating whether this instance has workflow items.
        customFields:
          type:
          - array
          - 'null'
          description: Gets or sets the custom fields.
          items:
            $ref: '#/components/schemas/CustomFieldValue'
        recreate:
          type:
          - boolean
          - 'null'
          description: "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes."
    ValueSearchType:
      type: string
      description: ''
      x-enumNames:
      - None
      - Equals
      - NotEquals
      - GreaterThan
      - GreaterThanEquals
      - LessThan
      - LessThanEquals
      - Between
      - NotBetween
      enum:
      - None
      - Equals
      - NotEquals
      - GreaterThan
      - GreaterThanEquals
      - LessThan
      - LessThanEquals
      - Between
      - NotBetween
    IdListSearchCriteria:
      allOf:
      - $ref: '#/components/schemas/SearchCriteriaBase'
      - type: object
        additionalProperties: false
        properties:
          searchType:
            $ref: '#/components/schemas/IdListSearchType'
          value:
            type: integer
            format: int32
          valueList:
            type:
            - array
            - 'null'
            items:
              type: integer
              format: int32
          inclusiveNulls:
            type: boolean
    SearchOptions:
      type: object
      additionalProperties: false
      properties:
        pageIndex:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
    CrudOptions:
      type: object
      additionalProperties: false
      properties:
        force:
          type: boolean
        validateOnly:
          type: boolean
    ActivitySearchModel:
      type: object
      additionalProperties: false
      properties:
        searchCriteria:
          oneOf:
          - $ref: '#/components/schemas/ActivitiySearchCriteria'
        searchOptions:
          oneOf:
          - $ref: '#/components/schemas/SearchOptions'
    IntSearchCriteria:
      allOf:
      - $ref: '#/components/schemas/ValueSearchCriteriaOfInteger'
      - type: object
        additionalProperties: false
    UserType:
      type: string
      description: UserType Enumeration
      x-enumNames:
      - ClientContact
      - BrokerContact
      - ZywaveUser
      - HRCEmployee
      - HRCDivision
      - HRCClient
      - HRCClientAdmin
      - HRCDemo
      - BKBCarrierContact
      - BKBSync
      - Automated
      - Employee
      - ProspectContact
      - Unknown
      - Broker
      enum:
      - ClientContact
      - BrokerContact
      - ZywaveUser
      - HRCEmployee
      - HRCDivision
      - HRCClient
      - HRCClientAdmin
      - HRCDemo
      - BKBCarrierContact
      - BKBSync
      - Automated
      - Employee
      - ProspectContact
      - Unknown
      - Broker
    CustomFieldValue:
      type: object
      additionalProperties: false
      properties:
        brokerId:
          type: integer
          format: int32
        customFieldId:
          type: integer
          format: int32
        id:
          type: integer
          format: int32
        itemId:
          type: integer
          format: int32
        value:
          type:
          - string
          - 'null'
  securitySchemes:
    oidc:
      type: openIdConnect
      openIdConnectUrl: https://auth.zywave.com//.well-known/openid-configuration
    bearer:
      type: http
      description: Enter your JWT access token
      scheme: bearer
      bearerFormat: JWT
x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))