openapi: 3.0.3
info:
  description: "Outreach Public API is documented here, at the Development Portal, expand the link [Outreach REST API Reference](https://developers.outreach.io/api/reference/overview/)\
    \ in the left navigation bar to see human-readable description of endpoints and data types.\n\nHowever, if you would like\
    \ to get machine-readable schema definition there are two other options available:\n\n* [https://api.outreach.io/api/v2/schema.json](https://api.outreach.io/api/v2/schema.json)\
    \ contains the API definition in  the [json-schema format](https://json-schema.org/) and if you provide `Authorization`\
    \ header with valid token (same as actual API call) all the custom objects defined for the organization will be included\
    \ as well.\n\n* [https://api.outreach.io/api/v2/schema/openapi.json](https://api.outreach.io/api/v2/schema/openapi.json)\
    \ contains the API definition in the [OpenAPI / Swagger format](https://swagger.io/specification/). Unfortunately custom\
    \ objects are not included in this file.\n\nAdditionally to these standard definitions Outreach provides detailed list\
    \ of validations applied to custom fields. Custom objects will be included later, the work is in progress.\n\n* [https://api.outreach.io/api/v2/types](https://api.outreach.io/api/v2/types)\
    \ endpoint returns a list of all `customXXX` fields on standard objects with their type, label, options or other constraints\
    \ defined by the administrator. This endpoint requires valid token in the `Authorization` header. The format of the definitions\
    \ is described below.\n\n### Custom field types\n\n```json\n{\n  \"data\": [\n    {\n      \"type\": \"<object_name>\"\
    ,\n      \"meta\": {\n        \"validations\": {\n          \"<field_name>\": {\n            \"type\": \"<validation_type>\"\
    ,\n            \"required\": true / false,\n            \"label\": \"...\",\n            \"definition\": null / [\"...\"\
    , ...] / \"...\"\n          },\n          ...\n          }\n        }\n      }\n    },\n    ...\n  ]\n}\n```\n\n#### Objects\
    \ with custom fields\n\n* Account\n* Opportunity\n* OpportunityLineItem\n* OpportunityProspectRole\n* Product\n* Prospect\n\
    * Purchase\n\n#### Validation types\n\n* `boolean` - true or false\n* `currency` - monetary value, `definition` contains\
    \ an abbreviation of the currency like `\"USD\"` or `\"EUR\"`\n* `date` - a date stored in ISO8601 format: YYYY-MM-DD.\n\
    * `date_time` a date and time stored as YYYY-MM-DDThh:mm:ss.\n* `inclusion` - a pick list with predefined set of options\
    \ available in `definition` attribute as a list of strings\n* multi_inclusion - a pick list with several options selectable\
    \ at once with predefined set of options available in `definition` attribute as a list of strings\n* `numerical`\n* `percentage`\n\
    * `phone_number`\n* `string`\n* `url`\n"
  title: Outreach REST API Reference
  version: ''
servers:
- url: https://api.outreach.io/api/v2
security:
- bearerAuth: []
tags:
- description: '<SchemaDefinition schemaRef="#/components/schemas/account" />


    ## Account Relationships


    <SchemaDefinition schemaRef="#/components/schemas/accountRelationships" />


    ## Account Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Account has to external sources. | provideDataConnections |



    ## ⌵ Account Actions


    '
  name: Account
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/accountNote" />


    ## Account Note Relationships


    <SchemaDefinition schemaRef="#/components/schemas/accountNoteRelationships" />


    ## ⌵ Account Note Actions


    '
  name: Account Note
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/auditLog" />


    ## Audit Log Custom Filters


    | **NAME**| **VALUE TYPE** | **VALUE KIND** | **VALUE LENGTH** |

    | --- | --- | --- | --- |

    | agentEmail | string| single| N/A|

    | agentIpAddress | string| single| N/A|



    ## ⌵ Audit Log Actions


    '
  name: Audit Log
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/batch" />


    ## Batch Relationships


    <SchemaDefinition schemaRef="#/components/schemas/batchRelationships" />


    ## Batch Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Batch Actions


    '
  name: Batch
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/batchItem" />


    ## Batch Item Relationships


    <SchemaDefinition schemaRef="#/components/schemas/batchItemRelationships" />


    ## ⌵ Batch Item Actions


    '
  name: Batch Item
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/call" />


    ## Call Relationships


    <SchemaDefinition schemaRef="#/components/schemas/callRelationships" />


    ## Call Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Call has to external sources. | provideDataConnections |



    ## ⌵ Call Actions


    '
  name: Call
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/callDisposition" />


    ## Call Disposition Relationships


    <SchemaDefinition schemaRef="#/components/schemas/callDispositionRelationships" />


    ## Call Disposition Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Call Disposition Actions


    '
  name: Call Disposition
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/callPurpose" />


    ## Call Purpose Relationships


    <SchemaDefinition schemaRef="#/components/schemas/callPurposeRelationships" />


    ## Call Purpose Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Call Purpose Actions


    '
  name: Call Purpose
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/complianceRequest" />


    ## Compliance Request Relationships


    <SchemaDefinition schemaRef="#/components/schemas/complianceRequestRelationships" />


    ## ⌵ Compliance Request Actions


    '
  name: Compliance Request
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/contentCategory" />


    ## Content Category Relationships


    <SchemaDefinition schemaRef="#/components/schemas/contentCategoryRelationships" />


    ## Content Category Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Content Category Actions


    '
  name: Content Category
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/contentCategoryMembership" />


    ## Content Category Membership Relationships


    <SchemaDefinition schemaRef="#/components/schemas/contentCategoryMembershipRelationships" />


    ## Content Category Membership Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Content Category Membership Actions


    '
  name: Content Category Membership
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/contentCategoryOwnership" />


    ## Content Category Ownership Relationships


    <SchemaDefinition schemaRef="#/components/schemas/contentCategoryOwnershipRelationships" />


    ## Content Category Ownership Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Content Category Ownership Actions


    '
  name: Content Category Ownership
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/customDuty" />


    ## ⌵ Custom Duty Actions


    '
  name: Custom Duty
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/duty" />


    ## ⌵ Duty Actions


    '
  name: Duty
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/emailAddress" />


    ## Email Address Relationships


    <SchemaDefinition schemaRef="#/components/schemas/emailAddressRelationships" />


    ## Email Address Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Email Address Actions


    '
  name: Email Address
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/event" />


    ## Event Relationships


    <SchemaDefinition schemaRef="#/components/schemas/eventRelationships" />


    ## Event Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  dataConnections | The set of connections a given Event has to external sources. | provideDataConnections |



    ## ⌵ Event Actions


    '
  name: Event
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/favorite" />


    ## Favorite Relationships


    <SchemaDefinition schemaRef="#/components/schemas/favoriteRelationships" />


    ## Favorite Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Favorite Actions


    '
  name: Favorite
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/import" />


    ## Import Relationships


    <SchemaDefinition schemaRef="#/components/schemas/importRelationships" />


    ## Import Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Import Actions


    '
  name: Import
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/kaiaRecording" />


    ## Kaia Recording Relationships


    <SchemaDefinition schemaRef="#/components/schemas/kaiaRecordingRelationships" />


    ## ⌵ Kaia Recording Actions


    '
  name: Kaia Recording
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/kaiaVoiceImport" />


    ## ⌵ Kaia Voice Import Actions


    '
  name: Kaia Voice Import
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/mailAlias" />


    ## Mail Alias Relationships


    <SchemaDefinition schemaRef="#/components/schemas/mailAliasRelationships" />


    ## ⌵ Mail Alias Actions


    '
  name: Mail Alias
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/mailbox" />


    ## Mailbox Relationships


    <SchemaDefinition schemaRef="#/components/schemas/mailboxRelationships" />


    ## Mailbox Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Mailbox Actions


    '
  name: Mailbox
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/mailing" />


    ## Mailing Relationships


    <SchemaDefinition schemaRef="#/components/schemas/mailingRelationships" />


    ## Mailing Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Mailing has to external sources. | provideDataConnections |



    ## ⌵ Mailing Actions


    '
  name: Mailing
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/opportunity" />


    ## Opportunity Relationships


    <SchemaDefinition schemaRef="#/components/schemas/opportunityRelationships" />


    ## Opportunity Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Opportunity has to external sources. | provideDataConnections |



    ## ⌵ Opportunity Actions


    '
  name: Opportunity
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/opportunityProspectRole" />


    ## Opportunity Prospect Role Relationships


    <SchemaDefinition schemaRef="#/components/schemas/opportunityProspectRoleRelationships" />


    ## Opportunity Prospect Role Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Opportunity Prospect Role Actions


    '
  name: Opportunity Prospect Role
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/opportunityStage" />


    ## Opportunity Stage Relationships


    <SchemaDefinition schemaRef="#/components/schemas/opportunityStageRelationships" />


    ## Opportunity Stage Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Opportunity Stage has to external sources. | provideDataConnections
    |



    ## ⌵ Opportunity Stage Actions


    '
  name: Opportunity Stage
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/orgSetting" />


    ## ⌵ Org Setting Actions


    '
  name: Org Setting
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/persona" />


    ## Persona Relationships


    <SchemaDefinition schemaRef="#/components/schemas/personaRelationships" />


    ## Persona Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Persona Actions


    '
  name: Persona
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/phoneNumber" />


    ## Phone Number Relationships


    <SchemaDefinition schemaRef="#/components/schemas/phoneNumberRelationships" />


    ## Phone Number Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Phone Number Actions


    '
  name: Phone Number
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/product" />


    ## Product Relationships


    <SchemaDefinition schemaRef="#/components/schemas/productRelationships" />


    ## Product Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Product has to external sources. | provideDataConnections |



    ## ⌵ Product Actions


    '
  name: Product
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/profile" />


    ## Profile Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Profile Actions


    '
  name: Profile
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/prospect" />


    ## Prospect Relationships


    <SchemaDefinition schemaRef="#/components/schemas/prospectRelationships" />


    ## Prospect Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Prospect has to external sources. | provideDataConnections |



    ## ⌵ Prospect Actions


    '
  name: Prospect
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/prospectNote" />


    ## Prospect Note Relationships


    <SchemaDefinition schemaRef="#/components/schemas/prospectNoteRelationships" />


    ## ⌵ Prospect Note Actions


    '
  name: Prospect Note
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/purchase" />


    ## Purchase Relationships


    <SchemaDefinition schemaRef="#/components/schemas/purchaseRelationships" />


    ## Purchase Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Purchase has to external sources. | provideDataConnections |



    ## ⌵ Purchase Actions


    '
  name: Purchase
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/recipient" />


    ## Recipient Relationships


    <SchemaDefinition schemaRef="#/components/schemas/recipientRelationships" />


    ## Recipient Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Recipient Actions


    '
  name: Recipient
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/role" />


    ## Role Relationships


    <SchemaDefinition schemaRef="#/components/schemas/roleRelationships" />


    ## Role Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Role Actions


    '
  name: Role
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/ruleset" />


    ## Ruleset Relationships


    <SchemaDefinition schemaRef="#/components/schemas/rulesetRelationships" />


    ## Ruleset Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Ruleset Actions


    '
  name: Ruleset
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/sequence" />


    ## Sequence Relationships


    <SchemaDefinition schemaRef="#/components/schemas/sequenceRelationships" />


    ## Sequence Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Sequence Actions


    '
  name: Sequence
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/sequenceState" />


    ## Sequence State Relationships


    <SchemaDefinition schemaRef="#/components/schemas/sequenceStateRelationships" />


    ## Sequence State Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Sequence State Actions


    '
  name: Sequence State
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/sequenceStep" />


    ## Sequence Step Relationships


    <SchemaDefinition schemaRef="#/components/schemas/sequenceStepRelationships" />


    ## Sequence Step Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Sequence Step Actions


    '
  name: Sequence Step
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/sequenceTemplate" />


    ## Sequence Template Relationships


    <SchemaDefinition schemaRef="#/components/schemas/sequenceTemplateRelationships" />


    ## Sequence Template Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Sequence Template Actions


    '
  name: Sequence Template
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/snippet" />


    ## Snippet Relationships


    <SchemaDefinition schemaRef="#/components/schemas/snippetRelationships" />


    ## Snippet Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Snippet Actions


    '
  name: Snippet
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/stage" />


    ## Stage Relationships


    <SchemaDefinition schemaRef="#/components/schemas/stageRelationships" />


    ## Stage Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Stage has to external sources. | provideDataConnections |



    ## ⌵ Stage Actions


    '
  name: Stage
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/task" />


    ## Task Relationships


    <SchemaDefinition schemaRef="#/components/schemas/taskRelationships" />


    ## Task Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given Task has to external sources. | provideDataConnections |



    ## ⌵ Task Actions


    '
  name: Task
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/taskDisposition" />


    ## Task Disposition Relationships


    <SchemaDefinition schemaRef="#/components/schemas/taskDispositionRelationships" />


    ## Task Disposition Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Task Disposition Actions


    '
  name: Task Disposition
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/taskPriority" />


    ## Task Priority Relationships


    <SchemaDefinition schemaRef="#/components/schemas/taskPriorityRelationships" />


    ## ⌵ Task Priority Actions


    '
  name: Task Priority
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/taskPurpose" />


    ## Task Purpose Relationships


    <SchemaDefinition schemaRef="#/components/schemas/taskPurposeRelationships" />


    ## Task Purpose Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Task Purpose Actions


    '
  name: Task Purpose
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/team" />


    ## Team Relationships


    <SchemaDefinition schemaRef="#/components/schemas/teamRelationships" />


    ## Team Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Team Actions


    '
  name: Team
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/template" />


    ## Template Relationships


    <SchemaDefinition schemaRef="#/components/schemas/templateRelationships" />


    ## Template Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Template Actions


    '
  name: Template
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/user" />


    ## User Relationships


    <SchemaDefinition schemaRef="#/components/schemas/userRelationships" />


    ## User Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  dataConnections | The set of connections a given User has to external sources. | provideDataConnections |



    ## ⌵ User Actions


    '
  name: User
  x-internal: false
- description: '<SchemaDefinition schemaRef="#/components/schemas/webhook" />


    ## Webhook Relationships


    <SchemaDefinition schemaRef="#/components/schemas/webhookRelationships" />


    ## Webhook Resource Metadata


    | **METADATA NAME**| **DESCRIPTION** | **QUERY PARAM** |

    | --- | --- | --- |

    |  canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta
    |

    |  canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta
    |



    ## ⌵ Webhook Actions


    '
  name: Webhook
  x-internal: false
paths:
  /accountNotes:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/accountNoteResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Account Notes
      tags:
      - Account Note
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/accountNote'
                    relationships:
                      $ref: '#/components/schemas/accountNoteRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/accountNoteResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Account Note
      tags:
      - Account Note
      x-internal: false
  /accountNotes/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Account Note by ID
      tags:
      - Account Note
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/accountNoteResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get an Account Note by ID
      tags:
      - Account Note
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/accountNote'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/accountNoteRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/accountNote'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/accountNoteRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update an Account Note
      tags:
      - Account Note
      x-internal: false
  /accounts:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/accountResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Accounts
      tags:
      - Account
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/account'
                    relationships:
                      $ref: '#/components/schemas/accountRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/accountResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Account
      tags:
      - Account
      x-internal: false
  /accounts/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Account by ID
      tags:
      - Account
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/accountResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get an Account by ID
      tags:
      - Account
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/account'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/accountRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/account'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/accountRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update an Account
      tags:
      - Account
      x-internal: false
  /auditLogs:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/auditLogResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Audit Logs
      tags:
      - Audit Log
      x-internal: false
  /batchItems:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/batchItemResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Batch Items
      tags:
      - Batch Item
      x-internal: false
  /batchItems/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchItemResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Batch Item by ID
      tags:
      - Batch Item
      x-internal: false
  /batches:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/batchResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Batches
      tags:
      - Batch
      x-internal: false
  /batches/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Batch by ID
      tags:
      - Batch
      x-internal: false
  /batches/{id}/actions/cancel:
    post:
      description: "### Member Action \n\nAction to call to cancel the batch"
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Cancel
      tags:
      - Batch
      x-internal: false
  /batches/{id}/actions/confirm:
    post:
      description: "### Member Action \n\nAction to call to confirm the batch"
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            confirmedCount:
              description: ''
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Confirm
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountAddTags:
    post:
      description: "### Bulk Action \n\nAdds tags to the accounts targeted by the query parameters (default: ALL) using the\
        \ {tags} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        tags:
                          description: ''
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Account Add Tags
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountsAddAssignments:
    post:
      description: "### Bulk Action \n\nAdds assignments to the accounts targeted by the query parameters (default: ALL) using\
        \ the {userIds} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        userIds:
                          description: A list of assignments to add.
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Add Assignments
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountsAssignOwner:
    post:
      description: "### Bulk Action \n\nassign an user with {ownerId} as owner to all the targeted accounts "
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        ownerId:
                          description: The ID of the owner
                          type: integer
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Assign Owner
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountsBulkModify:
    post:
      description: "### Bulk Action \n\nModifies the accounts targeted by the query parameters (default: ALL) using the {field:\
        \ value, ...} pairs passed in request body.\n\nAlternative request body for a single field modification is also supported:\n\
        ```\n{\n\t\"data\": {\n\t\t\"attributes\": {\n\t\t\t\"fieldName\": \"string\",\n\t\t\t\"fieldValue\": \"string\",\n\
        \t\t\t\"ids\": [0]\n\t\t}\n\t},\n\t\"type\": \"string\"\n}\n```"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        attribute1:
                          description: A pair of any field name and its value to modify
                          type: string
                        attribute2:
                          description: A pair of any field name and its value to modify
                          type: boolean
                        attributeN:
                          description: A pair of any field name and its value to modify
                          type: integer
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Bulk Modify
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountsDestroyAll:
    post:
      description: "### Bulk Action \n\nDeletes the accounts targeted by the query parameters (default: ALL)"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Destroy All
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountsRemoveAllAssignments:
    post:
      description: "### Bulk Action \n\nRemoves all assignments from the accounts targeted by the query parameters (default:\
        \ ALL)"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Remove All Assignments
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountsRemoveAssignments:
    post:
      description: "### Bulk Action \n\nRemoves assignments from the accounts targeted by the query parameters (default: ALL)\
        \ using the {userIds} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        userIds:
                          description: A list of assignments to remove.
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Remove Assignments
      tags:
      - Batch
      x-internal: false
  /batches/actions/accountsRemoveTags:
    post:
      description: "### Bulk Action \n\nRemoves tags from the accounts targeted by the query parameters (default: ALL) using\
        \ the {tags} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        tags:
                          description: ''
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Remove Tags
      tags:
      - Batch
      x-internal: false
  /batches/actions/customObjectBulkDelete:
    post:
      description: "### Bulk Action \n\nAction to delete custom objects of type selected by the query parameter {objectName} "
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            objectName:
              description: name of the object type to which the records belong
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
          required:
          - objectName
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Custom Object Bulk Delete
      tags:
      - Batch
      x-internal: false
  /batches/actions/customObjectBulkModify:
    post:
      description: "### Bulk Action \n\nAction to modify custom objects of type selected by the query parameter {objectName} "
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            objectName:
              description: name of the object type to which the records belong
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
          required:
          - objectName
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        attribute1:
                          description: A pair of any field name and its value to modify
                          type: string
                        attribute2:
                          description: A pair of any field name and its value to modify
                          type: boolean
                        attributeN:
                          description: A pair of any field name and its value to modify
                          type: integer
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Custom Object Bulk Modify
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsAddAssignments:
    post:
      description: "### Bulk Action \n\nAdds assignments to the prospects targeted by the query parameters (default: ALL)\
        \ using the {userIds} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        userIds:
                          description: A list of assignments to add.
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Add Assignments
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsAddTags:
    post:
      description: "### Bulk Action \n\nAdds tags to the prospects targeted by the query parameters (default: ALL) using the\
        \ {tags} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        tags:
                          description: A list of tags to add.
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Add Tags
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsAddToSequence:
    post:
      description: "### Bulk Action \n\nAdd Prospects To Sequence"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        mailboxId:
                          description: The ID of the mailbox of the sequencer.
                          type: integer
                        sequenceId:
                          description: The ID of the active sequence associated with the prospects.
                          type: integer
                        stepOverrides:
                          description: The array of object with stepOverrides attributes.
                          items:
                            type: object
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Add To Sequence
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsAssignAccount:
    post:
      description: "### Bulk Action \n\nSets the account to the prospects targeted by the query parameters (default: ALL)\
        \ using the {accountId} which specifies the account to add to the prospects"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        accountId:
                          description: The account ID to associate with the prospects
                          type: string
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Assign Account
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsAssignOpportunity:
    post:
      description: "### Bulk Action \n\nSets the opportunity to the prospects targeted by the query parameters (default: ALL)\
        \ using the {opportunityId} which specifies the account to add to the prospects"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        opportunityId:
                          description: The opportunity ID to associate with the prospects
                          type: string
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Assign Opportunity
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsAssignOwner:
    post:
      description: "### Bulk Action \n\nassign an user with {ownerId} as owner to all the targeted prospects "
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        ownerId:
                          description: The ID of the owner
                          type: integer
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Assign Owner
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsBulkModify:
    post:
      description: "### Bulk Action \n\nModifies the prospects targeted by the query parameters (default: ALL) using the {field:\
        \ value, ...} pairs passed in request body\n\nAlternative request body for a single field modification is also supported:\n\
        ```\n{\n\t\"data\": {\n\t\t\"attributes\": {\n\t\t\t\"fieldName\": \"string\",\n\t\t\t\"fieldValue\": \"string\",\n\
        \t\t\t\"ids\": [0]\n\t\t}\n\t},\n\t\"type\": \"string\"\n}\n```"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        attribute1:
                          description: A pair of any field name and its value to modify
                          type: string
                        attribute2:
                          description: A pair of any field name and its value to modify
                          type: boolean
                        attributeN:
                          description: A pair of any field name and its value to modify
                          type: integer
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Bulk Modify
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsDestroyAll:
    post:
      description: "### Bulk Action \n\nDeletes the prospects targeted by the query parameters (default: ALL)"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Destroy All
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsFinishAll:
    post:
      description: "### Bulk Action \n\nFor all prospects targeted by the query parameters (default: ALL), attempt to finish\
        \ the associated prospect sequence"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Finish All
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsPauseAll:
    post:
      description: "### Bulk Action \n\nFor all prospects targeted by the query parameters (default: ALL), attempt to pause\
        \ the associated prospect sequence"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Pause All
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsRemoveAllAssignments:
    post:
      description: "### Bulk Action \n\nRemoves all assignments from the prospects targeted by the query parameters (default:\
        \ ALL)"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Remove All Assignments
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsRemoveAssignments:
    post:
      description: "### Bulk Action \n\nRemoves assignments from the prospects targeted by the query parameters (default:\
        \ ALL) using the {userIds} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        userIds:
                          description: A list of assignments to remove.
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Remove Assignments
      tags:
      - Batch
      x-internal: false
  /batches/actions/prospectsRemoveTags:
    post:
      description: "### Bulk Action \n\nRemoves tags from the prospects targeted by the query parameters (default: ALL) using\
        \ the {tags} array of strings passed in request body"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            filter:
              description: Filter to apply to select the records on which the action should be applied
            skipConfirmation:
              description: Boolean to specify whether or not the confirmation stop should be skipped
        style: deepObject
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        ids:
                          description: List of IDs to apply the action to
                          items:
                            type: integer
                          type: array
                        tags:
                          description: A list of tags to remove.
                          items:
                            type: string
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/batchResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Remove Tags
      tags:
      - Batch
      x-internal: false
  /callDispositions:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/callDispositionResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Call Dispositions
      tags:
      - Call Disposition
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/callDisposition'
                    relationships:
                      $ref: '#/components/schemas/callDispositionRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/callDispositionResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Call Disposition
      tags:
      - Call Disposition
      x-internal: false
  /callDispositions/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Call Disposition by ID
      tags:
      - Call Disposition
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/callDispositionResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Call Disposition by ID
      tags:
      - Call Disposition
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/callDisposition'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/callDispositionRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/callDisposition'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/callDispositionRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Call Disposition
      tags:
      - Call Disposition
      x-internal: false
  /callPurposes:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/callPurposeResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Call Purposes
      tags:
      - Call Purpose
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/callPurpose'
                    relationships:
                      $ref: '#/components/schemas/callPurposeRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/callPurposeResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Call Purpose
      tags:
      - Call Purpose
      x-internal: false
  /callPurposes/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Call Purpose by ID
      tags:
      - Call Purpose
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/callPurposeResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Call Purpose by ID
      tags:
      - Call Purpose
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/callPurpose'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/callPurposeRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/callPurpose'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/callPurposeRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Call Purpose
      tags:
      - Call Purpose
      x-internal: false
  /calls:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/callResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Calls
      tags:
      - Call
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/call'
                    relationships:
                      $ref: '#/components/schemas/callRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/callResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Call
      tags:
      - Call
      x-internal: false
  /calls/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Call by ID
      tags:
      - Call
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/callResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Call by ID
      tags:
      - Call
      x-internal: false
  /complianceRequests:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/complianceRequestResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Compliance Requests
      tags:
      - Compliance Request
      x-internal: false
    post:
      description: This is a non-standard case please read [this section](/api/common-patterns/#create-compliance-requests)
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        object_type:
                          type: string
                        request_object_email:
                          type: string
                        request_type:
                          type: string
                        requester_email:
                          type: string
                      type: object
                    type:
                      type: string
                  type: object
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      batch_compliance_request_id:
                        type: string
                    type: object
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Compliance Request
      tags:
      - Compliance Request
      x-internal: false
  /complianceRequests/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/complianceRequestResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Compliance Request by ID
      tags:
      - Compliance Request
      x-internal: false
  /contentCategories:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/contentCategoryResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Content Categories
      tags:
      - Content Category
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/contentCategory'
                    relationships:
                      $ref: '#/components/schemas/contentCategoryRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contentCategoryResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Content Category
      tags:
      - Content Category
      x-internal: false
  /contentCategories/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Content Category by ID
      tags:
      - Content Category
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contentCategoryResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Content Category by ID
      tags:
      - Content Category
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/contentCategory'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/contentCategoryRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/contentCategory'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/contentCategoryRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Content Category
      tags:
      - Content Category
      x-internal: false
  /contentCategoryMemberships:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/contentCategoryMembershipResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Content Category Memberships
      tags:
      - Content Category Membership
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/contentCategoryMembership'
                    relationships:
                      $ref: '#/components/schemas/contentCategoryMembershipRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contentCategoryMembershipResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Content Category Membership
      tags:
      - Content Category Membership
      x-internal: false
  /contentCategoryMemberships/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Content Category Membership by ID
      tags:
      - Content Category Membership
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contentCategoryMembershipResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Content Category Membership by ID
      tags:
      - Content Category Membership
      x-internal: false
  /contentCategoryOwnerships:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/contentCategoryOwnershipResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Content Category Ownerships
      tags:
      - Content Category Ownership
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/contentCategoryOwnership'
                    relationships:
                      $ref: '#/components/schemas/contentCategoryOwnershipRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contentCategoryOwnershipResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Content Category Ownership
      tags:
      - Content Category Ownership
      x-internal: false
  /contentCategoryOwnerships/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Content Category Ownership by ID
      tags:
      - Content Category Ownership
      x-internal: false
  /customDuties:
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/customDuty'
                    relationships:
                      $ref: '#/components/schemas/customDutyRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/customDutyResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Custom Duty
      tags:
      - Custom Duty
      x-internal: false
  /duties:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/dutyResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Duties
      tags:
      - Duty
      x-internal: false
  /emailAddresses:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/emailAddressResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Email Addresses
      tags:
      - Email Address
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/emailAddress'
                    relationships:
                      $ref: '#/components/schemas/emailAddressRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/emailAddressResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Email Address
      tags:
      - Email Address
      x-internal: false
  /emailAddresses/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Email Address by ID
      tags:
      - Email Address
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/emailAddressResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get an Email Address by ID
      tags:
      - Email Address
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/emailAddress'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/emailAddressRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/emailAddress'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/emailAddressRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update an Email Address
      tags:
      - Email Address
      x-internal: false
  /events:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/eventResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Events
      tags:
      - Event
      x-internal: false
  /events/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/eventResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get an Event by ID
      tags:
      - Event
      x-internal: false
  /favorites:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/favoriteResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Favorites
      tags:
      - Favorite
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/favorite'
                    relationships:
                      $ref: '#/components/schemas/favoriteRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/favoriteResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Favorite
      tags:
      - Favorite
      x-internal: false
  /favorites/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Favorite by ID
      tags:
      - Favorite
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/favoriteResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Favorite by ID
      tags:
      - Favorite
      x-internal: false
  /imports/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/importResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get an Import by ID
      tags:
      - Import
      x-internal: false
  /imports/actions/accountsImport:
    post:
      description: "### Import Action \n\nThis is the action to import an uploaded file into account's table. Accounts have\
        \ `customId` as a unique field. If you upload a file with unique fields that already exist in Outreach database, the\
        \ dupe method will be applied."
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        dupeMethod:
                          description: Method used to treat duplicated records (overwrite | skip | missing).
                          type: string
                        fileName:
                          description: Name of the file from which the data comes from.
                          type: string
                        mappings:
                          description: 'Mappings of the import represented as {"source": "destination"}.'
                          type: object
                        recordCount:
                          description: The number of rows in the import file.
                          type: integer
                        storageKey:
                          description: Reference of the storage where the file was uploaded. This can was obtained using /api/v2/imports/actions/generateUploadLink
                          type: string
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/importResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Accounts Import
      tags:
      - Import
      x-internal: false
  /imports/actions/bulkUpsert:
    post:
      description: "### Import Action \n\nThis is the action to sync multiple API v2 objects to Outreach tablesBulk upsert\
        \ uses a record's `data.id` attribute to determine uniqueness.The provided dupe method will be applied during processing\
        \ of records that already exist in Outreach."
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        dupeMethod:
                          description: Method used to treat duplicated records (overwriteNoCreate | overwrite | skip | missing).
                          type: string
                        fileName:
                          description: The filename Outreach is going to use to store records during processing.
                          type: string
                        records:
                          description: The collection of API v2 resource objects to upsert.
                          items:
                            type: object
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/importResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Bulk Upsert
      tags:
      - Import
      x-internal: false
  /imports/actions/customObjectBulkUpsert:
    post:
      description: "### Import Action \n\nThis is the action to upsert records of a custom object. Bulk upsert uses a record's\
        \ `data.id` attribute to determine uniqueness. The provided dupe method will be applied during processing of records\
        \ that already exist in Outreach."
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        dupeMethod:
                          description: Method used to treat duplicated records (overwrite | skip | missing | overwriteNoCreate).
                          type: string
                        fileName:
                          description: The filename Outreach is to use to store records during processing.
                          type: string
                        records:
                          description: The collection of custom object records to upsert.
                          items:
                            type: object
                          type: array
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/importResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Custom Object Bulk Upsert
      tags:
      - Import
      x-internal: false
  /imports/actions/generateUploadLink:
    post:
      description: "### Upload Action \n\nGenerates a link, an URL at which the file should be uploaded, and a storage key,\
        \ a reference for the upload"
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/uploadResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Generate Upload Link
      tags:
      - Import
      x-internal: false
  /imports/actions/prospectsImport:
    post:
      description: "### Import Action \n\nThis is the action to import an uploaded file into prospect's table Prospects have\
        \ `externalId` as a unique field. If you upload a file with unique fields that already exist in Outreach database,\
        \ the dupe method will be applied."
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      properties:
                        dupeMethod:
                          description: Method used to treat duplicated records (overwrite | skip | missing).
                          type: string
                        fileName:
                          description: Name of the file from which the data comes from.
                          type: string
                        mappings:
                          description: 'Mappings of the import represented as {"source": "destination"}.'
                          type: object
                        recordCount:
                          description: The number of rows in the import file.
                          type: integer
                        storageKey:
                          description: Reference of the storage where the file was uploaded. This can was obtained using /api/v2/imports/actions/generateUploadLink
                          type: string
                type:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/importResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Prospects Import
      tags:
      - Import
      x-internal: false
  /imports/actions/validateUpload:
    post:
      description: "### Validate Upload Action \n\nValidates the uploaded file"
      parameters:
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            hash:
              description: The hash of the uploaded file
            storageKey:
              description: The storage key of the uploaded file
          required:
          - hash
          - storageKey
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/validateUploadResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Validate Upload
      tags:
      - Import
      x-internal: false
  /kaiaRecordings:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/kaiaRecordingResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Kaia Recordings
      tags:
      - Kaia Recording
      x-internal: false
  /kaiaRecordings/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/kaiaRecordingResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Kaia Recording by ID
      tags:
      - Kaia Recording
      x-internal: false
  /kaiaVoiceImports:
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/kaiaVoiceImport'
                    relationships:
                      $ref: '#/components/schemas/kaiaVoiceImportRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/kaiaVoiceImportResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Kaia Voice Import
      tags:
      - Kaia Voice Import
      x-internal: false
  /mailAliases:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/mailAliasResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Mail Aliases
      tags:
      - Mail Alias
      x-internal: false
  /mailAliases/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/mailAliasResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Mail Alias by ID
      tags:
      - Mail Alias
      x-internal: false
  /mailboxes:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/mailboxResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Mailboxes
      tags:
      - Mailbox
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/mailbox'
                    relationships:
                      $ref: '#/components/schemas/mailboxRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/mailboxResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Mailbox
      tags:
      - Mailbox
      x-internal: false
  /mailboxes/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Mailbox by ID
      tags:
      - Mailbox
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/mailboxResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Mailbox by ID
      tags:
      - Mailbox
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/mailbox'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/mailboxRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/mailbox'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/mailboxRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Mailbox
      tags:
      - Mailbox
      x-internal: false
  /mailboxes/{id}/actions/linkEwsMasterAccount:
    post:
      description: "### Member Action \n\nLink mailbox with EWS master account"
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                description: empty
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Link Ews Master Account
      tags:
      - Mailbox
      x-internal: false
  /mailboxes/{id}/actions/testSend:
    post:
      description: "### Member Action \n\nTest if sending emails works from this mailbox."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/mailboxResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Test Send
      tags:
      - Mailbox
      x-internal: false
  /mailboxes/{id}/actions/testSync:
    post:
      description: "### Member Action \n\nTest if syncing emails works from this mailbox."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/mailboxResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Test Sync
      tags:
      - Mailbox
      x-internal: false
  /mailboxes/{id}/actions/unlinkEwsMasterAccount:
    post:
      description: "### Member Action \n\nUnlink EWS master account from mailbox"
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                description: empty
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Unlink Ews Master Account
      tags:
      - Mailbox
      x-internal: false
  /mailings:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/mailingResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Mailings
      tags:
      - Mailing
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/mailing'
                    relationships:
                      $ref: '#/components/schemas/mailingRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/mailingResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Mailing
      tags:
      - Mailing
      x-internal: false
  /mailings/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/mailingResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Mailing by ID
      tags:
      - Mailing
      x-internal: false
  /opportunities:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/opportunityResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Opportunities
      tags:
      - Opportunity
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/opportunity'
                    relationships:
                      $ref: '#/components/schemas/opportunityRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/opportunityResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Opportunity
      tags:
      - Opportunity
      x-internal: false
  /opportunities/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Opportunity by ID
      tags:
      - Opportunity
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/opportunityResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get an Opportunity by ID
      tags:
      - Opportunity
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/opportunity'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/opportunityRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/opportunity'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/opportunityRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update an Opportunity
      tags:
      - Opportunity
      x-internal: false
  /opportunityProspectRoles:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/opportunityProspectRoleResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Opportunity Prospect Roles
      tags:
      - Opportunity Prospect Role
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/opportunityProspectRole'
                    relationships:
                      $ref: '#/components/schemas/opportunityProspectRoleRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/opportunityProspectRoleResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Opportunity Prospect Role
      tags:
      - Opportunity Prospect Role
      x-internal: false
  /opportunityProspectRoles/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Opportunity Prospect Role by ID
      tags:
      - Opportunity Prospect Role
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/opportunityProspectRoleResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get an Opportunity Prospect Role by ID
      tags:
      - Opportunity Prospect Role
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/opportunityProspectRole'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/opportunityProspectRoleRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/opportunityProspectRole'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/opportunityProspectRoleRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update an Opportunity Prospect Role
      tags:
      - Opportunity Prospect Role
      x-internal: false
  /opportunityStages:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/opportunityStageResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Opportunity Stages
      tags:
      - Opportunity Stage
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/opportunityStage'
                    relationships:
                      $ref: '#/components/schemas/opportunityStageRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/opportunityStageResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Opportunity Stage
      tags:
      - Opportunity Stage
      x-internal: false
  /opportunityStages/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Opportunity Stage by ID
      tags:
      - Opportunity Stage
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/opportunityStageResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get an Opportunity Stage by ID
      tags:
      - Opportunity Stage
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/opportunityStage'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/opportunityStageRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/opportunityStage'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/opportunityStageRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update an Opportunity Stage
      tags:
      - Opportunity Stage
      x-internal: false
  /orgSettings/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: As a UUID
          type: string
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/orgSettingResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get an Org Setting by ID
      tags:
      - Org Setting
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: As a UUID
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/orgSetting'
                    id:
                      description: As a UUID
                      type: string
                    relationships:
                      $ref: '#/components/schemas/orgSettingRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/orgSetting'
                      id:
                        description: As a UUID
                        type: string
                      relationships:
                        $ref: '#/components/schemas/orgSettingRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update an Org Setting
      tags:
      - Org Setting
      x-internal: false
  /personas:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/personaResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Personas
      tags:
      - Persona
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/persona'
                    relationships:
                      $ref: '#/components/schemas/personaRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/personaResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Persona
      tags:
      - Persona
      x-internal: false
  /personas/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Persona by ID
      tags:
      - Persona
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/personaResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Persona by ID
      tags:
      - Persona
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/persona'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/personaRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/persona'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/personaRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Persona
      tags:
      - Persona
      x-internal: false
  /phoneNumbers:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/phoneNumberResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Phone Numbers
      tags:
      - Phone Number
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/phoneNumber'
                    relationships:
                      $ref: '#/components/schemas/phoneNumberRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/phoneNumberResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Phone Number
      tags:
      - Phone Number
      x-internal: false
  /phoneNumbers/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Phone Number by ID
      tags:
      - Phone Number
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/phoneNumberResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Phone Number by ID
      tags:
      - Phone Number
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/phoneNumber'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/phoneNumberRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/phoneNumber'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/phoneNumberRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Phone Number
      tags:
      - Phone Number
      x-internal: false
  /products:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/productResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Products
      tags:
      - Product
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/product'
                    relationships:
                      $ref: '#/components/schemas/productRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/productResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Product
      tags:
      - Product
      x-internal: false
  /products/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Product by ID
      tags:
      - Product
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/productResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Product by ID
      tags:
      - Product
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/product'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/productRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/product'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/productRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Product
      tags:
      - Product
      x-internal: false
  /profiles:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/profileResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Profiles
      tags:
      - Profile
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/profile'
                    relationships:
                      $ref: '#/components/schemas/profileRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/profileResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Profile
      tags:
      - Profile
      x-internal: false
  /profiles/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Profile by ID
      tags:
      - Profile
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/profileResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Profile by ID
      tags:
      - Profile
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/profile'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/profileRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/profile'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/profileRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Profile
      tags:
      - Profile
      x-internal: false
  /prospectNotes:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/prospectNoteResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Prospect Notes
      tags:
      - Prospect Note
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/prospectNote'
                    relationships:
                      $ref: '#/components/schemas/prospectNoteRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/prospectNoteResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Prospect Note
      tags:
      - Prospect Note
      x-internal: false
  /prospectNotes/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Prospect Note by ID
      tags:
      - Prospect Note
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/prospectNoteResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Prospect Note by ID
      tags:
      - Prospect Note
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/prospectNote'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/prospectNoteRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/prospectNote'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/prospectNoteRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Prospect Note
      tags:
      - Prospect Note
      x-internal: false
  /prospects:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/prospectResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Prospects
      tags:
      - Prospect
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/prospect'
                    relationships:
                      $ref: '#/components/schemas/prospectRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/prospectResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Prospect
      tags:
      - Prospect
      x-internal: false
  /prospects/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Prospect by ID
      tags:
      - Prospect
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/prospectResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Prospect by ID
      tags:
      - Prospect
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/prospect'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/prospectRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/prospect'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/prospectRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update a Prospect
      tags:
      - Prospect
      x-internal: false
  /purchases:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/purchaseResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Purchases
      tags:
      - Purchase
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/purchase'
                    relationships:
                      $ref: '#/components/schemas/purchaseRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/purchaseResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Purchase
      tags:
      - Purchase
      x-internal: false
  /purchases/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Purchase by ID
      tags:
      - Purchase
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/purchaseResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Purchase by ID
      tags:
      - Purchase
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/purchase'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/purchaseRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/purchase'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/purchaseRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Purchase
      tags:
      - Purchase
      x-internal: false
  /recipients:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/recipientResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Recipients
      tags:
      - Recipient
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/recipient'
                    relationships:
                      $ref: '#/components/schemas/recipientRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/recipientResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Recipient
      tags:
      - Recipient
      x-internal: false
  /recipients/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Recipient by ID
      tags:
      - Recipient
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/recipientResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Recipient by ID
      tags:
      - Recipient
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/recipient'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/recipientRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/recipient'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/recipientRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Recipient
      tags:
      - Recipient
      x-internal: false
  /roles:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/roleResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Roles
      tags:
      - Role
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/role'
                    relationships:
                      $ref: '#/components/schemas/roleRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/roleResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Role
      tags:
      - Role
      x-internal: false
  /roles/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Role by ID
      tags:
      - Role
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/roleResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Role by ID
      tags:
      - Role
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/role'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/roleRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/role'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/roleRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Role
      tags:
      - Role
      x-internal: false
  /rulesets:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/rulesetResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Rulesets
      tags:
      - Ruleset
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/ruleset'
                    relationships:
                      $ref: '#/components/schemas/rulesetRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/rulesetResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Ruleset
      tags:
      - Ruleset
      x-internal: false
  /rulesets/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Ruleset by ID
      tags:
      - Ruleset
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/rulesetResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Ruleset by ID
      tags:
      - Ruleset
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/ruleset'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/rulesetRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/ruleset'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/rulesetRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Ruleset
      tags:
      - Ruleset
      x-internal: false
  /sequenceStates:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/sequenceStateResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Sequence States
      tags:
      - Sequence State
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/sequenceState'
                    relationships:
                      $ref: '#/components/schemas/sequenceStateRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceStateResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Sequence State
      tags:
      - Sequence State
      x-internal: false
  /sequenceStates/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Sequence State by ID
      tags:
      - Sequence State
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceStateResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Sequence State by ID
      tags:
      - Sequence State
      x-internal: false
  /sequenceStates/{id}/actions/finish:
    post:
      description: "### Member Action \n\nFinishes an active sequence state."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceStateResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Finish
      tags:
      - Sequence State
      x-internal: false
  /sequenceStates/{id}/actions/pause:
    post:
      description: "### Member Action \n\nPauses an active sequence state."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceStateResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Pause
      tags:
      - Sequence State
      x-internal: false
  /sequenceStates/{id}/actions/resume:
    post:
      description: "### Member Action \n\nResumes a paused sequence state."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceStateResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Resume
      tags:
      - Sequence State
      x-internal: false
  /sequenceSteps:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/sequenceStepResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Sequence Steps
      tags:
      - Sequence Step
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/sequenceStep'
                    relationships:
                      $ref: '#/components/schemas/sequenceStepRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceStepResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Sequence Step
      tags:
      - Sequence Step
      x-internal: false
  /sequenceSteps/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceStepResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Sequence Step by ID
      tags:
      - Sequence Step
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/sequenceStep'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/sequenceStepRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/sequenceStep'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/sequenceStepRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Sequence Step
      tags:
      - Sequence Step
      x-internal: false
  /sequenceTemplates:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/sequenceTemplateResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Sequence Templates
      tags:
      - Sequence Template
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/sequenceTemplate'
                    relationships:
                      $ref: '#/components/schemas/sequenceTemplateRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceTemplateResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Sequence Template
      tags:
      - Sequence Template
      x-internal: false
  /sequenceTemplates/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Sequence Template by ID
      tags:
      - Sequence Template
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceTemplateResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Sequence Template by ID
      tags:
      - Sequence Template
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/sequenceTemplate'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/sequenceTemplateRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/sequenceTemplate'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/sequenceTemplateRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Sequence Template
      tags:
      - Sequence Template
      x-internal: false
  /sequenceTemplates/{id}/actions/activate:
    post:
      description: "### Member Action \n\nEnable the sequence step associated with it."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceTemplateResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Activate
      tags:
      - Sequence Template
      x-internal: false
  /sequenceTemplates/{id}/actions/deactivate:
    post:
      description: "### Member Action \n\nDisable the sequence step associated with it."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceTemplateResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Deactivate
      tags:
      - Sequence Template
      x-internal: false
  /sequences:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/sequenceResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Sequences
      tags:
      - Sequence
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/sequence'
                    relationships:
                      $ref: '#/components/schemas/sequenceRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Sequence
      tags:
      - Sequence
      x-internal: false
  /sequences/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Sequence by ID
      tags:
      - Sequence
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Sequence by ID
      tags:
      - Sequence
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/sequence'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/sequenceRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/sequence'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/sequenceRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update a Sequence
      tags:
      - Sequence
      x-internal: false
  /sequences/{id}/actions/activate:
    post:
      description: "### Member Action \n\nEnables the sequence."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Activate
      tags:
      - Sequence
      x-internal: false
  /sequences/{id}/actions/deactivate:
    post:
      description: "### Member Action \n\nDisables the sequence."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/sequenceResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Deactivate
      tags:
      - Sequence
      x-internal: false
  /snippets:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/snippetResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Snippets
      tags:
      - Snippet
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/snippet'
                    relationships:
                      $ref: '#/components/schemas/snippetRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/snippetResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Snippet
      tags:
      - Snippet
      x-internal: false
  /snippets/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Snippet by ID
      tags:
      - Snippet
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/snippetResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Snippet by ID
      tags:
      - Snippet
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/snippet'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/snippetRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/snippet'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/snippetRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Snippet
      tags:
      - Snippet
      x-internal: false
  /stages:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/stageResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Stages
      tags:
      - Stage
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/stage'
                    relationships:
                      $ref: '#/components/schemas/stageRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/stageResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Stage
      tags:
      - Stage
      x-internal: false
  /stages/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Stage by ID
      tags:
      - Stage
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/stageResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Stage by ID
      tags:
      - Stage
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/stage'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/stageRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/stage'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/stageRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Stage
      tags:
      - Stage
      x-internal: false
  /taskDispositions:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/taskDispositionResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Task Dispositions
      tags:
      - Task Disposition
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/taskDisposition'
                    relationships:
                      $ref: '#/components/schemas/taskDispositionRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskDispositionResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Task Disposition
      tags:
      - Task Disposition
      x-internal: false
  /taskDispositions/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Task Disposition by ID
      tags:
      - Task Disposition
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskDispositionResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Task Disposition by ID
      tags:
      - Task Disposition
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/taskDisposition'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/taskDispositionRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/taskDisposition'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/taskDispositionRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Task Disposition
      tags:
      - Task Disposition
      x-internal: false
  /taskPriorities:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/taskPriorityResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Task Priorities
      tags:
      - Task Priority
      x-internal: false
  /taskPriorities/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskPriorityResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Task Priority by ID
      tags:
      - Task Priority
      x-internal: false
  /taskPurposes:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/taskPurposeResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Task Purposes
      tags:
      - Task Purpose
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/taskPurpose'
                    relationships:
                      $ref: '#/components/schemas/taskPurposeRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskPurposeResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Task Purpose
      tags:
      - Task Purpose
      x-internal: false
  /taskPurposes/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Task Purpose by ID
      tags:
      - Task Purpose
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskPurposeResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Task Purpose by ID
      tags:
      - Task Purpose
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/taskPurpose'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/taskPurposeRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/taskPurpose'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/taskPurposeRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Task Purpose
      tags:
      - Task Purpose
      x-internal: false
  /tasks:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/taskResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Tasks
      tags:
      - Task
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/task'
                    relationships:
                      $ref: '#/components/schemas/taskRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Task
      tags:
      - Task
      x-internal: false
  /tasks/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Task by ID
      tags:
      - Task
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Task by ID
      tags:
      - Task
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/task'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/taskRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/task'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/taskRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update a Task
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/advance:
    post:
      description: "### Member Action \n\nAdvances the sequence state associated with the task to the next step in the sequence.\
        \ Note that only tasks with task_type of 'sequence_step_call', 'sequence_step_email', 'sequence_step_linkedin_interact_with_post',\
        \ 'sequence_step_linkedin_other', 'sequence_step_linkedin_send_connection_request', 'sequence_step_linkedin_send_message',\
        \ 'sequence_step_linkedin_view_profile', 'sequence_step_sms' or 'sequence_step_task' can be advanced."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Advance
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/deliver:
    post:
      description: "### Member Action \n\nSchedules the mailing associated with the task for delivery, if possible."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Deliver
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/logMeetInPerson:
    post:
      description: "### Member Action \n\nMarks the meet in-person task as complete with specified task disposition and purpose."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            completionNote:
              description: A note to attach to the associated prospect, if there is one.
            taskDispositionId:
              description: Id of the task disposition
            taskPurposeId:
              description: Id of the task purpose, if there is one.
          required:
          - taskDispositionId
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Log Meet In Person
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/markComplete:
    post:
      description: "### Member Action \n\nMarks the task as complete."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            completionAction:
              description: 'For sequence step tasks, this specifies how to finish the sequence state. Possible values are:
                ''finish_no_reply'' to finish the sequence, ''finish_replied'' to set the sequence as replied, and anything
                else (including leaving it blank) will advance the sequence state.'
            completionNote:
              description: A note to attach to the associated prospect, if there is one.
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Mark Complete
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/reassignOwner:
    post:
      description: "### Member Action \n\nReassigns the owner of a task"
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            ownerId:
              description: The id of the new owner of the task
          required:
          - ownerId
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Reassign Owner
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/reschedule:
    post:
      description: "### Member Action \n\nReschedules a task by setting a new task due time."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            dueAt:
              description: The new time for the task to be due.
          required:
          - dueAt
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Reschedule
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/snooze:
    post:
      description: "### Member Action \n\nSets the 'dueAt' value to be a day later than either now or the existing 'dueAt'\
        \ value, whichever is later."
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            dueAt:
              description: The new time for the task to be due.
            markAsUrgent:
              description: Whether to mark the task as urgent or not.
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Snooze
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/updateNote:
    post:
      description: "### Member Action \n\nUpdates note of a task"
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            note:
              description: The note to set on the task.
          required:
          - note
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update Note
      tags:
      - Task
      x-internal: false
  /tasks/{id}/actions/updateOpportunityAssociation:
    post:
      description: "### Member Action \n\nUpdates opportunity association of a task"
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - explode: true
        in: query
        name: actionParams
        schema:
          properties:
            opportunityAssociation:
              description: The opportunity to associate with the task.
          required:
          - opportunityAssociation
        style: deepObject
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/taskResponse'
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update Opportunity Association
      tags:
      - Task
      x-internal: false
  /teams:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/teamResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Get a Collection of Teams
      tags:
      - Team
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/team'
                    relationships:
                      $ref: '#/components/schemas/teamRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/teamResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Team
      tags:
      - Team
      x-internal: false
  /teams/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Team by ID
      tags:
      - Team
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/teamResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      summary: Get a Team by ID
      tags:
      - Team
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/team'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/teamRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/team'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/teamRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Team
      tags:
      - Team
      x-internal: false
  /templates:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/templateResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Templates
      tags:
      - Template
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/template'
                    relationships:
                      $ref: '#/components/schemas/templateRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/templateResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New Template
      tags:
      - Template
      x-internal: false
  /templates/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Delete an Existing Template by ID
      tags:
      - Template
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/templateResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Template by ID
      tags:
      - Template
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/template'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/templateRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/template'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/templateRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a Template
      tags:
      - Template
      x-internal: false
  /users:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/userResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Users
      tags:
      - User
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/user'
                    relationships:
                      $ref: '#/components/schemas/userRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/userResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Create a New User
      tags:
      - User
      x-internal: false
  /users/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/userResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a User by ID
      tags:
      - User
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/user'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/userRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/user'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/userRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      summary: Update a User
      tags:
      - User
      x-internal: false
  /webhooks:
    get:
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/webhookResponse'
                    type: array
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Collection of Webhooks
      tags:
      - Webhook
      x-internal: false
    post:
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/webhook'
                    relationships:
                      $ref: '#/components/schemas/webhookRelationships'
                    type:
                      type: string
              type: object
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/webhookResponse'
          description: Created
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Create a New Webhook
      tags:
      - Webhook
      x-internal: false
  /webhooks/{id}:
    delete:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          content:
            application/vnd.api+json: {}
          description: Deleted
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Delete an Existing Webhook by ID
      tags:
      - Webhook
      x-internal: false
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/webhookResponse'
          description: OK
        '404':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: Not Found
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Get a Webhook by ID
      tags:
      - Webhook
      x-internal: false
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  properties:
                    attributes:
                      $ref: '#/components/schemas/webhook'
                    id:
                      type: integer
                    relationships:
                      $ref: '#/components/schemas/webhookRelationships'
                    type:
                      type: string
                  required:
                  - type
                  - id
              type: object
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    properties:
                      attributes:
                        $ref: '#/components/schemas/webhook'
                      id:
                        type: integer
                      relationships:
                        $ref: '#/components/schemas/webhookRelationships'
                      type:
                        type: string
                    required:
                    - type
                    - id
                type: object
          description: OK
        '422':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        detail:
                          type: string
                        id:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
          description: JSON error message
      security:
      - bearerAuth: []
        s2sAuthToken: []
      summary: Update a Webhook
      tags:
      - Webhook
      x-internal: false
components:
  schemas:
    account:
      description: 'A descriptor of a named company used to categorize prospects within an account-based sales approach.

        '
      properties:
        annualRevenueRange:
          description: '


            Define the annual revenue range'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        buyerIntentScore:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A custom score given to measure the quality of the account.'
          format: float
          nullable: true
          type: number
          x-internal: false
        companyType:
          description: '


            A description of the company’s type (e.g. "Public Company").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the account was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        custom1:
          description: '


            The value of the account’s first custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom2:
          description: '


            The value of the account’s second custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom3:
          description: '


            The value of the account’s third custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom4:
          description: '


            The value of the account’s fourth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom5:
          description: '


            The value of the account’s fifth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom6:
          description: '


            The value of the account’s sixth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom7:
          description: '


            The value of the account’s seventh custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom8:
          description: '


            The value of the account’s eight custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom9:
          description: '


            The value of the account’s ninth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom10:
          description: '


            The value of the account’s 10th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom11:
          description: '


            The value of the account’s 11th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom12:
          description: '


            The value of the account’s 12th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom13:
          description: '


            The value of the account’s 13th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom14:
          description: '


            The value of the account’s 14th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom15:
          description: '


            The value of the account’s 15th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom16:
          description: '


            The value of the account’s 16th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom17:
          description: '


            The value of the account’s 17th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom18:
          description: '


            The value of the account’s 18th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom19:
          description: '


            The value of the account’s 19th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom20:
          description: '


            The value of the account’s 20th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom21:
          description: '


            The value of the account’s 21st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom22:
          description: '


            The value of the account’s 22nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom23:
          description: '


            The value of the account’s 23rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom24:
          description: '


            The value of the account’s 24th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom25:
          description: '


            The value of the account’s 25th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom26:
          description: '


            The value of the account’s 26th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom27:
          description: '


            The value of the account’s 27th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom28:
          description: '


            The value of the account’s 28th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom29:
          description: '


            The value of the account’s 29th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom30:
          description: '


            The value of the account’s 30th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom31:
          description: '


            The value of the account’s 31st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom32:
          description: '


            The value of the account’s 32nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom33:
          description: '


            The value of the account’s 33rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom34:
          description: '


            The value of the account’s 34th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom35:
          description: '


            The value of the account’s 35th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom36:
          description: '


            The value of the account''s 36th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom37:
          description: '


            The value of the account''s 37th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom38:
          description: '


            The value of the account''s 38th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom39:
          description: '


            The value of the account''s 39th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom40:
          description: '


            The value of the account''s 40th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom41:
          description: '


            The value of the account''s 41st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom42:
          description: '


            The value of the account''s 42nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom43:
          description: '


            The value of the account''s 43rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom44:
          description: '


            The value of the account''s 44th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom45:
          description: '


            The value of the account''s 45th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom46:
          description: '


            The value of the account''s 46th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom47:
          description: '


            The value of the account''s 47th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom48:
          description: '


            The value of the account''s 48th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom49:
          description: '


            The value of the account''s 49th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom50:
          description: '


            The value of the account''s 50th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom51:
          description: '


            The value of the account''s 51st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom52:
          description: '


            The value of the account''s 52nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom53:
          description: '


            The value of the account''s 53rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom54:
          description: '


            The value of the account''s 54th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom55:
          description: '


            The value of the account''s 55th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom56:
          description: '


            The value of the account''s 56th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom57:
          description: '


            The value of the account''s 57th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom58:
          description: '


            The value of the account''s 58th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom59:
          description: '


            The value of the account''s 59th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom60:
          description: '


            The value of the account''s 60th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom61:
          description: '


            The value of the account''s 61st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom62:
          description: '


            The value of the account''s 62nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom63:
          description: '


            The value of the account''s 63rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom64:
          description: '


            The value of the account''s 64th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom65:
          description: '


            The value of the account''s 65th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom66:
          description: '


            The value of the account''s 66th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom67:
          description: '


            The value of the account''s 67th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom68:
          description: '


            The value of the account''s 68th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom69:
          description: '


            The value of the account''s 69th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom70:
          description: '


            The value of the account''s 70th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom71:
          description: '


            The value of the account''s 71st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom72:
          description: '


            The value of the account''s 72nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom73:
          description: '


            The value of the account''s 73rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom74:
          description: '


            The value of the account''s 74th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom75:
          description: '


            The value of the account''s 75th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom76:
          description: '


            The value of the account''s 76th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom77:
          description: '


            The value of the account''s 77th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom78:
          description: '


            The value of the account''s 78th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom79:
          description: '


            The value of the account''s 79th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom80:
          description: '


            The value of the account''s 80th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom81:
          description: '


            The value of the account''s 81st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom82:
          description: '


            The value of the account''s 82nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom83:
          description: '


            The value of the account''s 83rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom84:
          description: '


            The value of the account''s 84th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom85:
          description: '


            The value of the account''s 85th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom86:
          description: '


            The value of the account''s 86th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom87:
          description: '


            The value of the account''s 87th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom88:
          description: '


            The value of the account''s 88th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom89:
          description: '


            The value of the account''s 89th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom90:
          description: '


            The value of the account''s 90th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom91:
          description: '


            The value of the account''s 91st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom92:
          description: '


            The value of the account''s 92nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom93:
          description: '


            The value of the account''s 93rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom94:
          description: '


            The value of the account''s 94th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom95:
          description: '


            The value of the account''s 95th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom96:
          description: '


            The value of the account''s 96th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom97:
          description: '


            The value of the account''s 97th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom98:
          description: '


            The value of the account''s 98th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom99:
          description: '


            The value of the account''s 99th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom100:
          description: '


            The value of the account’s 100th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom101:
          description: '


            The value of the account’s 101st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom102:
          description: '


            The value of the account’s 102nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom103:
          description: '


            The value of the account’s 103rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom104:
          description: '


            The value of the account’s 104th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom105:
          description: '


            The value of the account’s 105th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom106:
          description: '


            The value of the account’s 106th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom107:
          description: '


            The value of the account’s 107th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom108:
          description: '


            The value of the account’s 108th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom109:
          description: '


            The value of the account’s 109th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom110:
          description: '


            The value of the account’s 110th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom111:
          description: '


            The value of the account’s 111th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom112:
          description: '


            The value of the account’s 112th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom113:
          description: '


            The value of the account’s 113th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom114:
          description: '


            The value of the account’s 114th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom115:
          description: '


            The value of the account’s 115th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom116:
          description: '


            The value of the account’s 116th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom117:
          description: '


            The value of the account’s 117th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom118:
          description: '


            The value of the account’s 118th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom119:
          description: '


            The value of the account’s 119th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom120:
          description: '


            The value of the account’s 120th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom121:
          description: '


            The value of the account’s 121st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom122:
          description: '


            The value of the account’s 122nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom123:
          description: '


            The value of the account’s 123rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom124:
          description: '


            The value of the account’s 124th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom125:
          description: '


            The value of the account’s 125th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom126:
          description: '


            The value of the account’s 126th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom127:
          description: '


            The value of the account’s 127th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom128:
          description: '


            The value of the account’s 128th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom129:
          description: '


            The value of the account’s 129th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom130:
          description: '


            The value of the account’s 130th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom131:
          description: '


            The value of the account’s 131st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom132:
          description: '


            The value of the account’s 132nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom133:
          description: '


            The value of the account’s 133rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom134:
          description: '


            The value of the account’s 134th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom135:
          description: '


            The value of the account’s 135th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom136:
          description: '


            The value of the account’s 136th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom137:
          description: '


            The value of the account’s 137th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom138:
          description: '


            The value of the account’s 138th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom139:
          description: '


            The value of the account’s 139th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom140:
          description: '


            The value of the account’s 140th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom141:
          description: '


            The value of the account’s 141st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom142:
          description: '


            The value of the account’s 142nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom143:
          description: '


            The value of the account’s 143rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom144:
          description: '


            The value of the account’s 144th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom145:
          description: '


            The value of the account’s 145th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom146:
          description: '


            The value of the account’s 146th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom147:
          description: '


            The value of the account’s 147th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom148:
          description: '


            The value of the account’s 148th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom149:
          description: '


            The value of the account’s 149th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom150:
          description: '


            The value of the account’s 150th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        customId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A custom ID for the account, often referencing an ID in an external system.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        description:
          description: '


            A custom description of the account.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        domain:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The company’s website domain (e.g. "`www.acme.com`").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        externalSource:
          description: '


            The source of the resource’s creation (e.g. "outreach-api").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        followers:
          description: '


            The number of followers the company has listed on social media.'
          nullable: true
          type: integer
          x-internal: false
        foundedAt:
          description: '


            The founding date of the company.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        industry:
          description: '


            A description of the company’s industry (e.g. "Manufacturing").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        linkedInEmployees:
          description: '


            The number of employees listed on the company’s LinkedIn URL.'
          nullable: true
          type: integer
          x-internal: false
        linkedInUrl:
          description: '


            The company’s LinkedIn URL.'
          maxLength: 1000
          nullable: true
          type: string
          x-internal: false
        locality:
          description: '


            The company’s primary geographic region (e.g. "Eastern USA").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        naicsCodes:
          description: '


            Define codes used to classify businesses by industry'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the company (e.g. "Acme Corporation").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        named:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A boolean value determining whether this is a "named" account or not. Only named accounts will show up on the
            collection index.'
          nullable: true
          type: boolean
          x-internal: false
        naturalName:
          description: '


            The natural name of the company (e.g. "Acme").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        numberOfEmployees:
          description: '


            The number of employees working at the company.'
          nullable: true
          type: integer
          x-internal: false
        sharingTeamId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The ID of the sharing team associated with this object. Access is currently in beta.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        sicCodes:
          description: '


            Define codes that categorize business activities'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        tags:
          description: '


            A list of tag values associated with the account (e.g. ["Enterprise", "Tier 1"]).'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        tickerSymbol:
          description: '


            Define the ticker symbol'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        touchedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the account was last touched.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the account was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        websiteUrl:
          description: '


            The company’s website URL (e.g. "`https://www.acme.com/contact`").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    accountNote:
      description: 'Notes related to accounts

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the account note was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        message:
          description: '


            The text content of this account note.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        noteType:
          description: '


            The context of this account note, one of {note,call,coffee,beer,meeting}.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        opportunityAssociationRule:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            The rule used to associate the account note with an opportunity, one of {recent_created,recent_updated}.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        pinned:
          description: '


            A boolean value indicating whether this account note is pinned.'
          nullable: true
          type: boolean
          x-internal: false
      type: object
      x-internal: false
    accountNoteRelationships:
      properties:
        account:
          description: The account this account note is related to. You can use only the attribute id to filter accountNotes
            by account (e.g. filter[account][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the account note. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The opportunity this account note is related to. Relationship opportunity cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    accountNoteResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/accountNote'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/accountNoteRelationships'
        type:
          type: string
      type: object
      x-internal: false
    accountProspectRelationshipRelationships:
      properties:
        account:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - plugin
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - plugin
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    accountRelationships:
      properties:
        assignedTeams:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        assignedUsers:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - user
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        batches:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The batches associated with the account.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the account. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        defaultPluginMapping:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The default plugin mapping associated with the account. If no plugin mapping is enabled, it will return the first
            plugin mapping associated with the account.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - pluginMapping
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        favorites:
          description: The account favorited by the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - favorite
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of the account. You can use only the attribute id to filter accounts by owner (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        primaryRecordTeam:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The account''s associated prospects. Relationship prospects cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        purchases:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        recordTeamMembers:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - user
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        recordTeams:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated tasks. Relationship tasks cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the account. Relationship updater cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    accountResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/account'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/accountRelationships'
        type:
          type: string
      type: object
      x-internal: false
    accountTeamMemberRelationships:
      properties:
        account:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        jobRole:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - jobRole
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    addressRelationships:
      type: object
    attachmentRelationships:
      type: object
    auditLog:
      description: '

        Audit log events are usually kept for 90 days.


        Based on your Outreach usage, configuration and licence type, you might encounter the following event types:


        | eventName | action |

        | --- | --- |

        | content_card | create, delete, update |

        | csv_downloaded | download |

        | custom_topic | create, delete, update |

        | docdrive_limits | update |

        | export_created | create |

        | export_downloaded | download |

        | gearbox_general_org | create, update |

        | gearbox_voice_org_settings | create, update |

        | general_org_settings | create, update |

        | governance_profile_created | create |

        | governance_profile_destroyed | delete |

        | governance_profile_updated | update |

        | job_role_created | create |

        | job_role_updated | update |

        | kaia_download_link | create, read |

        | kaia_organization_settings | create, update |

        | kaia_playlist | create, delete, update |

        | kaia_playlist_recording | create, delete, update |

        | kaia_provider_settings | create, delete |

        | kaia_recording_event | create, delete, update |

        | kaia_scorecard | create, delete, update |

        | kaia_scorecard_question | create, delete, update |

        | kaia_scorecard_score | create, delete, update |

        | kaia_sharable_link | create, update |

        | kaia_shareable_link | create, read |

        | license | create, delete, update |

        | license_active_version | create, update |

        | license_assignment | create, delete |

        | login |  |

        | logout |  |

        | mailbox_authentication_error | read |

        | org_updated | update |

        | permission_updated | update |

        | plugin_created | create |

        | plugin_destroyed | delete |

        | plugin_field_mapping_created | create |

        | plugin_field_mapping_destroyed | delete |

        | plugin_field_mapping_updated | update |

        | plugin_type_mapping_created | create |

        | plugin_type_mapping_destroyed | delete |

        | plugin_type_mapping_updated | update |

        | plugin_updated | update |

        | prospecting_agent | create, delete, update |

        | prospecting_agent_account_identifier | create, delete |

        | prospecting_agent_account_signal_filter | create, delete |

        | prospecting_agent_engage_existing_prospects | create, delete, update |

        | prospecting_agent_engage_new_prospects | create, delete, update |

        | prospecting_agent_prospect_identifier | create, delete, update |

        | prospecting_agent_prospect_owner_assignment | create, delete |

        | record_actor_assignment_created | create |

        | record_actor_assignment_destroyed | delete |

        | record_actor_assignment_updated | update |

        | research_agent | create, delete, update |

        | retranscribe | create |

        | rsms_secret | create, delete, read, update |

        | ruleset_created | create |

        | ruleset_destroyed | delete |

        | ruleset_updated | update |

        | schedule_block_created | create |

        | schedule_block_destroyed | delete |

        | schedule_block_updated | update |

        | schedule_created | create |

        | schedule_destroyed | delete |

        | schedule_updated | update |

        | sequence_created | create |

        | sequence_destroyed | delete |

        | sequence_step_created | create |

        | sequence_step_destroyed | delete |

        | sequence_step_updated | update |

        | sequence_template_created | create |

        | sequence_template_destroyed | delete |

        | sequence_template_updated | update |

        | sequence_updated | update |

        | team_created | create |

        | team_destroyed | delete |

        | team_membership_created | create |

        | team_membership_destroyed | delete |

        | team_membership_updated | update |

        | team_record_created | create |

        | team_record_destroyed | delete |

        | team_updated | update |

        | trigger_action_created | create |

        | trigger_action_destroyed | delete |

        | trigger_action_updated | update |

        | trigger_created | create |

        | trigger_destroyed | delete |

        | trigger_updated | update |

        | twiliowebhook_address | create, delete |

        | twiliowebhook_phone | create, delete, update |

        | user_created | create |

        | user_updated | update |

        | voice_call_disposition | create, update |

        | voice_call_purpose | create, update |

        | voice_calling_policy_override | create, update |

        '
      properties:
        action:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The action taken.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        additionalInfo:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Additional information related to the action.'
          items:
            type: object
          nullable: true
          type: array
          x-internal: false
        agent:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Details about the agent involved in the action.'
          nullable: true
          type: object
          x-internal: false
        changes:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The list of changes made.'
          items:
            type: object
          nullable: true
          type: array
          x-internal: false
        eventName:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            Audit event name.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        globalId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The global UUID.'
          maxLength: 36
          nullable: true
          type: string
          x-internal: false
        orgId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The orgId UUID.'
          maxLength: 36
          nullable: true
          type: string
          x-internal: false
        requestId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The UUID of the request. RequestId groups dependent events.'
          maxLength: 36
          nullable: true
          type: string
          x-internal: false
        result:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The result of the action: `completed`. `pending` or `failed`.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        timestamp:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The timestamp of the action.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    auditLogRelationships:
      type: object
    auditLogResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/auditLog'
        id:
          description: As a UUID
          type: string
        relationships:
          $ref: '#/components/schemas/auditLogRelationships'
        type:
          type: string
      type: object
      x-internal: false
    batch:
      description: 'A group of records (Prospect, Account, etc.) in which the same particular action was performed.

        '
      properties:
        action:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Action performed on the batch.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        canceledAt:
          description: '


            The date and time the batch was canceled.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        confirmCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of items in the batch to be confirmed.'
          nullable: true
          type: integer
          x-internal: false
        confirmedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the batch was confirmed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        confirmedCountRequired:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Require the user to explicitly confirm the confirm_count.'
          nullable: true
          type: boolean
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the batch was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        externalStartPayload:
          description: '


            Optional parameter used to handle external batch operations'
          maxLength: 16777215
          nullable: true
          type: string
          x-internal: false
        failures:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of failed batch items associated with this batch.'
          nullable: true
          type: integer
          x-internal: false
        finishedAt:
          description: '<img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the batch was finished.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        payload:
          description: '


            The input payload for the batch operation.'
          nullable: true
          type: object
          x-internal: false
        pending:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of pending batch items associated with this batch.'
          nullable: true
          type: integer
          x-internal: false
        startedAt:
          description: '


            The date and time the batch was started.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The current state of the batch.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        summary:
          description: '


            The summary of the batch including failure information.'
          nullable: true
          type: object
          x-internal: false
        total:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total number of batch items associated with this batch.'
          nullable: true
          type: integer
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the batch was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    batchItem:
      description: 'A record associated with a batch in which a particular action was performed.

        '
      properties:
        batchId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The id of the batch this item belongs to.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The time the batch_item was created at.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        data:
          description: '


            The data requested to execute the batch item.'
          maxLength: 16777215
          nullable: true
          type: string
          x-internal: false
        failed:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            Whether this batch item failed during processing.'
          nullable: true
          type: boolean
          x-internal: false
        info:
          description: '


            A description of the failure if one exists.'
          maxLength: 767
          nullable: true
          type: string
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The current state of the batch item.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    batchItemRelationships:
      properties:
        batch:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The batch associated with this record.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - batch
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    batchItemResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/batchItem'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/batchItemRelationships'
        type:
          type: string
      type: object
      x-internal: false
    batchRelationships:
      properties:
        batchItems:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The batch items associated with this batch.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    batchResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/batch'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/batchRelationships'
        type:
          type: string
      type: object
      x-internal: false
    blockedNumberRelationships:
      type: object
    calendarEventAttendeeRelationships:
      properties:
        calendarEvent:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - calendarEvent
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    calendarEventRelationships:
      properties:
        acceptedEventInviteeId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
        account:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        accounts:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        booker:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The user who booked this event.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        calendar:
          description: The calendar associated with the event.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - calendar
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        calendarEventAttendees:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The attendees of the event.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the event.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        declinedEventInviteeId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
        kaiaCrmRecording:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The kaiaCrmRecording associated with the calendar event.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - kaiaCrmRecording
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        meeting:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - meeting
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        meetingType:
          description: The meeting type of the event.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - meetingType
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: The opportunity associated with the event.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - prospect
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        undecidedEventInviteeId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
        user:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The user associated with the calendar.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        users:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - user
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    calendarRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the calendar.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        meetingType:
          description: The default meeting type associated with this calendar.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - meetingType
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        schedule:
          description: The calendar schedule associated with this calendar.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - schedule
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the calendar.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user associated with the calendar.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    calendarUrlRelationships:
      type: object
    call:
      description: 'A log of an inbound or outbound call made with a prospect.

        '
      properties:
        answeredAt:
          description: '


            The date and time the call was answered.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        completedAt:
          description: '


            The date and time the call was completed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the call record was created in database. This does not necessarily indicate the time the call
            was made. If you need the time the call was made, please use either dialedAt or answeredAt.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        dialedAt:
          description: '


            The date and time the call was dialed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        direction:
          description: '


            The call direction from the user’s point of view; must be either "inbound" or "outbound".'
          nullable: true
          type: string
          x-internal: false
        externalVendor:
          description: '


            The voice provider of the call. Can be blank.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        from:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The phone number used to place the call.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        note:
          description: '


            A custom note associated with this call.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        outcome:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The call’s outcome; must be either "Answered" or "Not Answered".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        recordingUrl:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The URL of the call''s audio recording. This field only accepts HTTP and HTTPS values.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        returnedAt:
          description: '


            The date and time the call was returned.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        sequenceAction:
          description: '


            The action to take on the associated sequence; must be either "Advance", "Finish", "Finish - No Reply", or "Finish
            - Replied".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        shouldRecordCall:
          description: '


            Indicated whether or not the call is recorded.'
          nullable: true
          type: boolean
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The call’s current state.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stateChangedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the call’s state last changed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        tags:
          description: '


            A list of tag values associated with the call (e.g. ["Interested", "Meeting Booked"]).'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        to:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The phone number that the call was placed to.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        uid:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The Outreach voice trace id.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the call was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        userCallType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The type of call placed within the Outreach client; must be either "bridge" or "voip".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        vendorCallId:
          description: '


            The call-id as recorded by the voice provider. Can be blank.'
          maxLength: 63
          nullable: true
          type: string
          x-internal: false
        voicemailRecordingUrl:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The URL of the call’s voicemail audio recording.'
          maxLength: 1024
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    callDisposition:
      description: 'A ready-made collection of call dispositions that help categorize your call logs.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the call disposition was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The disposition’s name (e.g. "Meeting Scheduled").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The disposition’s display order within the collection.'
          nullable: true
          type: integer
          x-internal: false
        outcome:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The disposition’s call outcome; must be either "Answered" or "Not Answered".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the call disposition was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    callDispositionRelationships:
      properties:
        calls:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The calls made with this disposition. Relationship calls cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the call disposition. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    callDispositionResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/callDisposition'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/callDispositionRelationships'
        type:
          type: string
      type: object
      x-internal: false
    callPurpose:
      description: 'A ready-made collection of call purposes that help categorize your call logs.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the call purpose was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The purpose’s name (e.g. "Initial Contact").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The purpose’s display order within the collection.'
          nullable: true
          type: integer
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the call purpose was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    callPurposeRelationships:
      properties:
        calls:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The calls made with this purpose. Relationship calls cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the call purpose. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    callPurposeResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/callPurpose'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/callPurposeRelationships'
        type:
          type: string
      type: object
      x-internal: false
    callRelationships:
      properties:
        associatedId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated object for this call, either an account or opportunity. Relationship associatedId cannot be used
            as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        batches:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The batches associated with the call.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        callDisposition:
          description: The associated call disposition. You can use only the attribute id to filter calls by callDisposition
            (e.g. filter[callDisposition][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - callDisposition
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        callPurpose:
          description: The associated call purpose. You can use only the attribute id to filter calls by callPurpose (e.g.
            filter[callPurpose][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - callPurpose
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        kaiaCrmRecording:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The kaiaCrmRecording associated with the calendar event.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - kaiaCrmRecording
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: The associated opportunity. You can use only the attribute id to filter calls by opportunity (e.g.
            filter[opportunity][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        outboundVoicemail:
          description: The outbound voicemail message played to the callee's voicemail system.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - outboundVoicemail
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        phone:
          description: The associated phone of the user.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - phone
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        phoneNumber:
          description: The associated phone number of the prospect. You can use only the attribute id to filter calls by phoneNumber
            (e.g. filter[phoneNumber][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - phoneNumber
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The associated prospect. You can use only the attribute id to filter calls by prospect (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequence:
          description: The associated sequence. You can use only the attribute id to filter calls by sequence (e.g. filter[sequence][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceState:
          description: The associated sequence state. You can use only the attribute id to filter calls by sequenceState (e.g.
            filter[sequenceState][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceState
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStep:
          description: The associated sequence step. You can use only the attribute id to filter calls by sequenceStep (e.g.
            filter[sequenceStep][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        task:
          description: The associated task. You can use only the attribute id to filter calls by task (e.g. filter[task][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - task
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The associated user. You can use only the attribute id to filter calls by user (e.g. filter[user][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    callResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/call'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/callRelationships'
        type:
          type: string
      type: object
      x-internal: false
    complianceRequest:
      description: 'A regulatory request to delete or export an individual''s PII.

        '
      properties:
        batchComplianceRequestUuid:
          description: '


            The UUID of the batch the compliance request belongs to.'
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the compliance request was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        objectType:
          description: '


            The type of record to process, can be ''Prospect'' or ''Recipient'' for e-mail addresses unassociated with a prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        pii:
          description: '


            A JSON object of personal information required for processing the compliance request.'
          nullable: true
          type: object
          x-internal: false
        requestObjectId:
          description: '


            The identifier for the record processed, for Prospects this is the Prospect ID, for Recipients this is an e-mail
            address.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        requestType:
          description: '


            The type of compliance request (only ''Delete'' is supported at this time).'
          maxLength: 32
          nullable: true
          type: string
          x-internal: false
        requesterId:
          description: '


            The ID of the Outreach user who submitted the compliance request.'
          nullable: true
          type: integer
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The current state of the compliance request, can be ''pending'', ''running'', ''failed'', or ''done''. The states
            on the higher level abstraction, the batch compliance request, do not map 1:1 to these states. The only states
            that the batch compliance request will report are either ''pending'' or ''done''.'
          maxLength: 32
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time at which the compliance request was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        uuid:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The UUID of the compliance request.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    complianceRequestRelationships:
      properties:
        requester:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The Outreach user who submitted the compliance request. Relationship requester cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    complianceRequestResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/complianceRequest'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/complianceRequestRelationships'
        type:
          type: string
      type: object
      x-internal: false
    contentCategory:
      description: 'Content can be grouped into content categories to help discoverability.

        '
      properties:
        allowSequences:
          description: '


            Can this category be used to group sequences?'
          nullable: true
          type: boolean
          x-internal: false
        allowSnippets:
          description: '


            Can this category be used to group snippets?'
          nullable: true
          type: boolean
          x-internal: false
        allowTemplates:
          description: '


            Can this category be used to group templates?'
          nullable: true
          type: boolean
          x-internal: false
        color:
          description: '


            Color of the content category to be used as a background'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the content category was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the content category.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the content category was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    contentCategoryMembership:
      description: 'A record that maps content (e.g. a sequence) to a content category.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the content category membership was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the content category membership was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    contentCategoryMembershipRelationships:
      properties:
        content:
          description: The record in the content category. Must be a sequence, snippet, or template. Relationship content
            cannot be used as a filter.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  - snippet
                  - template
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        contentCategory:
          description: The content category the record is part of. You can use only the attribute id to filter contentCategoryMemberships
            by contentCategory (e.g. filter[contentCategory][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - contentCategory
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the content category membership. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    contentCategoryMembershipResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/contentCategoryMembership'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/contentCategoryMembershipRelationships'
        type:
          type: string
      type: object
      x-internal: false
    contentCategoryOwnership:
      description: 'A record that maps content categories to owners. This allows categories to be linked to one or more teams.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the content category ownership was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the content category ownership was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    contentCategoryOwnershipRelationships:
      properties:
        contentCategory:
          description: The content category the owner is linked to. You can use only the attribute id to filter contentCategoryOwnerships
            by contentCategory (e.g. filter[contentCategory][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - contentCategory
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the content category ownership. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The record the content category is tied to. Must a team for now. Relationship owner cannot be used
            as a filter.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    contentCategoryOwnershipResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/contentCategoryOwnership'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/contentCategoryOwnershipRelationships'
        type:
          type: string
      type: object
      x-internal: false
    contentCategoryRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the content category. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        teams:
          description: The teams the content category is assigned to.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    contentCategoryResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/contentCategory'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/contentCategoryRelationships'
        type:
          type: string
      type: object
      x-internal: false
    crmFieldPermissionRelationships:
      properties:
        crmProfile:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - crmProfile
                  type: string
              type: object
      type: object
    crmProfileRelationships:
      type: object
    currencyTypeRelationships:
      type: object
    customDuty:
      description: 'A freeform user-specified role or job duty played by a user in their organization.

        '
      properties:
        dutyType:
          description: '


            The polymorphic type of the duty (not the Ruby type, the duty type).'
          nullable: true
          type: string
          x-internal: false
        name:
          description: '


            The name of the role.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    customDutyRelationships:
      type: object
    customDutyResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/customDuty'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/customDutyRelationships'
        type:
          type: string
      type: object
      x-internal: false
    customValidationRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the custom validation.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the custom validation.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    datedConversionRateRelationships:
      type: object
    duty:
      description: 'An Outreach-suggested role or job duty played by a user in their organization.

        '
      properties:
        dutyType:
          description: '


            The polymorphic type of the duty (not the Ruby type, the duty type).'
          nullable: true
          type: string
          x-internal: false
        symbolicName:
          description: '


            The string constant used to refer to this duty which can be internationalized on the client.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    dutyRelationships:
      type: object
    dutyResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/duty'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/dutyRelationships'
        type:
          type: string
      type: object
      x-internal: false
    emailAddress:
      description: 'A prospect''s email address

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the email address was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        email:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The raw email address value'
          format: email
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        emailType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Type of email address (work or personal)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Ordered position in list of emails'
          nullable: true
          type: integer
          x-internal: false
        status:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The status of the email'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        statusChangedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            Time the status was updated'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        unsubscribedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            Time a mailing was unsubscribed using this address'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the email address was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    emailAddressRelationships:
      properties:
        prospect:
          description: The owning prospect You can use only the attribute id to filter emailAddresses by prospect (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    emailAddressResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/emailAddress'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/emailAddressRelationships'
        type:
          type: string
      type: object
      x-internal: false
    event:
      description: 'Application events, capturing details around the initiator, recipient, etc.

        '
      properties:
        body:
          description: '


            The event body (for external events only)'
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the event was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        eventAt:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the event occurred.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        externalUrl:
          description: '


            The external URL associated with this event (for external events only)'
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The name of the event that took place (e.g. "mailbox_created").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        payload:
          description: '


            The transmitted data for the event (cannot be updated once an event has been created)'
          nullable: true
          type: object
          x-internal: false
        requestCity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The city where the request that created the event was made.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        requestDevice:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The type of device on which the request that created the event was made.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        requestHost:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Name of the host from which the request was made.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        requestProxied:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A boolean value whether the request was proxied. For example, when true the request city refers to the location
            of the email server and not the prospect.'
          nullable: true
          type: boolean
          x-internal: false
        requestRegion:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Name of the region from which the request was made.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    eventRelationships:
      properties:
        account:
          description: The account associated with this event. You can use only the attribute id to filter events by account
            (e.g. filter[account][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        call:
          description: The call associated with this event. You can use only the attribute id to filter events by call (e.g.
            filter[call][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - call
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailing:
          description: The mailing associated with this event. You can use only the attribute id to filter events by mailing
            (e.g. filter[mailing][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailing
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        note:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The note associated with this event.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - note
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: The opportunity associated with this event. You can use only the attribute id to filter events by opportunity
            (e.g. filter[opportunity][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        plugin:
          description: The plugin associated with this event.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - plugin
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The prospect associated with this event. You can use only the attribute id to filter events by prospect
            (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequence:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence associated with this event.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStep:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence step associated with this event.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        task:
          description: The task associated with this event. You can use only the attribute id to filter events by task (e.g.
            filter[task][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - task
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user associated with this event. You can use only the attribute id to filter events by user (e.g.
            filter[user][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    eventResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/event'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/eventRelationships'
        type:
          type: string
      type: object
      x-internal: false
    experimentRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the experiment.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The user who owns the experiment.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceA:
          description: The "target" sequence, Sequence A, of this experiment. When the experiment is enabled, this sequence
            will be probabilistically replaced with the "alternate" sequence, Sequence B, based on the percentage attribute.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceB:
          description: The "alternate" sequence of this experiment.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    exportRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    externalRecordTypeRelationships:
      type: object
    favorite:
      description: 'A record (Prospect, Account, Sequence, etc.) favorited by a particular user.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the favorite was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        targetId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            The ID of record that was favorited.'
          nullable: true
          type: integer
          x-internal: false
        targetType:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            The type of record that was favorited.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the favorite was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    favoriteRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The user who created the favorite. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        target:
          description: The record that was favorited.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  - meetingType
                  - opportunity
                  - prospect
                  - sequence
                  - snippet
                  - team
                  - template
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user who's favorite this is. You can use only the attribute id to filter favorites by user (e.g.
            filter[user][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    favoriteResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/favorite'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/favoriteRelationships'
        type:
          type: string
      type: object
      x-internal: false
    featureFlagParticipationRelationships:
      properties:
        featureFlag:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - featureFlag
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    featureFlagRelationships:
      type: object
    gmailMessageMetadatumRelationships:
      properties:
        mailings:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - mailing
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    import:
      description: 'An operation that imports data into Outreach

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the import was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        dupeMethod:
          description: '


            The type of deduplication strategy, skip, missing or overwrite.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        dupes:
          description: '


            The number of dupes for the import.'
          nullable: true
          type: integer
          x-internal: false
        errorReason:
          description: '


            The reason for the failure of an import.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        externalId:
          description: '


            The ID of a Report in a CRM for ReportImport (is not related to external/external_input_payload)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        externalName:
          description: '


            The name of a Report in a CRM for ReportImport (is not related to external/external_input_payload)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        externalType:
          description: '


            The Type of a Report in a CRM for ReportImport (is not related to external/external_input_payload)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        failures:
          description: '


            The total number of failures associated with this import.'
          nullable: true
          type: integer
          x-internal: false
        fileName:
          description: '


            The file name for the import.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        fileSize:
          description: '


            The size of the file for the import'
          nullable: true
          type: integer
          x-internal: false
        frequency:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The frequency an import will recur on (once, hourly, daily)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        importType:
          description: '


            The type of import.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        loadFromPlugin:
          description: '


            Indicates if the import leverages load_from_crm or is a ReportImport'
          nullable: true
          type: boolean
          x-internal: false
        mappings:
          description: '


            The mapping of rows to properties of the item.'
          nullable: true
          type: object
          x-internal: false
        pluginId:
          description: '


            The ID of the Outreach Plugin powering the load_from_crm or ReportImport functionality'
          nullable: true
          type: integer
          x-internal: false
        prospectOwnerId:
          description: '


            Owner ID to override during import (applies to prospects, accounts, and opportunities)'
          nullable: true
          type: integer
          x-internal: false
        recurring:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            Whether or not the import is a recurring import'
          nullable: true
          type: boolean
          x-internal: false
        reportInstanceId:
          description: '


            The ID of the salesforce report import'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        scheduledAt:
          description: '


            The next scheduled run for a recurring import'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        source:
          description: '


            Source to override during prospect import'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stageId:
          description: '


            Stage ID to override to during import'
          nullable: true
          type: integer
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The state of the import.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stateChangedAt:
          description: '


            Indicates the last mutation to the state field'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        syncedUntil:
          description: '


            The point in time this report is synced to'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        timeZone:
          description: '


            TimeZone to override during prospect import'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        total:
          description: '


            The total number of items associated with this import.'
          nullable: true
          type: integer
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the import was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    importRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    importResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/import'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/importRelationships'
        type:
          type: string
      type: object
      x-internal: false
    inboxSettingRelationships:
      properties:
        user:
          description: The associated user to whom this settings belong.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    jobRoleRelationships:
      type: object
    kaiaCrmRecordingRelationships:
      properties:
        account:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated opportunity. You can use only the attribute id to filter mailings by opportunity (e.g. filter[opportunity][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The user associated with the calendar.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The account''s associated prospects. Relationship prospects cannot be used as a filter.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - prospect
                    type: string
                type: object
              type: array
      type: object
    kaiaRecording:
      description: ''
      properties:
        botInMeetingSeconds:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            Time the recording bot spent in the meeting, in seconds (calculated from endTime - startTime)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The creation timestamp of the recording (ISO 8601)'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        endTime:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The end time of the recording (ISO 8601)'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        format:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            The recording format: meeting or call'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        host:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Meeting host/organizer with full participant info'
          nullable: true
          type: object
          x-internal: false
        instanceId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            The unique instance identifier (UUID) for the recording'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        mediaDurationSeconds:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            Actual media duration in seconds, extracted from the video file. Null if unavailable.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        participantCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of participants in the recording'
          nullable: true
          type: integer
          x-internal: false
        participants:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Polymorphic array of meeting participants with type (user/prospect/external), id, displayName, etc.'
          items:
            type: object
          nullable: true
          type: array
          x-internal: false
        provider:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            The meeting provider (zoom, teams, etc.)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        recordingUrl:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            URL to view the recording'
          maxLength: 2048
          nullable: true
          type: string
          x-internal: false
        sourceId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            Source ID from originating system. format=call: Call ID for /api/v2/calls. format=meeting: calendar event ID.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        startTime:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The start time of the recording (ISO 8601)'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            Recording state: UNKNOWN, CREATED, STARTED, ENDED, DROPPED, or DELETED'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        title:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Recording title (may be null for untitled meetings)'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        topics:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Aggregated topics discussed in the recording. Hidden by default; request explicitly.'
          items:
            type: object
          nullable: true
          type: array
          x-internal: false
        transcriptUrl:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Self-authenticating URL to fetch transcript JSON (2-hour expiry). Hidden field.'
          maxLength: 4096
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The last update timestamp (ISO 8601). Use for incremental sync with filter[updatedAt]>='
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    kaiaRecordingRelationships:
      properties:
        account:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The account associated with the recording'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The opportunity associated with the recording'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The recording owner/organizer'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    kaiaRecordingResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/kaiaRecording'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/kaiaRecordingRelationships'
        type:
          type: string
      type: object
      x-internal: false
    kaiaVoiceImport:
      description: 'Import third party recording. Prerequisite is CreateCall API should be called before.

        '
      properties:
        callId:
          description: '


            Required: call_id from Create Call Record API.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        instanceId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Unique identifier for the voice import instance.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        metadata:
          description: '


            Optional: partner metadata in JSON format. We support dual channel audio input for now, where channel 0 is buyer,
            and channel 1 is seller by default. For example, {"sellerChannel":0}. If sellerChannel = 1, it is default and
            metadata can be empty.'
          maxLength: 4096
          nullable: true
          type: string
          x-internal: false
        recordingUrl:
          description: '


            Required: signed recording URL. The recording URL in import request should be valid for at least 8 hours'
          maxLength: 1024
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    kaiaVoiceImportRelationships:
      type: object
    kaiaVoiceImportResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/kaiaVoiceImport'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/kaiaVoiceImportRelationships'
        type:
          type: string
      type: object
      x-internal: false
    mailAlias:
      description: 'Alternative email name for a mailbox.

        '
      properties:
        canSend:
          description: '


            Can this alias send email.'
          nullable: true
          type: boolean
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date the alias was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        email:
          description: '


            The email alias.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        emailHash:
          description: '


            Hashed email address of the alias.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date the alias was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    mailAliasRelationships:
      properties:
        mailbox:
          description: The parent mailbox for this alias. You can use only the attribute id to filter mailAliases by mailbox
            (e.g. filter[mailbox][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailbox
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    mailAliasResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/mailAlias'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/mailAliasRelationships'
        type:
          type: string
      type: object
      x-internal: false
    mailbox:
      description: 'A representation of an email mailbox, used within the application for sending and syncing emails.

        '
      properties:
        authId:
          description: '


            The auth id associated with the mailbox.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the mailbox was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        editable:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A boolean value to indicate if the user has the permission to edit mailbox fields.'
          nullable: true
          type: boolean
          x-internal: false
        email:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The email address of the mailbox.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        emailHash:
          description: '


            Hashed email address of the mailbox.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        emailProvider:
          description: '


            The mail service provider. While not a required field, it is strongly recommended to use one of ''exchange_online'',
            ''exchange_server'', ''gmail'', ''gmail_api'', ''google_oauth2'', ''intermedia'', ''office365_oauth2'', ''microsoft_hma_oauth2'',
            ''office_365'', ''rackspace''. If no value is provided, send and sync will make assumptions based on the ews,
            imap, and smtp values provided.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        emailSignature:
          description: '


            The default signature, in HTML, to be appended to sent email messages.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        ewsEndpoint:
          description: '


            The url of the Exchange Web Service.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        ewsSslVerifyMode:
          description: '


            The SSL verify mode, represented as an integer, the EWS connection will used. (verify none=0, verify peer=1, verify
            client once=4, verify fail if no peer cert=2)'
          nullable: true
          type: integer
          x-internal: false
        exchangeVersion:
          description: '


            The version of Exchange. Must be one of ''Exchange2007'', ''Exchange2007_SP1'', ''Exchange2010'', ''Exchange2010_SP1'',
            ''Exchange2010_SP2'', ''Exchange2013'', ''Exchange2013_SP1''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        imapHost:
          description: '


            The address of the IMAP host, used for syncing (e.g. ''imap.gmail.com'').'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        imapPort:
          description: '


            The port number the IMAP server is using (e.g. ''993'').'
          nullable: true
          type: integer
          x-internal: false
        imapSsl:
          description: '


            A boolean value whether the IMAP connection will use SSL.'
          nullable: true
          type: boolean
          x-internal: false
        maxEmailsPerDay:
          description: '


            The maximum number of in/out emails per day.'
          nullable: true
          type: integer
          x-internal: false
        maxMailingsPerDay:
          description: '


            The maximum number of emails the application can send in a day from this mailbox. Recommended value is 500.'
          nullable: true
          type: integer
          x-internal: false
        maxMailingsPerWeek:
          description: '


            The maximum number of emails the application can send within a week from this mailbox. Recommended value is 5000.'
          nullable: true
          type: integer
          x-internal: false
        optOutMessage:
          description: '


            The message displayed on the unsubscribe confirmation page, seen after clicking the unsubscribe link in the email
            (e.g. "To unsubscribe, click the button below.").'
          maxLength: 512
          nullable: true
          type: string
          x-internal: false
        optOutSignature:
          description: '


            The message below the signature, in HTML, when the sequence requires an unsubscribe link (e.g. "If you''d like
            me to stop sending you emails, please `<a href=''%unsubscribe_url%''>click here</a>`").'
          maxLength: 512
          nullable: true
          type: string
          x-internal: false
        password:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            The password of the mailbox. This attribute can be used to set the password, but is not available for read.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        prospectEmailExclusions:
          description: '


            A list (provided as a string, newline-delimited) of email address patterns to be excluded from syncing (e.g. "`*@outreach.io

            daniel@example.com`").'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        providerId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The id of the provider associated with this calendar.'
          nullable: true
          type: integer
          x-internal: false
        providerType:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Email provider type.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        sendDisabled:
          description: '


            A boolean value whether sending is disabled from this mailbox.'
          nullable: true
          type: boolean
          x-internal: false
        sendErroredAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the most recent send error occurred.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        sendMaxRetries:
          description: '


            The maximum number of times to auto-retry a delivery when it fails.'
          nullable: true
          type: integer
          x-internal: false
        sendMethod:
          description: '


            The method used for sending email. Must be either ''ews'', ''sendgrid'', or ''smtp''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        sendPeriod:
          description: '


            The amount of time in seconds that the number of sendThreshold emails can be sent. Recommended value is two deliveries
            per minute (sendPeriod is 60).'
          nullable: true
          type: integer
          x-internal: false
        sendRequiresSync:
          description: '


            A boolean value whether the mailbox is required to be recently synced before sending.'
          nullable: true
          type: boolean
          x-internal: false
        sendSuccessAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the most recent successful email send occurred.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        sendThreshold:
          description: '


            The maximum number of email sends per the sendPeriod amount of time. Recommended value is two deliveries per minute
            (sendThreshold is 2).'
          nullable: true
          type: integer
          x-internal: false
        sendgridApiKey:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            The api key of the SendGrid account used for sending.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        sendgridWebhookUrl:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The endpoint required within the SendGrid account settings to support bounce and spam-report tracking.'
          nullable: true
          type: string
          x-internal: false
        smtpHost:
          description: '


            The address of the SMTP host, used for sending (e.g. ''smtp.gmail.com'').'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        smtpPassword:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            The password for the SMTP account. This value should be left blank unless a separate SMTP account is being used
            for sending (i.e. not the mailbox''s main username/password).'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        smtpPort:
          description: '


            The port number the SMTP server is using (e.g. ''587'').'
          nullable: true
          type: integer
          x-internal: false
        smtpSsl:
          description: '


            A boolean value whether the SMTP connection will use SSL.'
          nullable: true
          type: boolean
          x-internal: false
        smtpUsername:
          description: '


            The username for the SMTP account. This value should be left blank unless a separate SMTP account is being used
            for sending (i.e. not the mailbox''s main username/password).'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        syncActiveFrequency:
          description: '


            The amount of time in seconds between syncing when the user is actively using the application.'
          nullable: true
          type: integer
          x-internal: false
        syncDisabled:
          description: '


            A boolean value whether syncing is disabled from this mailbox.'
          nullable: true
          type: boolean
          x-internal: false
        syncErroredAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the most recent sync error occurred.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        syncFinishedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the most recent sync finished.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        syncMethod:
          description: '


            The method used for syncing email. Must be either ''ews'', ''gmail_api'', or ''imap''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        syncOutreachFolder:
          description: '


            A boolean value whether the folder for syncing is named ''Outreach'' instead of ''Inbox''. Only available for
            Exchange version ''Exchange2007_SP1''.'
          nullable: true
          type: boolean
          x-internal: false
        syncPassiveFrequency:
          description: '


            The amount of time in seconds between syncing when the user is not actively using the application.'
          nullable: true
          type: integer
          x-internal: false
        syncSuccessAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the most recent successful email sync occurred.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the mailbox was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        userId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The id of the user associated with this mailbox.'
          nullable: true
          type: integer
          x-internal: false
        username:
          description: '


            The username of the email account. While not a required field, a username is necessary for most email providers
            outside of OAuth. This value is normally the same as the email address.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        validateSend:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            If this is set to true then the record will only save successfully if the mailbox is properly configured to send
            emails.'
          nullable: true
          type: boolean
          x-internal: false
        validateSync:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            If this is set to true then the record will only save successfully if the mailbox is properly configured to sync
            emails.'
          nullable: true
          type: boolean
          x-internal: false
      type: object
      x-internal: false
    mailboxContactRelationships:
      properties:
        mailbox:
          description: The mailbox associated with this contact.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailbox
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    mailboxRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the mailbox. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailAliases:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The email aliases associated with this mailbox Relationship mailAliases cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The mailings sent via this mailbox. Relationship mailings cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the mailbox. Relationship updater cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user owning this mailbox. You can use only the attribute id to filter mailboxes by user (e.g. filter[user][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    mailboxResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/mailbox'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/mailboxRelationships'
        type:
          type: string
      type: object
      x-internal: false
    mailing:
      description: 'A representation of a platform-related email.

        '
      properties:
        bodyHtml:
          description: '


            The mailing''s custom email body, represented in HTML. If provided this field will override any associated template.'
          nullable: true
          type: string
          x-internal: false
        bodyText:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The plain-text representation of the ''bodyHTML'' field.'
          nullable: true
          type: string
          x-internal: false
        bouncedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the email was bounced.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        clickCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total number of times links within the email were clicked (if the message is tracking links).'
          nullable: true
          type: integer
          x-internal: false
        clickedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The most recent date and time a link was clicked (if the message is tracking links).'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the mailing was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        deliveredAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the email was delivered.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        errorBacktrace:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Technical details explaining the mailing''s error.'
          nullable: true
          type: string
          x-internal: false
        errorReason:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A summary explaining the mailing''s error.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        followUpTaskScheduledAt:
          description: '


            The date and time of when a follow-up task should be due for this mailing.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        followUpTaskType:
          description: '


            The type of follow-up task to create. Possible values are ''follow_up'' or ''no_reply''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        mailboxAddress:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The email address the mailing was sent from.'
          nullable: true
          type: string
          x-internal: false
        mailingType:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            A description of the type of the emailing (e.g. "sequence", "single", "campaign").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        markedAsSpamAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the email was marked as spam.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        messageId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The MIME content Message-ID of the delivered message.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        notifyThreadCondition:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The condition of when to bump this mailing to the top of the user''s inbox. Possible values are ''always'' or
            ''no_reply''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        notifyThreadScheduledAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time of when this mailing should be bumped to the top of the user''s inbox.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        notifyThreadStatus:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The status of the bump. Possible values are ''pending'', ''sent'' or ''skipped''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        openCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total number of times the email was opened (if the message is tracking opens).'
          nullable: true
          type: integer
          x-internal: false
        openedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The most recent date and time the email was opened (if the message is tracking opens).'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        overrideSafetySettings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A boolean value whether users can override submission if template variables have not all been replaced.'
          nullable: true
          type: boolean
          x-internal: false
        references:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A list of references for the mailing taken from the email header.'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        repliedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the email was replied to.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        retryAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the email will rety to send.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        retryCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of times the email has been retried to send.'
          nullable: true
          type: integer
          x-internal: false
        retryInterval:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The amount of time in seconds between retry attempts.'
          nullable: true
          type: integer
          x-internal: false
        scheduledAt:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the email is scheduled to send.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The current state of the mailing. Can be ''bounced'', ''delivered'', ''delivering'', ''drafted'', ''failed'',
            ''opened'', ''placeholder'', ''queued'', ''replied'', or ''scheduled''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stateChangedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the state last changed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        subject:
          description: '


            The subject line of the email.'
          nullable: true
          type: string
          x-internal: false
        trackLinks:
          description: '


            A boolean value whether the mailing is tracking link clicks.'
          nullable: true
          type: boolean
          x-internal: false
        trackOpens:
          description: '


            A boolean value whether the mailing is tracking email opens.'
          nullable: true
          type: boolean
          x-internal: false
        unsubscribedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the recepient unsubscribed from the mailing''s sequence.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the mailing was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    mailingRelationships:
      properties:
        attachments:
          description: All attachments attached to this mailing.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - attachment
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        bccEntitiesId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
        calendar:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The calendar associated with any event invites contained in this mailing.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - calendar
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        ccEntitiesId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
        followUpSequence:
          description: The followup sequence associated with this mailing. You can use only the attribute id to filter mailings
            by followUpSequence (e.g. filter[followUpSequence][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailbox:
          description: The mailbox associated with this mailing. You can use only the attribute id to filter mailings by mailbox
            (e.g. filter[mailbox][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailbox
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated opportunity. You can use only the attribute id to filter mailings by opportunity (e.g. filter[opportunity][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The prospect associated with this mailing. You can use only the attribute id to filter mailings by
            prospect (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospectsIds:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
        recipients:
          description: Recipients of the mailing. Relationship recipients cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - recipient
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        schedule:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - schedule
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequence:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence. You can use only the attribute id to filter mailings by sequence (e.g. filter[sequence][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceState:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence state. You can use only the attribute id to filter mailings by sequenceState (e.g. filter[sequenceState][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceState
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStep:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence step. You can use only the attribute id to filter mailings by sequenceStep (e.g. filter[sequenceStep][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        task:
          description: The task this mailing will or did complete upon sending. You can use only the attribute id to filter
            mailings by task (e.g. filter[task][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - task
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            All tasks associated with this mailing, such as a follow-up task. Relationship tasks cannot be used as a filter.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - task
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        template:
          description: The template associated with this mailing. You can use only the attribute id to filter mailings by
            template (e.g. filter[template][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - template
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        toEntitiesId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
        user:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The user associated with this mailing. You can use only the attribute id to filter mailings by user (e.g. filter[user][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    mailingResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/mailing'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/mailingRelationships'
        type:
          type: string
      type: object
      x-internal: false
    meetingFieldRelationships:
      type: object
    meetingRelationships:
      properties:
        meetingAttendees:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - calendarEventAttendee
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        primaryEvent:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - calendarEvent
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    meetingTypeRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the meeting type.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The user who owns this meeting type.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        team:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    messengerGroupRelationships:
      properties:
        user:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated user.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    modelSchemaVersionRelationships:
      type: object
    noteRelationships:
      properties:
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    opportunity:
      description: 'An opportunity for a sale or pending deal. Requires the Opportunities SKU to be enabled in order to have
        access. Please contact support for more assistance.

        '
      properties:
        amount:
          description: '<img src=https://developers.outreach.io/badges/sortable.svg>


            The amount the opportunity is worth.'
          nullable: true
          type: integer
          x-internal: false
        amountPrecise:
          description: '<img src=https://developers.outreach.io/badges/sortable.svg>


            The precise amount that the opportunity is worth.'
          maxLength: 15
          nullable: true
          type: string
          x-internal: false
        closeDate:
          description: '<img src=https://developers.outreach.io/badges/sortable.svg>


            The date the opportunity is expected to close.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date the opportunity was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        currencyType:
          description: '


            The ISO code of the currency this opportunity is in.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        custom1:
          description: '


            The value of the opportunity''s first custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom2:
          description: '


            The value of the opportunity''s second custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom3:
          description: '


            The value of the opportunity''s third custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom4:
          description: '


            The value of the opportunity''s fourth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom5:
          description: '


            The value of the opportunity''s fifth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom6:
          description: '


            The value of the opportunity''s sixth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom7:
          description: '


            The value of the opportunity''s seventh custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom8:
          description: '


            The value of the opportunity''s eighth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom9:
          description: '


            The value of the opportunity''s ninth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom10:
          description: '


            The value of the opportunity''s 10th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom11:
          description: '


            The value of the opportunity''s 11th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom12:
          description: '


            The value of the opportunity''s 12th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom13:
          description: '


            The value of the opportunity''s 13th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom14:
          description: '


            The value of the opportunity''s 14th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom15:
          description: '


            The value of the opportunity''s 15th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom16:
          description: '


            The value of the opportunity''s 16th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom17:
          description: '


            The value of the opportunity''s 17th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom18:
          description: '


            The value of the opportunity''s 18th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom19:
          description: '


            The value of the opportunity''s 19th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom20:
          description: '


            The value of the opportunity''s 20th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom21:
          description: '


            The value of the opportunity''s 21st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom22:
          description: '


            The value of the opportunity''s 22nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom23:
          description: '


            The value of the opportunity''s 23rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom24:
          description: '


            The value of the opportunity''s 24th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom25:
          description: '


            The value of the opportunity''s 25th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom26:
          description: '


            The value of the opportunity''s 26th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom27:
          description: '


            The value of the opportunity''s 27th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom28:
          description: '


            The value of the opportunity''s 28th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom29:
          description: '


            The value of the opportunity''s 29th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom30:
          description: '


            The value of the opportunity''s 30th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom31:
          description: '


            The value of the opportunity''s 31st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom32:
          description: '


            The value of the opportunity''s 32nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom33:
          description: '


            The value of the opportunity''s 33rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom34:
          description: '


            The value of the opportunity''s 34th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom35:
          description: '


            The value of the opportunity''s 35th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom36:
          description: '


            The value of the opportunity''s 36th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom37:
          description: '


            The value of the opportunity''s 37th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom38:
          description: '


            The value of the opportunity''s 38th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom39:
          description: '


            The value of the opportunity''s 39th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom40:
          description: '


            The value of the opportunity''s 40th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom41:
          description: '


            The value of the opportunity''s 41st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom42:
          description: '


            The value of the opportunity''s 42nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom43:
          description: '


            The value of the opportunity''s 43rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom44:
          description: '


            The value of the opportunity''s 44th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom45:
          description: '


            The value of the opportunity''s 45th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom46:
          description: '


            The value of the opportunity''s 46th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom47:
          description: '


            The value of the opportunity''s 47th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom48:
          description: '


            The value of the opportunity''s 48th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom49:
          description: '


            The value of the opportunity''s 49th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom50:
          description: '


            The value of the opportunity''s 50th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom51:
          description: '


            The value of the opportunity''s 51st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom52:
          description: '


            The value of the opportunity''s 52nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom53:
          description: '


            The value of the opportunity''s 53rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom54:
          description: '


            The value of the opportunity''s 54th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom55:
          description: '


            The value of the opportunity''s 55th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom56:
          description: '


            The value of the opportunity''s 56th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom57:
          description: '


            The value of the opportunity''s 57th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom58:
          description: '


            The value of the opportunity''s 58th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom59:
          description: '


            The value of the opportunity''s 59th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom60:
          description: '


            The value of the opportunity''s 60th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom61:
          description: '


            The value of the opportunity''s 61st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom62:
          description: '


            The value of the opportunity''s 62nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom63:
          description: '


            The value of the opportunity''s 63rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom64:
          description: '


            The value of the opportunity''s 64th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom65:
          description: '


            The value of the opportunity''s 65th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom66:
          description: '


            The value of the opportunity''s 66th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom67:
          description: '


            The value of the opportunity''s 67th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom68:
          description: '


            The value of the opportunity''s 68th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom69:
          description: '


            The value of the opportunity''s 69th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom70:
          description: '


            The value of the opportunity''s 70th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom71:
          description: '


            The value of the opportunity''s 71st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom72:
          description: '


            The value of the opportunity''s 72nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom73:
          description: '


            The value of the opportunity''s 73rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom74:
          description: '


            The value of the opportunity''s 74th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom75:
          description: '


            The value of the opportunity''s 75th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom76:
          description: '


            The value of the opportunity''s 76th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom77:
          description: '


            The value of the opportunity''s 77th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom78:
          description: '


            The value of the opportunity''s 78th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom79:
          description: '


            The value of the opportunity''s 79th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom80:
          description: '


            The value of the opportunity''s 80th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom81:
          description: '


            The value of the opportunity''s 81st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom82:
          description: '


            The value of the opportunity''s 82nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom83:
          description: '


            The value of the opportunity''s 83rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom84:
          description: '


            The value of the opportunity''s 84th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom85:
          description: '


            The value of the opportunity''s 85th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom86:
          description: '


            The value of the opportunity''s 86th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom87:
          description: '


            The value of the opportunity''s 87th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom88:
          description: '


            The value of the opportunity''s 88th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom89:
          description: '


            The value of the opportunity''s 89th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom90:
          description: '


            The value of the opportunity''s 90th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom91:
          description: '


            The value of the opportunity''s 91st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom92:
          description: '


            The value of the opportunity''s 92nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom93:
          description: '


            The value of the opportunity''s 93rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom94:
          description: '


            The value of the opportunity''s 94th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom95:
          description: '


            The value of the opportunity''s 95th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom96:
          description: '


            The value of the opportunity''s 96th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom97:
          description: '


            The value of the opportunity''s 97th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom98:
          description: '


            The value of the opportunity''s 98th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom99:
          description: '


            The value of the opportunity''s 99th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom100:
          description: '


            The value of the opportunity''s 100th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom101:
          description: '


            The value of the opportunity’s 101st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom102:
          description: '


            The value of the opportunity’s 102nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom103:
          description: '


            The value of the opportunity’s 103rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom104:
          description: '


            The value of the opportunity’s 104th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom105:
          description: '


            The value of the opportunity’s 105th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom106:
          description: '


            The value of the opportunity’s 106th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom107:
          description: '


            The value of the opportunity’s 107th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom108:
          description: '


            The value of the opportunity’s 108th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom109:
          description: '


            The value of the opportunity’s 109th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom110:
          description: '


            The value of the opportunity’s 110th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom111:
          description: '


            The value of the opportunity’s 111th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom112:
          description: '


            The value of the opportunity’s 112th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom113:
          description: '


            The value of the opportunity’s 113th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom114:
          description: '


            The value of the opportunity’s 114th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom115:
          description: '


            The value of the opportunity’s 115th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom116:
          description: '


            The value of the opportunity’s 116th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom117:
          description: '


            The value of the opportunity’s 117th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom118:
          description: '


            The value of the opportunity’s 118th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom119:
          description: '


            The value of the opportunity’s 119th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom120:
          description: '


            The value of the opportunity’s 120th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom121:
          description: '


            The value of the opportunity’s 121st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom122:
          description: '


            The value of the opportunity’s 122nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom123:
          description: '


            The value of the opportunity’s 123rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom124:
          description: '


            The value of the opportunity’s 124th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom125:
          description: '


            The value of the opportunity’s 125th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom126:
          description: '


            The value of the opportunity’s 126th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom127:
          description: '


            The value of the opportunity’s 127th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom128:
          description: '


            The value of the opportunity’s 128th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom129:
          description: '


            The value of the opportunity’s 129th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom130:
          description: '


            The value of the opportunity’s 130th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom131:
          description: '


            The value of the opportunity’s 131st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom132:
          description: '


            The value of the opportunity’s 132nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom133:
          description: '


            The value of the opportunity’s 133rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom134:
          description: '


            The value of the opportunity’s 134th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom135:
          description: '


            The value of the opportunity’s 135th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom136:
          description: '


            The value of the opportunity’s 136th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom137:
          description: '


            The value of the opportunity’s 137th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom138:
          description: '


            The value of the opportunity’s 138th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom139:
          description: '


            The value of the opportunity’s 139th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom140:
          description: '


            The value of the opportunity’s 140th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom141:
          description: '


            The value of the opportunity’s 141st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom142:
          description: '


            The value of the opportunity’s 142nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom143:
          description: '


            The value of the opportunity’s 143rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom144:
          description: '


            The value of the opportunity’s 144th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom145:
          description: '


            The value of the opportunity’s 145th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom146:
          description: '


            The value of the opportunity’s 146th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom147:
          description: '


            The value of the opportunity’s 147th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom148:
          description: '


            The value of the opportunity’s 148th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom149:
          description: '


            The value of the opportunity’s 149th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom150:
          description: '


            The value of the opportunity’s 150th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        customId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A custom ID for the opportunity, often referencing an ID in an external system.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        description:
          description: '


            A description of the opportunity.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        externalCreatedAt:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The date the opportunity was created in the external system.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        externalUpdatedAt:
          description: '


            The date the opportunity was last updated in the external system.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        forecastCategory:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The category or classification used to predict the likelihood of closing an opportunity.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        leadSource:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Source of this opportunity, such as Advertisement or Trade Show'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        lostReason:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The reason why an opportunity or deal was lost.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        mapLink:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        mapNextSteps:
          description: '


            The next event in the timeline that has yet to be completed for the SamePlan MAP (Mutual Action Plan).'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        mapStatus:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the opportunity.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        nextStep:
          description: '


            The next step to take for the opportunity.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        opportunityType:
          description: '


            The type of opportunity.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        probability:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The chances of the opportunity succeeding, represented as a percentage.'
          nullable: true
          type: integer
          x-internal: false
        prospectingRepId:
          description: '


            The ID of the sales rep that prospects the opportunity.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        recordType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The type or category of the record, such as Opportunity, Lead, or Deal, used to classify and organize different
            stages in the sales process'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        sharingTeamId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The ID of the sharing team associated with this object. Access is currently in beta.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        tags:
          description: '


            Tags associated with the opportunity.'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        touchedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The last time an event happened for an opportunity.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        trashedAt:
          description: '


            The date a prospect was soft deleted.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date the opportunity was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    opportunityFieldHistoryRelationships:
      type: object
    opportunityHealthFactorRelationships:
      properties:
        opportunity:
          description: The opportunity the health factor apply to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    opportunityHistoryRelationships:
      type: object
    opportunityLineItemRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        externalCreator:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    opportunityProspectRole:
      description: 'A prospect''s role and association with an opportunity

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the role was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        primary:
          description: '


            A boolean value indicating if this prospect is the primary contact within an opportunity.'
          nullable: true
          type: boolean
          x-internal: false
        role:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A string value representing the role.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the role was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    opportunityProspectRoleRelationships:
      properties:
        opportunity:
          description: The opportunity associated with the role. You can use only the attribute id to filter opportunityProspectRoles
            by opportunity (e.g. filter[opportunity][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The prospect associated with the role. You can use only the attribute id to filter opportunityProspectRoles
            by prospect (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    opportunityProspectRoleResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/opportunityProspectRole'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/opportunityProspectRoleRelationships'
        type:
          type: string
      type: object
      x-internal: false
    opportunityRelationships:
      properties:
        account:
          description: The account the opportunity is for. You can use attributes id and name to filter opportunities by account
            (e.g. filter[account][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        assignedTeams:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        assignedUsers:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - user
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the opportunity. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        defaultPluginMapping:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The default plugin mapping associated with the opportunity. If no plugin mapping is enabled, it will return the
            first plugin mapping associated with the opportunity.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - pluginMapping
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        externalCreator:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        favorites:
          description: The opportunity favorited by the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - favorite
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunityHealthFactors:
          description: The factors related to the opportunities health.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - opportunityHealthFactor
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunityLineItems:
          description: The products associated with opportunity.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - opportunityLineItem
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunityStage:
          description: The current stage of the opportunity. You can use only the attribute id to filter opportunities by
            stage (e.g. filter[stage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunityStage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The user who owns the opportunity. You can use only the attribute id to filter opportunities by owner
            (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        primaryProspect:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The prospects associated with this opportunity. You can use only the attribute id to filter opportunities by prospects
            (e.g. filter[prospects][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        stage:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The current stage of the opportunity. You can use only the attribute id to filter opportunities by stage (e.g.
            filter[stage][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunityStage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        territory:
          description: The territory of the opportunity. You can use attributes id and name to filter opportunities by territory
            (e.g. filter[territory][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - territory
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The updater of the opportunity. Relationship updater cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    opportunityResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/opportunity'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/opportunityRelationships'
        type:
          type: string
      type: object
      x-internal: false
    opportunitySplitFieldHistoryRelationships:
      type: object
    opportunitySplitRelationships:
      properties:
        opportunity:
          description: Related opportunity for this split
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        splitOwner:
          description: User who owns this split
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        splitType:
          description: Type of this opportunity split
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunitySplitType
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    opportunitySplitTypeRelationships:
      type: object
    opportunityStage:
      description: 'The stage an opportunity is in. Requires the Opportunities SKU to be enabled in order to have access.
        Please contact support for more assistance.

        '
      properties:
        color:
          description: '


            The color used to label and highlight the opportunity stage.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the opportunity stage was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        isClosed:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Either true or flase, whether or not the opportunity stage represents an open or closed state of an opportunity.'
          nullable: true
          type: boolean
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the opportunity stage.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The order of the opportunity stage.'
          nullable: true
          type: integer
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the opportunity stage was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    opportunityStageRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the opportunity. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunities:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The opportunities currently associated with the opportunity stage. Relationship opportunities cannot be used as
            a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    opportunityStageResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/opportunityStage'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/opportunityStageRelationships'
        type:
          type: string
      type: object
      x-internal: false
    opportunityTeamMembershipRelationships:
      properties:
        jobRole:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - jobRole
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        team:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The team associated with the team membership.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user associated with the team membership.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    orgSetting:
      description: 'The collection of settings for an Org.

        '
      properties:
        contactExclusions:
          description: '


            Comma separated list of contact email addresses that are blocked.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        prospectEmailExclusions:
          description: '


            Comma separated list of prospect email addresses blocked'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        sendExclusions:
          description: '


            Comma separated list of email addresses that are blocked'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    orgSettingRelationships:
      type: object
    orgSettingResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/orgSetting'
        id:
          description: As a UUID
          type: string
        relationships:
          $ref: '#/components/schemas/orgSettingRelationships'
        type:
          type: string
      type: object
      x-internal: false
    outboundVoicemailRelationships:
      properties:
        user:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    outlookAddInEwsItemRelationships:
      properties:
        mailbox:
          description: The mailbox this originated from
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailbox
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    permissionGrantRelationships:
      type: object
    persona:
      description: 'A descriptor of a person, used for categorizing Prospects.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the persona was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        description:
          description: '


            A description of the persona.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the persona (e.g. "Sales Rep").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the persona was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    personaRelationships:
      properties:
        prospects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The prospects with this persona. Relationship prospects cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    personaResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/persona'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/personaRelationships'
        type:
          type: string
      type: object
      x-internal: false
    phoneIdentityRelationships:
      properties:
        owner:
          description: The owner of this identity.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    phoneNumber:
      description: 'A prospect''s phone number

        '
      properties:
        countryCode:
          description: '


            The country code (e.g. US)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the phone number was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        extension:
          description: '


            Phone number extension (e.g. 123)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        number:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The phone number (e.g. +18889387356)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Ordered position in list of numbers'
          nullable: true
          type: integer
          x-internal: false
        phoneType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Type of phone (mobile, work, home, voip, and other)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        rawNumber:
          description: '


            Unformatted phone number'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        status:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The status of the number'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        statusChangedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            Time the status was updated'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the phone number was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    phoneNumberPredictionRelationships:
      properties:
        referralPrediction:
          description: The referral prediction this phone number belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - referralPrediction
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    phoneNumberRelationships:
      properties:
        prospect:
          description: The owning prospect You can use only the attribute id to filter phoneNumbers by prospect (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    phoneNumberResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/phoneNumber'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/phoneNumberRelationships'
        type:
          type: string
      type: object
      x-internal: false
    phoneRelationships:
      properties:
        address:
          description: The Address this phone belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - address
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        batches:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The batches associated with the phone.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        phoneIdentity:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - phoneIdentity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The User this phone belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    pluginErrorLogPreSignedUrlRelationships:
      type: object
    pluginMappingRelationships:
      properties:
        plugin:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - plugin
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    pluginRelationships:
      type: object
    product:
      description: 'Contains all the list of products and maintained by the admin.

        '
      properties:
        classification:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The Type of Product. Options Include: Own, Competitor, Complimentary.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        code:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Unique code of a product.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        custom1:
          description: '


            The value of the product''s first custom field.'
          nullable: true
          type: string
          x-internal: false
        custom2:
          description: '


            The value of the product''s second custom field.'
          nullable: true
          type: string
          x-internal: false
        custom3:
          description: '


            The value of the product''s third custom field.'
          nullable: true
          type: string
          x-internal: false
        custom4:
          description: '


            The value of the product''s fourth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom5:
          description: '


            The value of the product''s fifth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom6:
          description: '


            The value of the product''s sixth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom7:
          description: '


            The value of the product''s seventh custom field.'
          nullable: true
          type: string
          x-internal: false
        custom8:
          description: '


            The value of the product''s eight custom field.'
          nullable: true
          type: string
          x-internal: false
        custom9:
          description: '


            The value of the product''s ninth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom10:
          description: '


            The value of the product''s 10th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom11:
          description: '


            The value of the product''s 11th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom12:
          description: '


            The value of the product''s 12th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom13:
          description: '


            The value of the product''s 13th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom14:
          description: '


            The value of the product''s 14th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom15:
          description: '


            The value of the product''s 15th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom16:
          description: '


            The value of the product''s 16th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom17:
          description: '


            The value of the product''s 17th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom18:
          description: '


            The value of the product''s 18th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom19:
          description: '


            The value of the product''s 19th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom20:
          description: '


            The value of the product''s 20th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom21:
          description: '


            The value of the product''s 21st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom22:
          description: '


            The value of the product''s 22nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom23:
          description: '


            The value of the product''s 23rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom24:
          description: '


            The value of the product''s 24th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom25:
          description: '


            The value of the product''s 25th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom26:
          description: '


            The value of the product''s 26th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom27:
          description: '


            The value of the product''s 27th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom28:
          description: '


            The value of the product''s 28th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom29:
          description: '


            The value of the product''s 29th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom30:
          description: '


            The value of the product''s 30th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom31:
          description: '


            The value of the product''s 31st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom32:
          description: '


            The value of the product''s 32nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom33:
          description: '


            The value of the product''s 33rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom34:
          description: '


            The value of the product''s 34th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom35:
          description: '


            The value of the product''s 35th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom36:
          description: '


            The value of the product''s 36th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom37:
          description: '


            The value of the product''s 37th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom38:
          description: '


            The value of the product''s 38th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom39:
          description: '


            The value of the product''s 39th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom40:
          description: '


            The value of the product''s 40th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom41:
          description: '


            The value of the product''s 41st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom42:
          description: '


            The value of the product''s 42nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom43:
          description: '


            The value of the product''s 43rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom44:
          description: '


            The value of the product''s 44th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom45:
          description: '


            The value of the product''s 45th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom46:
          description: '


            The value of the product''s 46th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom47:
          description: '


            The value of the product''s 47th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom48:
          description: '


            The value of the product''s 48th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom49:
          description: '


            The value of the product''s 49th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom50:
          description: '


            The value of the product''s 50th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom51:
          description: '


            The value of the product''s 51st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom52:
          description: '


            The value of the product''s 52nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom53:
          description: '


            The value of the product''s 53rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom54:
          description: '


            The value of the product''s 54th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom55:
          description: '


            The value of the product''s 55th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom56:
          description: '


            The value of the product''s 56th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom57:
          description: '


            The value of the product''s 57th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom58:
          description: '


            The value of the product''s 58th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom59:
          description: '


            The value of the product''s 59th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom60:
          description: '


            The value of the product''s 60th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom61:
          description: '


            The value of the product''s 61st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom62:
          description: '


            The value of the product''s 62nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom63:
          description: '


            The value of the product''s 63rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom64:
          description: '


            The value of the product''s 64th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom65:
          description: '


            The value of the product''s 65th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom66:
          description: '


            The value of the product''s 66th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom67:
          description: '


            The value of the product''s 67th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom68:
          description: '


            The value of the product''s 68th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom69:
          description: '


            The value of the product''s 69th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom70:
          description: '


            The value of the product''s 70th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom71:
          description: '


            The value of the product''s 71st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom72:
          description: '


            The value of the product''s 72nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom73:
          description: '


            The value of the product''s 73rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom74:
          description: '


            The value of the product''s 74th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom75:
          description: '


            The value of the product''s 75th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom76:
          description: '


            The value of the product''s 76th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom77:
          description: '


            The value of the product''s 77th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom78:
          description: '


            The value of the product''s 78th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom79:
          description: '


            The value of the product''s 79th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom80:
          description: '


            The value of the product''s 80th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom81:
          description: '


            The value of the product''s 81st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom82:
          description: '


            The value of the product''s 82nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom83:
          description: '


            The value of the product''s 83rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom84:
          description: '


            The value of the product''s 84th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom85:
          description: '


            The value of the product''s 85th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom86:
          description: '


            The value of the product''s 86th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom87:
          description: '


            The value of the product''s 87th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom88:
          description: '


            The value of the product''s 88th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom89:
          description: '


            The value of the product''s 89th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom90:
          description: '


            The value of the product''s 90th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom91:
          description: '


            The value of the product''s 91st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom92:
          description: '


            The value of the product''s 92nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom93:
          description: '


            The value of the product''s 93rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom94:
          description: '


            The value of the product''s 94th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom95:
          description: '


            The value of the product''s 95th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom96:
          description: '


            The value of the product''s 96th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom97:
          description: '


            The value of the product''s 97th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom98:
          description: '


            The value of the product''s 98th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom99:
          description: '


            The value of the product''s 99th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom100:
          description: '


            The value of the product''s 100th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom101:
          description: '


            The value of the product''s 101st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom102:
          description: '


            The value of the product''s 102nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom103:
          description: '


            The value of the product''s 103rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom104:
          description: '


            The value of the product''s 104th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom105:
          description: '


            The value of the product''s 105th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom106:
          description: '


            The value of the product''s 106th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom107:
          description: '


            The value of the product''s 107th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom108:
          description: '


            The value of the product''s 108th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom109:
          description: '


            The value of the product''s 109th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom110:
          description: '


            The value of the product''s 110th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom111:
          description: '


            The value of the product''s 111th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom112:
          description: '


            The value of the product''s 112th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom113:
          description: '


            The value of the product''s 113th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom114:
          description: '


            The value of the product''s 114th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom115:
          description: '


            The value of the product''s 115th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom116:
          description: '


            The value of the product''s 116th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom117:
          description: '


            The value of the product''s 117th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom118:
          description: '


            The value of the product''s 118th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom119:
          description: '


            The value of the product''s 119th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom120:
          description: '


            The value of the product''s 120th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom121:
          description: '


            The value of the product''s 121st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom122:
          description: '


            The value of the product''s 122nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom123:
          description: '


            The value of the product''s 123rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom124:
          description: '


            The value of the product''s 124th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom125:
          description: '


            The value of the product''s 125th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom126:
          description: '


            The value of the product''s 126th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom127:
          description: '


            The value of the product''s 127th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom128:
          description: '


            The value of the product''s 128th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom129:
          description: '


            The value of the product''s 129th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom130:
          description: '


            The value of the product''s 130th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom131:
          description: '


            The value of the product''s 131st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom132:
          description: '


            The value of the product''s 132nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom133:
          description: '


            The value of the product''s 133rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom134:
          description: '


            The value of the product''s 134th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom135:
          description: '


            The value of the product''s 135th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom136:
          description: '


            The value of the product''s 136th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom137:
          description: '


            The value of the product''s 137th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom138:
          description: '


            The value of the product''s 138th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom139:
          description: '


            The value of the product''s 139th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom140:
          description: '


            The value of the product''s 140th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom141:
          description: '


            The value of the product''s 141st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom142:
          description: '


            The value of the product''s 142nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom143:
          description: '


            The value of the product''s 143rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom144:
          description: '


            The value of the product''s 144th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom145:
          description: '


            The value of the product''s 145th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom146:
          description: '


            The value of the product''s 146th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom147:
          description: '


            The value of the product''s 147th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom148:
          description: '


            The value of the product''s 148th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom149:
          description: '


            The value of the product''s 149th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom150:
          description: '


            The value of the product''s 150th custom field.'
          nullable: true
          type: string
          x-internal: false
        deleted:
          description: '


            A boolean value whether the product has deleted or not.'
          nullable: true
          type: boolean
          x-internal: false
        description:
          description: '


            A custom description of the product.'
          maxLength: 16777215
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Name of a product.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        productFamily:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Name of Product Family associated with the Product.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        status:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            A boolean value whether the product is active or not.'
          nullable: true
          type: boolean
          x-internal: false
        unitOfMeasure:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Unit of the product; for example, kilograms, liters, or cases.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        website:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Website URL of this product.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    productRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of this task.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of this task.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        purchases:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    productResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/product'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/productRelationships'
        type:
          type: string
      type: object
      x-internal: false
    profile:
      description: 'Controls what you can see and do within Outreach

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the team was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        isAdmin:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Flag that indicates whether the profile provides admin access.'
          nullable: true
          type: boolean
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the profile (e.g. "Admin").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        specialId:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>


            The special id flag assigned to the profile (i.e. admin or default)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the team was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    profileRelationships:
      type: object
    profileResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/profile'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/profileRelationships'
        type:
          type: string
      type: object
      x-internal: false
    prospect:
      description: 'A descriptor of a person.

        '
      properties:
        addedAt:
          description: '


            The date and time the prospect was added to any system.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        addressCity:
          description: '


            The prospect’s city (e.g. "Seattle").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        addressCountry:
          description: '


            The prospect’s country (e.g. "USA").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        addressState:
          description: '


            The prospect’s state (e.g. "Washington").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        addressStreet:
          description: '


            The prospect’s street address (e.g. "1441 N 34th St").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        addressStreet2:
          description: '


            The prospect’s second street address, if applicable.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        addressZip:
          description: '


            The prospect’s postal code (e.g. "98103").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        angelListUrl:
          description: '


            The prospect’s AngelList URL.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        availableAt:
          description: '


            The date and time the prospect is available to contact again.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        callOptedOut:
          description: '


            Whether the prospect is opted out of calling, or opted out in general if granular opt-out is not enabled.'
          nullable: true
          type: boolean
          x-internal: false
        callsOptStatus:
          description: '


            A string ("opted_in", "opted_out", "null") that represents whether a prospect has opted into or out of calls.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        callsOptedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the prospect opted in/out of calls.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        campaignName:
          description: '


            The name of the campaign the prospect is associated with.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        clickCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of clicks the prospect has made since the last touch point.'
          nullable: true
          type: integer
          x-internal: false
        company:
          description: '


            The name of the company the prospect works at. If associated with an account, this is the name of the account.
            (e.g. Acme International).'
          nullable: true
          type: string
          x-internal: false
        contactHistogram:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The last 12 months of email contact history with the prospect, with the current month being the last element.
            The format for each month is ''[inboundCount, outboundCount]''. Note: Retrieving this field will slow down the
            queries. Unless this field is required, it is best to filter it out. See Specify Sparse Fieldsets for examples'
          items:
            format: contact histogram
          nullable: true
          type: array
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the prospect was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        custom1:
          description: '


            The value of the prospect’s first custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom2:
          description: '


            The value of the prospect’s second custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom3:
          description: '


            The value of the prospect’s third custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom4:
          description: '


            The value of the prospect’s fourth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom5:
          description: '


            The value of the prospect’s fifth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom6:
          description: '


            The value of the prospect’s sixth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom7:
          description: '


            The value of the prospect’s seventh custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom8:
          description: '


            The value of the prospect’s eight custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom9:
          description: '


            The value of the prospect’s ninth custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom10:
          description: '


            The value of the prospect’s 10th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom11:
          description: '


            The value of the prospect’s 11th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom12:
          description: '


            The value of the prospect’s 12th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom13:
          description: '


            The value of the prospect’s 13th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom14:
          description: '


            The value of the prospect’s 14th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom15:
          description: '


            The value of the prospect’s 15th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom16:
          description: '


            The value of the prospect’s 16th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom17:
          description: '


            The value of the prospect’s 17th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom18:
          description: '


            The value of the prospect’s 18th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom19:
          description: '


            The value of the prospect’s 19th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom20:
          description: '


            The value of the prospect’s 20th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom21:
          description: '


            The value of the prospect’s 21st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom22:
          description: '


            The value of the prospect’s 22nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom23:
          description: '


            The value of the prospect’s 23rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom24:
          description: '


            The value of the prospect’s 24th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom25:
          description: '


            The value of the prospect’s 25th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom26:
          description: '


            The value of the prospect’s 26th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom27:
          description: '


            The value of the prospect’s 27th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom28:
          description: '


            The value of the prospect’s 28th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom29:
          description: '


            The value of the prospect’s 29th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom30:
          description: '


            The value of the prospect’s 30th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom31:
          description: '


            The value of the prospect’s 31st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom32:
          description: '


            The value of the prospect’s 32nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom33:
          description: '


            The value of the prospect’s 33rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom34:
          description: '


            The value of the prospect’s 34th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom35:
          description: '


            The value of the prospect’s 35th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom36:
          description: '


            The value of the prospect’s 36th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom37:
          description: '


            The value of the prospect’s 37th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom38:
          description: '


            The value of the prospect’s 38th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom39:
          description: '


            The value of the prospect’s 39th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom40:
          description: '


            The value of the prospect’s 40th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom41:
          description: '


            The value of the prospect’s 41st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom42:
          description: '


            The value of the prospect’s 42nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom43:
          description: '


            The value of the prospect’s 43rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom44:
          description: '


            The value of the prospect’s 44th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom45:
          description: '


            The value of the prospect’s 45th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom46:
          description: '


            The value of the prospect’s 46th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom47:
          description: '


            The value of the prospect’s 47th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom48:
          description: '


            The value of the prospect’s 48th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom49:
          description: '


            The value of the prospect’s 49th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom50:
          description: '


            The value of the prospect’s 50th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom51:
          description: '


            The value of the prospect’s 51st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom52:
          description: '


            The value of the prospect’s 52nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom53:
          description: '


            The value of the prospect’s 53rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom54:
          description: '


            The value of the prospect’s 54th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom55:
          description: '


            The value of the prospect’s 55th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom56:
          description: '


            The value of the prospect’s 56th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom57:
          description: '


            The value of the prospect’s 57th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom58:
          description: '


            The value of the prospect’s 58th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom59:
          description: '


            The value of the prospect’s 59th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom60:
          description: '


            The value of the prospect’s 60th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom61:
          description: '


            The value of the prospect’s 61st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom62:
          description: '


            The value of the prospect’s 62nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom63:
          description: '


            The value of the prospect’s 63rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom64:
          description: '


            The value of the prospect’s 64th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom65:
          description: '


            The value of the prospect’s 65th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom66:
          description: '


            The value of the prospect’s 66th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom67:
          description: '


            The value of the prospect’s 67th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom68:
          description: '


            The value of the prospect’s 68th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom69:
          description: '


            The value of the prospect’s 69th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom70:
          description: '


            The value of the prospect’s 70th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom71:
          description: '


            The value of the prospect’s 71st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom72:
          description: '


            The value of the prospect’s 72nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom73:
          description: '


            The value of the prospect’s 73rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom74:
          description: '


            The value of the prospect’s 74th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom75:
          description: '


            The value of the prospect’s 75th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom76:
          description: '


            The value of the prospect’s 76th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom77:
          description: '


            The value of the prospect’s 77th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom78:
          description: '


            The value of the prospect’s 78th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom79:
          description: '


            The value of the prospect’s 79th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom80:
          description: '


            The value of the prospect’s 80th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom81:
          description: '


            The value of the prospect’s 81st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom82:
          description: '


            The value of the prospect’s 82nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom83:
          description: '


            The value of the prospect’s 83rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom84:
          description: '


            The value of the prospect’s 84th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom85:
          description: '


            The value of the prospect’s 85th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom86:
          description: '


            The value of the prospect’s 86th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom87:
          description: '


            The value of the prospect’s 87th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom88:
          description: '


            The value of the prospect’s 88th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom89:
          description: '


            The value of the prospect’s 89th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom90:
          description: '


            The value of the prospect’s 90th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom91:
          description: '


            The value of the prospect’s 91st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom92:
          description: '


            The value of the prospect’s 92nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom93:
          description: '


            The value of the prospect’s 93rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom94:
          description: '


            The value of the prospect’s 94th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom95:
          description: '


            The value of the prospect’s 95th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom96:
          description: '


            The value of the prospect’s 96th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom97:
          description: '


            The value of the prospect’s 97th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom98:
          description: '


            The value of the prospect’s 98th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom99:
          description: '


            The value of the prospect’s 99th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom100:
          description: '


            The value of the prospect’s 100th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom101:
          description: '


            The value of the prospect’s 101st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom102:
          description: '


            The value of the prospect’s 102nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom103:
          description: '


            The value of the prospect’s 103rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom104:
          description: '


            The value of the prospect’s 104th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom105:
          description: '


            The value of the prospect’s 105th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom106:
          description: '


            The value of the prospect’s 106th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom107:
          description: '


            The value of the prospect’s 107th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom108:
          description: '


            The value of the prospect’s 108th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom109:
          description: '


            The value of the prospect’s 109th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom110:
          description: '


            The value of the prospect’s 110th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom111:
          description: '


            The value of the prospect’s 111th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom112:
          description: '


            The value of the prospect’s 112th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom113:
          description: '


            The value of the prospect’s 113th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom114:
          description: '


            The value of the prospect’s 114th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom115:
          description: '


            The value of the prospect’s 115th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom116:
          description: '


            The value of the prospect’s 116th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom117:
          description: '


            The value of the prospect’s 117th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom118:
          description: '


            The value of the prospect’s 118th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom119:
          description: '


            The value of the prospect’s 119th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom120:
          description: '


            The value of the prospect’s 120th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom121:
          description: '


            The value of the prospect’s 121st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom122:
          description: '


            The value of the prospect’s 122nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom123:
          description: '


            The value of the prospect’s 123rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom124:
          description: '


            The value of the prospect’s 124th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom125:
          description: '


            The value of the prospect’s 125th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom126:
          description: '


            The value of the prospect’s 126th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom127:
          description: '


            The value of the prospect’s 127th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom128:
          description: '


            The value of the prospect’s 128th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom129:
          description: '


            The value of the prospect’s 129th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom130:
          description: '


            The value of the prospect’s 130th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom131:
          description: '


            The value of the prospect’s 131st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom132:
          description: '


            The value of the prospect’s 132nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom133:
          description: '


            The value of the prospect’s 133rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom134:
          description: '


            The value of the prospect’s 134th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom135:
          description: '


            The value of the prospect’s 135th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom136:
          description: '


            The value of the prospect’s 136th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom137:
          description: '


            The value of the prospect’s 137th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom138:
          description: '


            The value of the prospect’s 138th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom139:
          description: '


            The value of the prospect’s 139th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom140:
          description: '


            The value of the prospect’s 140th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom141:
          description: '


            The value of the prospect’s 141st custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom142:
          description: '


            The value of the prospect’s 142nd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom143:
          description: '


            The value of the prospect’s 143rd custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom144:
          description: '


            The value of the prospect’s 144th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom145:
          description: '


            The value of the prospect’s 145th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom146:
          description: '


            The value of the prospect’s 146th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom147:
          description: '


            The value of the prospect’s 147th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom148:
          description: '


            The value of the prospect’s 148th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom149:
          description: '


            The value of the prospect’s 149th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        custom150:
          description: '


            The value of the prospect’s 150th custom field.'
          maxLength: 32000
          nullable: true
          type: string
          x-internal: false
        dateOfBirth:
          description: '


            The date the prospect was born.'
          format: date
          nullable: true
          type: string
          x-internal: false
        degree:
          description: '


            The degree(s) the prospect has received.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        emailOptedOut:
          description: '


            Whether the prospect is opted out of email, or opted out in general if granular opt-out is not enabled.'
          nullable: true
          type: boolean
          x-internal: false
        emails:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            A list of email addresses associated with the prospect.'
          items:
            format: email
            type: string
          nullable: true
          type: array
          x-internal: false
        emailsOptStatus:
          description: '


            A string ("opted_in", "opted_out", "null") that represents whether a prospect has opted into or out of emails.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        emailsOptedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the prospect opted in/out of emails.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        engagedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the prospect last engaged.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        engagedScore:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            A number representing the quality of the lead, based on the number of the prospect’s opens, clicks and mailing
            replies.'
          format: float
          nullable: true
          type: number
          x-internal: false
        eventName:
          description: '


            The name of the event the prospect was met at.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        externalId:
          description: '


            A custom ID for the prospect, often referencing an ID in an external system.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        externalOwner:
          description: '


            A custom owner for the prospect, often referencing an ownering in an external system.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        externalSource:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The source of the resource’s creation (e.g. "outreach-api").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        facebookUrl:
          description: '


            The prospect’s Facebook URL.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        firstName:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The first name of the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        gender:
          description: '


            The gender of the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        githubUrl:
          description: '


            The prospect’s GitHub URL.'
          maxLength: 1000
          nullable: true
          type: string
          x-internal: false
        githubUsername:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The prospect’s GitHub username.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        googlePlusUrl:
          description: '


            The prospect’s Google+ URL.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        graduationDate:
          description: '


            The graduation date of the prospect.'
          format: date
          nullable: true
          type: string
          x-internal: false
        homePhones:
          description: '


            A list of home phone numbers associated with the prospect.'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        jobStartDate:
          description: '


            The starting date of the prospect’s current job.'
          format: date
          nullable: true
          type: string
          x-internal: false
        lastName:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The last name of the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        linkedInConnections:
          description: '


            The number of connections on the prospect’s LinkedIn profile.'
          nullable: true
          type: integer
          x-internal: false
        linkedInId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The prospect’s LinkedIn ID.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        linkedInSlug:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The prospect’s LinkedIn slug.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        linkedInUrl:
          description: '


            The prospect’s LinkedIn URL.'
          maxLength: 1000
          nullable: true
          type: string
          x-internal: false
        middleName:
          description: '


            The middle name of the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        mobilePhones:
          description: '


            A list of mobile phone numbers associated with the prospect.'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The full name of the prospect.'
          nullable: true
          type: string
          x-internal: false
        nickname:
          description: '


            The nickname of the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        occupation:
          description: '


            The occupation of the prospect (e.g. "Purchasing Manager").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        openCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of opens the prospect has made since the last touch point.'
          nullable: true
          type: integer
          x-internal: false
        optedOut:
          description: '


            A boolean value representing whether this prospect is currently opted out of all mailings. Set this value to true
            to opt out the prospect; the ''opted_out'' timestamp will be updated to the time of the request. Set this value
            to false to revert the opt at and clear the opted out timestamp.'
          nullable: true
          type: boolean
          x-internal: false
        optedOutAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the prospect opted out of emails.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        otherPhones:
          description: '


            A list of other phone numbers associated with the prospect.'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        personalNote1:
          description: '


            A custom note field related to the prospect.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        personalNote2:
          description: '


            A second note field related to the prospect.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        preferredContact:
          description: '


            The preferred contact method for the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        quoraUrl:
          description: '


            The prospect’s Quora URL.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        region:
          description: '


            The primary geographic region of the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        replyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The number of replies the prospect has made since the last touch point.'
          nullable: true
          type: integer
          x-internal: false
        school:
          description: '


            The school(s) the prospect has attended.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        score:
          description: '


            A custom score given to measure the quality of the lead.'
          format: float
          nullable: true
          type: number
          x-internal: false
        sharingTeamId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The ID of the sharing team associated with this object. Access is currently in beta.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        source:
          description: '


            A custom source representing where the lead was first acquired.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        specialties:
          description: '


            A description of the prospect’s specialties.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        stackOverflowId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The prospect’s StackOverflow ID.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stackOverflowUrl:
          description: '


            The prospect’s StackOverflow URL.'
          maxLength: 1000
          nullable: true
          type: string
          x-internal: false
        tags:
          description: '


            A list of tag values associated with the account (e.g. ["Interested", "2017 Expo"]).'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        timeZone:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The prospect’s current timezone, preferably in the IANA format (e.g. "America/LosAngeles").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        timeZoneIana:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The prospect’s current IANA timezone, if available.'
          nullable: true
          type: string
          x-internal: false
        timeZoneInferred:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The prospect’s current inferred IANA timezone, if available.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        title:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The title of the prospect.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        touchedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the prospect was last touched.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        trashedAt:
          description: '


            The date a prospect was soft deleted.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        twitterUrl:
          description: '


            The prospect’s Twitter URL.'
          maxLength: 1000
          nullable: true
          type: string
          x-internal: false
        twitterUsername:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The prospect’s Twitter username.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the prospect was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        voipPhones:
          description: '


            A list of voip phone numbers associated with the prospect.'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        websiteUrl1:
          description: '


            The URL of the prospect’s website.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        websiteUrl2:
          description: '


            The value of the prospect’s second website URL field.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        websiteUrl3:
          description: '


            The value of the prospect’s third website URL field.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        workPhones:
          description: '


            A list of work phone numbers associated with the prospect.'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
      type: object
      x-internal: false
    prospectNote:
      description: 'Notes related to prospects

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the prospect note was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        message:
          description: '


            The text content of this prospect note.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        noteType:
          description: '


            The context of this prospect note, one of {note,call,coffee,beer,meeting}.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        opportunityAssociationRule:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            The rule used to associate the account note with an opportunity, one of {recent_created,recent_updated}.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        pinned:
          description: '


            A boolean value indicating whether this prospect note is pinned.'
          nullable: true
          type: boolean
          x-internal: false
      type: object
      x-internal: false
    prospectNoteRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the prospect note. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The opportunity this prospect note is related to. Relationship opportunity cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The prospect this prospect note is related to. You can use only the attribute id to filter prospectNotes
            by prospect (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    prospectNoteResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/prospectNote'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/prospectNoteRelationships'
        type:
          type: string
      type: object
      x-internal: false
    prospectRelationships:
      properties:
        account:
          description: The prospect's associated account. You can use attributes id, customId, name, named and updatedAt to
            filter prospects by account (e.g. filter[account][id]=X). You can force a null return on unnamed account by adding
            in the request actionParams[withUnnamedAccount]=false.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        activeSequenceStates:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The non-finished sequence states where this prospect is the primary recipient. This includes states of "active",
            "paused", "failed", "bounced", "pending" and "disabled." You can use attributes id and state to filter prospects
            by activeSequenceStates (e.g. filter[activeSequenceStates][id]=X).'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - sequenceState
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        assignedTeams:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        assignedUsers:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - user
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        batches:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The batches associated with the prospect.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        calls:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The calls associated with the prospect. Relationship calls cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creater of the prospect. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        defaultPluginMapping:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The default plugin mapping associated with the prospect. If no plugin mapping is enabled, it will return the first
            plugin mapping associated with the prospect.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - pluginMapping
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        emailAddresses:
          description: The prospect's email addresses. Relationship emailAddresses cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - emailAddress
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        favorites:
          description: The prospect's favorites. Relationship favorites cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - favorite
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The mailings associated with the prospect. Relationship mailings cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunities:
          description: The opportunities associated with the prospect. Requires the Opportunities SKU to be enabled in order
            to have access. Please contact support@outreach.io for more assistance. You can use only the attribute id to filter
            prospects by opportunities (e.g. filter[opportunities][id]=X).
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - opportunity
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunityProspectRoles:
          description: The roles that associate the prospect with opportunities. Relationship opportunityProspectRoles cannot
            be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - opportunityProspectRole
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of the prospect. You can use only the attribute id to filter prospects by owner (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        persona:
          description: The persona of the prospect, if it has one. You can use only the attribute id to filter prospects by
            persona (e.g. filter[persona][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - persona
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        phoneNumbers:
          description: The prospect's phone numbers Relationship phoneNumbers cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - phoneNumber
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStates:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence states where this prospect is the primary recipient. You can use attributes id and state to filter
            prospects by sequenceStates (e.g. filter[sequenceStates][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        stage:
          description: The stage the prospect is in. You can use attributes id and name to filter prospects by stage (e.g.
            filter[stage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The tasks associated with the prospect. Relationship tasks cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        trashedByAccount:
          description: The account that soft deleted this prospect.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the prospect. Relationship updater cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    prospectResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/prospect'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/prospectRelationships'
        type:
          type: string
      type: object
      x-internal: false
    purchase:
      description: 'Contains all the list of products which are related to the accounts.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        currency:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            It tells you what type of currency we are using to purchase'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        custom1:
          description: '


            The value of the purchases first custom field.'
          nullable: true
          type: string
          x-internal: false
        custom2:
          description: '


            The value of the purchases second custom field.'
          nullable: true
          type: string
          x-internal: false
        custom3:
          description: '


            The value of the purchases third custom field.'
          nullable: true
          type: string
          x-internal: false
        custom4:
          description: '


            The value of the purchases fourth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom5:
          description: '


            The value of the purchases fifth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom6:
          description: '


            The value of the purchases sixth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom7:
          description: '


            The value of the purchases seventh custom field.'
          nullable: true
          type: string
          x-internal: false
        custom8:
          description: '


            The value of the purchases eight custom field.'
          nullable: true
          type: string
          x-internal: false
        custom9:
          description: '


            The value of the purchases ninth custom field.'
          nullable: true
          type: string
          x-internal: false
        custom10:
          description: '


            The value of the purchases 10th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom11:
          description: '


            The value of the purchases 11th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom12:
          description: '


            The value of the purchases 12th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom13:
          description: '


            The value of the purchases 13th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom14:
          description: '


            The value of the purchases 14th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom15:
          description: '


            The value of the purchases 15th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom16:
          description: '


            The value of the purchases 16th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom17:
          description: '


            The value of the purchases 17th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom18:
          description: '


            The value of the purchases 18th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom19:
          description: '


            The value of the purchases 19th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom20:
          description: '


            The value of the purchases 20th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom21:
          description: '


            The value of the purchases 21st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom22:
          description: '


            The value of the purchases 22nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom23:
          description: '


            The value of the purchases 23rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom24:
          description: '


            The value of the purchases 24th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom25:
          description: '


            The value of the purchases 25th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom26:
          description: '


            The value of the purchases 26th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom27:
          description: '


            The value of the purchases 27th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom28:
          description: '


            The value of the purchases 28th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom29:
          description: '


            The value of the purchases 29th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom30:
          description: '


            The value of the purchases 30th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom31:
          description: '


            The value of the purchases 31st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom32:
          description: '


            The value of the purchases 32nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom33:
          description: '


            The value of the purchases 33rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom34:
          description: '


            The value of the purchases 34th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom35:
          description: '


            The value of the purchases 35th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom36:
          description: '


            The value of the purchases 36th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom37:
          description: '


            The value of the purchases 37th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom38:
          description: '


            The value of the purchases 38th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom39:
          description: '


            The value of the purchases 39th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom40:
          description: '


            The value of the purchases 40th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom41:
          description: '


            The value of the purchases 41st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom42:
          description: '


            The value of the purchases 42nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom43:
          description: '


            The value of the purchases 43rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom44:
          description: '


            The value of the purchases 44th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom45:
          description: '


            The value of the purchases 45th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom46:
          description: '


            The value of the purchases 46th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom47:
          description: '


            The value of the purchases 47th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom48:
          description: '


            The value of the purchases 48th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom49:
          description: '


            The value of the purchases 49th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom50:
          description: '


            The value of the purchases 50th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom51:
          description: '


            The value of the purchases 51st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom52:
          description: '


            The value of the purchases 52nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom53:
          description: '


            The value of the purchases 53rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom54:
          description: '


            The value of the purchases 54th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom55:
          description: '


            The value of the purchases 55th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom56:
          description: '


            The value of the purchases 56th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom57:
          description: '


            The value of the purchases 57th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom58:
          description: '


            The value of the purchases 58th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom59:
          description: '


            The value of the purchases 59th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom60:
          description: '


            The value of the purchases 60th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom61:
          description: '


            The value of the purchases 61st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom62:
          description: '


            The value of the purchases 62nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom63:
          description: '


            The value of the purchases 63rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom64:
          description: '


            The value of the purchases 64th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom65:
          description: '


            The value of the purchases 65th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom66:
          description: '


            The value of the purchases 66th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom67:
          description: '


            The value of the purchases 67th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom68:
          description: '


            The value of the purchases 68th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom69:
          description: '


            The value of the purchases 69th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom70:
          description: '


            The value of the purchases 70th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom71:
          description: '


            The value of the purchases 71st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom72:
          description: '


            The value of the purchases 72nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom73:
          description: '


            The value of the purchases 73rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom74:
          description: '


            The value of the purchases 74th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom75:
          description: '


            The value of the purchases 75th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom76:
          description: '


            The value of the purchases 76th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom77:
          description: '


            The value of the purchases 77th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom78:
          description: '


            The value of the purchases 78th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom79:
          description: '


            The value of the purchases 79th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom80:
          description: '


            The value of the purchases 80th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom81:
          description: '


            The value of the purchases 81st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom82:
          description: '


            The value of the purchases 82nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom83:
          description: '


            The value of the purchases 83rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom84:
          description: '


            The value of the purchases 84th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom85:
          description: '


            The value of the purchases 85th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom86:
          description: '


            The value of the purchases 86th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom87:
          description: '


            The value of the purchases 87th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom88:
          description: '


            The value of the purchases 88th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom89:
          description: '


            The value of the purchases 89th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom90:
          description: '


            The value of the purchases 90th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom91:
          description: '


            The value of the purchases 91st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom92:
          description: '


            The value of the purchases 92nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom93:
          description: '


            The value of the purchases 93rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom94:
          description: '


            The value of the purchases 94th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom95:
          description: '


            The value of the purchases 95th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom96:
          description: '


            The value of the purchases 96th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom97:
          description: '


            The value of the purchases 97th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom98:
          description: '


            The value of the purchases 98th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom99:
          description: '


            The value of the purchases 99th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom100:
          description: '


            The value of the purchases 100th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom101:
          description: '


            The value of the purchases 101st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom102:
          description: '


            The value of the purchases 102nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom103:
          description: '


            The value of the purchases 103rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom104:
          description: '


            The value of the purchases 104th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom105:
          description: '


            The value of the purchases 105th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom106:
          description: '


            The value of the purchases 106th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom107:
          description: '


            The value of the purchases 107th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom108:
          description: '


            The value of the purchases 108th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom109:
          description: '


            The value of the purchases 109th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom110:
          description: '


            The value of the purchases 110th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom111:
          description: '


            The value of the purchases 111th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom112:
          description: '


            The value of the purchases 112th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom113:
          description: '


            The value of the purchases 113th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom114:
          description: '


            The value of the purchases 114th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom115:
          description: '


            The value of the purchases 115th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom116:
          description: '


            The value of the purchases 116th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom117:
          description: '


            The value of the purchases 117th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom118:
          description: '


            The value of the purchases 118th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom119:
          description: '


            The value of the purchases 119th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom120:
          description: '


            The value of the purchases 120th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom121:
          description: '


            The value of the purchases 121st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom122:
          description: '


            The value of the purchases 122nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom123:
          description: '


            The value of the purchases 123rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom124:
          description: '


            The value of the purchases 124th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom125:
          description: '


            The value of the purchases 125th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom126:
          description: '


            The value of the purchases 126th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom127:
          description: '


            The value of the purchases 127th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom128:
          description: '


            The value of the purchases 128th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom129:
          description: '


            The value of the purchases 129th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom130:
          description: '


            The value of the purchases 130th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom131:
          description: '


            The value of the purchases 131st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom132:
          description: '


            The value of the purchases 132nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom133:
          description: '


            The value of the purchases 133rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom134:
          description: '


            The value of the purchases 134th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom135:
          description: '


            The value of the purchases 135th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom136:
          description: '


            The value of the purchases 136th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom137:
          description: '


            The value of the purchases 137th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom138:
          description: '


            The value of the purchases 138th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom139:
          description: '


            The value of the purchases 139th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom140:
          description: '


            The value of the purchases 140th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom141:
          description: '


            The value of the purchases 141st custom field.'
          nullable: true
          type: string
          x-internal: false
        custom142:
          description: '


            The value of the purchases 142nd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom143:
          description: '


            The value of the purchases 143rd custom field.'
          nullable: true
          type: string
          x-internal: false
        custom144:
          description: '


            The value of the purchases 144th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom145:
          description: '


            The value of the purchases 145th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom146:
          description: '


            The value of the purchases 146th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom147:
          description: '


            The value of the purchases 147th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom148:
          description: '


            The value of the purchases 148th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom149:
          description: '


            The value of the purchases 149th custom field.'
          nullable: true
          type: string
          x-internal: false
        custom150:
          description: '


            The value of the purchases 150th custom field.'
          nullable: true
          type: string
          x-internal: false
        description:
          description: '


            A description of the purchase.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        endDate:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            End Date of Contract.'
          format: date
          nullable: true
          type: string
          x-internal: false
        potentialQuantity:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Net Potential within an Account.'
          format: float
          nullable: true
          type: number
          x-internal: false
        potentialValue:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Net Potential Revenue within an Account.'
          format: float
          nullable: true
          type: number
          x-internal: false
        saturation:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Contract seat as a % of potential.'
          format: float
          nullable: true
          type: number
          x-internal: false
        source:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            It tells how the purchase record was populated. Either is it manual or some API or some other source'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        startDate:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            Start Date of Contract.'
          format: date
          nullable: true
          type: string
          x-internal: false
        status:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            A boolean value whether the product is active or not.'
          nullable: true
          type: boolean
          x-internal: false
        totalQuantity:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Net Contracted Quantity (Always less than or equal to the potential)'
          format: float
          nullable: true
          type: number
          x-internal: false
        totalValue:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            Net Current Revenue Sold.'
          format: float
          nullable: true
          type: number
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    purchaseRelationships:
      properties:
        account:
          description: The associated account. You can use only the attribute id to filter purcahses by account id (e.g. filter[account][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of this task.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of the purchase. You can use only the attribute id to filter purchases by owner (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        product:
          description: The associated product. You can use only the attribute id to filter purcahses by product id (e.g. filter[product][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - product
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    purchaseResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/purchase'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/purchaseRelationships'
        type:
          type: string
      type: object
      x-internal: false
    recipient:
      description: 'Record for a recipient for some communication, such as email

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the team was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        emailHash:
          description: '


            Hash of email for recipient.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        primary:
          description: '


            True when the recipient is the primary recipient.'
          nullable: true
          type: boolean
          x-internal: false
        recipientType:
          description: '


            The type of action for the communcation to the recipient. Must be one of ''bcc'', ''cc'', or ''to''.'
          maxLength: 3
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the team was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        value:
          description: '


            The recipient contact information (i.e. email address)'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    recipientRelationships:
      properties:
        prospect:
          description: The prospect entity relation.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user entity relation.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    recipientResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/recipient'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/recipientRelationships'
        type:
          type: string
      type: object
      x-internal: false
    recordActorAssignmentRelationships:
      properties:
        actor:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        jobRole:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - jobRole
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        record:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    referralPredictionRelationships:
      properties:
        gmailMessageMetadatum:
          description: Gmail message metadatum this prediction belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - gmailMessageMetadatum
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        phoneNumberPredictions:
          description: List of predicted phone numbers for the referral.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - phoneNumberPrediction
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The prospect this prediction belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceState:
          description: The sequence state this prediction belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceState
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    returnDatePredictionRelationships:
      properties:
        gmailMessageMetadatum:
          description: Gmail message metadatum this prediction belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - gmailMessageMetadatum
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The Prospect this prediction belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceState:
          description: The sequence state this prediction belongs to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceState
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    role:
      description: 'Where you fall within your organization''s structure.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the team was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        externalId:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The permanent, immutable identifier of the role.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the role (e.g. "Vice-President").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the team was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    roleRelationships:
      properties:
        childRoles:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - role
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        parentRole:
          description: Roles are heirarchical. This is the parent of the current role. You can use only the attribute id to
            filter roles by parentRole (e.g. filter[parentRole][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - role
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    roleResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/role'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/roleRelationships'
        type:
          type: string
      type: object
      x-internal: false
    ruleset:
      description: 'A reusable set of behaviors to be applied to Sequences

        '
      properties:
        applyCompletedStageIn:
          description: '


            The amount of time in seconds after the sequence has completed before the "completedStage" will be applied to
            the Prospect.'
          nullable: true
          type: integer
          x-internal: false
        autoResumeOotoProspects:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A boolean value whether out-of-the-office Prospects will be automatically resumed. See "autoResumeOotoProspectsIn"
            and "autoResumeOotoProspectsExpiresIn" for more information.'
          nullable: true
          type: boolean
          x-internal: false
        autoResumeOotoProspectsExpiresIn:
          description: '


            The maximum amount of time in seconds to wait before opted-out Prospect will be resumed.'
          nullable: true
          type: integer
          x-internal: false
        autoResumeOotoProspectsIn:
          description: '


            The default amount of time in seconds to wait before opted-out Prospects will be resumed.'
          nullable: true
          type: integer
          x-internal: false
        callOptOutAction:
          description: '


            Determines if prospect can be added to sequences if they are opted out of calling.'
          maxLength: 4
          nullable: true
          type: string
          x-internal: false
        clicksNeededBeforeCallTaskCreated:
          description: '


            The number of email clicks needed before a call task will be automatically created. This feature will be disabled
            unless a value is set.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the ruleset was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        emailOptOutAction:
          description: '


            Determines if prospect can be added to sequences if they are opted out of emails.'
          maxLength: 4
          nullable: true
          type: string
          x-internal: false
        includeUnsubscribeLinks:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A boolean value whether to include unsubscribe links within emails.'
          nullable: true
          type: boolean
          x-internal: false
        meetingBookedAction:
          description: '


            Determines if a prospect is marked as finished when a meeting is booked.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        minimumProspectTouchedInterval:
          description: '


            The minimum number of seconds that must elapse between when a Prospect was last contacted and when they may be
            added to a sequnce. This feature will be disabled unless a value is set.'
          nullable: true
          type: integer
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the ruleset.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        ootoAutoExtractionEnabled:
          description: '


            A boolean value determining whether to use out of the office return date auto extraction.'
          nullable: true
          type: boolean
          x-internal: false
        opensNeededBeforeCallTaskCreated:
          description: '


            The number of email opens needed before a call task will be automatically created. This feature will be disabled
            unless a value is set.'
          nullable: true
          type: integer
          x-internal: false
        permitDuplicateProspects:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A value determining whether a Prospect may be added to this Sequence multiple times or not. Permitted values include
            "allow", "disallow" (the default) and "only_if_inactive", which indicates that Prospects may be re-added to this
            sequence if their existing SequenceState is inactive.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        sequenceExclusivity:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A value determining whether Prospects may be added to multiple different Sequences. Permitted values include "all_sequences",
            "exclusive_sequences" and "none" (the default). If the value is "all_sequences", then Prospects may only be added
            if they are not active in any other Sequence; likewise, a Prospect active in a Sequence with "all_sequences" exclusivity
            cannot be added to any other Sequence. If the value is "exclusive_sequences", then Prospects may only be added
            if they are not active in any other Sequence with "exclusive_sequences" exclusivity; likewise, a Prospect active
            in a Sequence with "exclusive_sequences" exclusivity cannot be added to any other Sequence with "exclusive_sequences"
            exclusivity. If the value is "none", then no additional restrictions will be applied.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        smsOptOutAction:
          description: '


            Determines if prospect can be added to sequences if they are opted out of SMS.'
          maxLength: 4
          nullable: true
          type: string
          x-internal: false
        smsReceivedAction:
          description: '


            Determines if a prospect is marked as finished when a text message is received'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stepOverridesEnabled:
          description: '


            A boolean value determining whether to allow users to customize step templates when adding to sequence.'
          nullable: true
          type: boolean
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the ruleset was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    rulesetRelationships:
      properties:
        bouncedStage:
          description: The stage to assign to the prospect when a mailing in this sequence bounces. You can use only the attribute
            id to filter rulesets by bouncedStage (e.g. filter[bouncedStage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        callTaskPriority:
          description: The task priority to use when creating call tasks based on mail opens. You can use only the attribute
            id to filter rulesets by callTaskPriorityFromOpens (e.g. filter[callTaskPriorityFromOpens][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskPriority
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        callTaskPriorityFromClicks:
          description: The task priority to use when creating call tasks based on mail clicks. You can use only the attribute
            id to filter rulesets by callTaskPriorityFromClicks (e.g. filter[callTaskPriorityFromClicks][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskPriority
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        callTaskPriorityFromOpens:
          description: The task priority to use when creating call tasks based on mail opens. You can use only the attribute
            id to filter rulesets by callTaskPriorityFromOpens (e.g. filter[callTaskPriorityFromOpens][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskPriority
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        completedStage:
          description: The stage to assign to the prospect when this sequence completes. You can use only the attribute id
            to filter rulesets by completedStage (e.g. filter[completedStage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        deliveredStage:
          description: The stage to assign to the prospect when a mailing in this sequence is delivered. You can use only
            the attribute id to filter rulesets by deliveredStage (e.g. filter[deliveredStage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        finishedStage:
          description: The stage to assign to the prospect when this sequence finishes. You can use only the attribute id
            to filter rulesets by finishedStage (e.g. filter[finishedStage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        optedOutStage:
          description: The stage to assign to the prospect when they opt out of this sequence. You can use only the attribute
            id to filter rulesets by optedOutStage (e.g. filter[optedOutStage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of the ruleset. You can use only the attribute id to filter rulesets by owner (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        repliedStage:
          description: The stage to assign to the prospect when a mailing in this sequence is replied to. You can use only
            the attribute id to filter rulesets by repliedStage (e.g. filter[repliedStage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequences:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequences associated with this ruleset. You can use only the attribute id to filter rulesets by sequences
            (e.g. filter[sequences][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        startedStage:
          description: The stage to assign to the prospect when this sequence starts. You can use only the attribute id to
            filter rulesets by startedStage (e.g. filter[startedStage][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    rulesetResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/ruleset'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/rulesetRelationships'
        type:
          type: string
      type: object
      x-internal: false
    scheduleRelationships:
      properties:
        owner:
          description: The owner of the schedule.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    sequence:
      description: 'Leverage emailing within Sequences to engage each individual persona more effectively, and queue up the
        right actions at the right time.

        '
      properties:
        automationPercentage:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The percentage of "auto_email" sequence steps in this sequence.'
          format: float
          nullable: true
          type: number
          x-internal: false
        bounceCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of bounced mailings during this sequence.'
          nullable: true
          type: integer
          x-internal: false
        clickCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of clicked mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        deliverCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of delivered mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        description:
          description: '


            A custom description for the sequence.'
          maxLength: 1024
          nullable: true
          type: string
          x-internal: false
        durationInDays:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total number of days it takes to get through this sequence.'
          nullable: true
          type: integer
          x-internal: false
        enabled:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A boolean value determining whether the sequence is enabled or not.'
          nullable: true
          type: boolean
          x-internal: false
        enabledAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence was enabled, or null if currently disabled.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        failureCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of failed mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        finishOnReply:
          description: '


            Deprecated. This boolean value exists only to maintain backward compatibility and primaryReplyAction should be
            used instead. True if primaryReplyAction is "finish", false otherwise.'
          nullable: true
          type: boolean
          x-internal: false
        lastUsedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence was last used.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        locked:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A boolean value determining whether the sequence is locked or not.'
          nullable: true
          type: boolean
          x-internal: false
        lockedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence was locked, or null if currently unlocked.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        maxActivations:
          description: '


            The maximum number of prospects that can be associated with the sequence. Only applies if the sequence type is
            "date".'
          nullable: true
          type: integer
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name or the sequence.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        negativeReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of negative reply mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        neutralReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of neutral reply mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        numContactedProspects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of prospects who have been either called or emailed.'
          nullable: true
          type: integer
          x-internal: false
        numRepliedProspects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of prospects who have been marked as replied.'
          nullable: true
          type: integer
          x-internal: false
        openCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of opened mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        optOutCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of opted out mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        positiveReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of positive reply mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        primaryReplyAction:
          description: '


            The action to take when the primary prospect replies. Must be one of "finish", "continue", or "pause".'
          maxLength: 4
          nullable: true
          type: string
          x-internal: false
        primaryReplyPauseDuration:
          description: '


            The duration in seconds to pause for (before automatically finishing) after a reply from the primary prospect
            if the primaryReplyAction is "pause".'
          nullable: true
          type: integer
          x-internal: false
        replyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of replied mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        salesMotion:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg>


            The sales engagement type of the sequence.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        scheduleCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of scheduled mailings from this sequence.'
          nullable: true
          type: integer
          x-internal: false
        scheduleIntervalType:
          description: '


            The schedule interval type must be either "calendar" or "schedule"'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        secondaryReplyAction:
          description: '


            The action to take when someone other than the primary prospect replies. Must be one of "finish", "continue",
            or "pause".'
          maxLength: 4
          nullable: true
          type: string
          x-internal: false
        secondaryReplyPauseDuration:
          description: '


            The duration in seconds to pause for (before automatically finishing) after a reply from anyone other than the
            primary prospect if the secondaryReplyAction is "pause".'
          nullable: true
          type: integer
          x-internal: false
        sequenceStepCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total number of sequence steps in this sequence.'
          nullable: true
          type: integer
          x-internal: false
        sequenceType:
          description: '


            The sequence type must be either "date" or "interval".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        shareType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The sequence share type must be either "private", "read_only" or "shared".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        tags:
          description: '


            A list of tag values associated with the sequence (e.g. ["Tier 1", "Inbound Leads"])'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        throttleCapacity:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The maximum number of associated sequence states per user that can be active at a one time.'
          nullable: true
          type: integer
          x-internal: false
        throttleMaxAddsPerDay:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The maximum number of associated sequence states per user that can be added to the sequence each day.'
          nullable: true
          type: integer
          x-internal: false
        throttlePaused:
          description: '


            A boolean value determining whether the throttling of sequence states is paused or not.'
          nullable: true
          type: boolean
          x-internal: false
        throttlePausedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the sequence state throttling was paused, or null if not currently paused.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        transactional:
          description: '


            A boolean value determining whether prospect opt out preferences are respected. Intended only for non-marketing
            sequences.'
          nullable: true
          type: boolean
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    sequenceRelationships:
      properties:
        calls:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated calls. You can use only the attribute id to filter sequences by calls (e.g. filter[calls][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        contentCategoryMemberships:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The content categories (collections) of the sequence. You can use only the attribute id to filter sequences by
            contentCategoryMemberships (e.g. filter[contentCategoryMemberships][id]=X).'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - contentCategoryMembership
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creater of the sequence. You can use only the attribute id to filter sequences by creator (e.g. filter[creator][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated mailings. Relationship mailings cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of the sequence. You can use attributes id, email, firstName and lastName to filter sequences
            by owner (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        ruleset:
          description: The associated ruleset. You can use only the attribute id to filter sequences by ruleset (e.g. filter[ruleset][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - ruleset
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        schedule:
          description: The associated schedule.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - schedule
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStates:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence states. You can use only the attribute id to filter sequences by sequenceStates (e.g.
            filter[sequenceStates][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceSteps:
          description: The associated sequence steps. You can use only the attribute id to filter sequences by sequenceSteps
            (e.g. filter[sequenceSteps][id]=X).
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - sequenceStep
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated tasks. You can use only the attribute id to filter sequences by tasks (e.g. filter[tasks][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the sequence. You can use only the attribute id to filter sequences by updater (e.g.
            filter[updater][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    sequenceResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/sequence'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/sequenceRelationships'
        type:
          type: string
      type: object
      x-internal: false
    sequenceState:
      description: 'A descriptor of a currently sequenced prospect, which includes relationships to its sequence, prospect
        and user.

        '
      properties:
        activeAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the sequence state was last active.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        bounceCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of bounced mailings during this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        callCompletedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence state last had a call completed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        clickCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of clicked mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence state was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        deliverCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of delivered mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        errorReason:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The reason for the most recent error.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        failureCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of failed mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        negativeReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of negative reply mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        neutralReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of neutral reply mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        openCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of opened mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        optOutCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of opted out mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        pauseReason:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The reason for the most recent pause.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        positiveReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of positive reply mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        repliedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence state last had a mailing reply.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        replyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of replied mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        scheduleCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of scheduled mailings from this sequence state.'
          nullable: true
          type: integer
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The current state of the sequence state.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stateChangedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence state’s state last changed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence state was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    sequenceStateRecipientRelationships:
      properties:
        prospect:
          description: The prospect that is associated with this recipient.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceState:
          description: The sequence state that is associated with this recipient.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceState
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    sequenceStateRelationships:
      properties:
        account:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The account associated with the prospect the sequence state is targeting. You can use only the attribute id to
            filter sequenceStates by account (e.g. filter[account][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        activeStepMailings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Any undelivered mailings associated with the current sequence step. Relationship activeStepMailings cannot be
            used as a filter.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - mailing
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        activeStepTasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Any incomplete tasks associated with the current sequence step. Relationship activeStepTasks cannot be used as
            a filter.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - task
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        batchItemCreator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The batch item associated with this creation, if one exists.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - batchItem
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        calls:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The calls associated with the sequence state. You can use only the attribute id to filter sequenceStates by calls
            (e.g. filter[calls][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the sequence state. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailbox:
          description: The mailbox to use for mailing steps. You can use attributes id and email to filter sequenceStates
            by mailbox (e.g. filter[mailbox][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailbox
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The mailings associated with the sequence state. Relationship mailings cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated opportunity. You can use only the attribute id to filter sequenceStates by opportunity (e.g. filter[opportunity][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: The primary prospect this sequence state is targeting. You can use attributes id and emails to filter
            sequenceStates by prospect (e.g. filter[prospect][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequence:
          description: The sequence this prospect is engaged in. You can use any filterable attribute of sequence.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStateRecipients:
          description: Additional recipients associated with this sequence state.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - sequenceStateRecipient
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStep:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The current sequence step the prospect is in. You can use any filterable attribute of sequenceStep.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The tasks associated with the sequence state. You can use attributes id and dueAt to filter sequenceStates by
            tasks (e.g. filter[tasks][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The user managing this sequence state.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    sequenceStateResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/sequenceState'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/sequenceStateRelationships'
        type:
          type: string
      type: object
      x-internal: false
    sequenceStep:
      description: 'A descriptor of a single step within an automated sequence.

        '
      properties:
        bounceCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of bounced mailings during this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        clickCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of clicked mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence step was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        date:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The date this step will activate; only applicable to date-based sequences.'
          format: date
          nullable: true
          type: string
          x-internal: false
        deliverCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of delivered mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        displayName:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A human-readable display name that captures the step’s type and order.'
          nullable: true
          type: string
          x-internal: false
        failureCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of failed mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        interval:
          description: '


            The interval (in seconds) until this step will activate; only applicable to interval-based sequences.'
          nullable: true
          type: integer
          x-internal: false
        negativeReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of negative reply mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        neutralReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of neutral reply mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        openCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of opened mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        optOutCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of opted out mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The step’s display order within its sequence.'
          nullable: true
          type: integer
          x-internal: false
        positiveReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of positive reply mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        replyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of replied mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        scheduleCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of scheduled mailings from this sequence step.'
          nullable: true
          type: integer
          x-internal: false
        stepType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The step’s type; must be "auto_email", "manual_email", "call" or "task".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        taskAutoskipDelay:
          description: '


            The optional interval (in seconds) from when tasks created by this sequence step are overdue until they are automatically
            skipped.'
          nullable: true
          type: integer
          x-internal: false
        taskNote:
          description: '


            An optional note to associate with created tasks.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the sequence step was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    sequenceStepOverrideRelationships:
      type: object
    sequenceStepRelationships:
      properties:
        callPurpose:
          description: The default call purpose associated with the sequence step. You can use only the attribute id to filter
            sequenceSteps by callPurpose (e.g. filter[callPurpose][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - callPurpose
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        calls:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The calls associated with the sequence step. You can use only the attribute id to filter sequenceSteps by calls
            (e.g. filter[calls][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the sequence step. You can use only the attribute id to filter sequenceSteps by creator (e.g. filter[creator][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The mailings associated with the sequence step. Relationship mailings cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        schedule:
          description: The associated schedule
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - schedule
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequence:
          description: The associated sequence. You can use attributes id, enabledAt and name to filter sequenceSteps by sequence
            (e.g. filter[sequence][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceTemplates:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence templates in use by this sequence step. You can use any filterable attribute of sequenceTemplates.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - sequenceTemplate
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        taskPriority:
          description: The associated task priority. You can use only the attribute id to filter sequenceSteps by taskPriority
            (e.g. filter[taskPriority][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskPriority
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The tasks associated with the sequence step. You can use only the attribute id to filter sequenceSteps by tasks
            (e.g. filter[tasks][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the sequence step. You can use only the attribute id to filter sequenceSteps by updater
            (e.g. filter[updater][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    sequenceStepResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/sequenceStep'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/sequenceStepRelationships'
        type:
          type: string
      type: object
      x-internal: false
    sequenceTemplate:
      description: 'An object used to track which templates are in use by which sequence steps.

        '
      properties:
        bounceCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of bounced mailings during this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        clickCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of clicked mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the sequence template was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        deliverCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of delivered mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        enabled:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Boolean indicating if the sequence template is currently enabled.'
          nullable: true
          type: boolean
          x-internal: false
        enabledAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            Datetime for when the sequence template was enabled.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        failureCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of failed mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        isReply:
          description: '


            Boolean indicating if the sequence template should be a reply email or a new thread.'
          nullable: true
          type: boolean
          x-internal: false
        negativeReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of negative reply mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        neutralReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of neutral reply mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        openCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of opened mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        optOutCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of opted out mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        positiveReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of positive reply mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        replyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of replied mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        scheduleCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of scheduled mailings from this sequence template.'
          nullable: true
          type: integer
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the sequence template was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    sequenceTemplateRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            User that created the sequence template. You can use only the attribute id to filter sequenceTemplates by creator
            (e.g. filter[creator][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStep:
          description: The sequence step that uses the sequence template. You can use any filterable attribute of sequenceStep.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        template:
          description: The template used for this sequence template. You can use only the attribute id to filter sequenceTemplates
            by template (e.g. filter[template][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - template
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            User that last updated the sequence template. You can use only the attribute id to filter sequenceTemplates by
            updater (e.g. filter[updater][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    sequenceTemplateResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/sequenceTemplate'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/sequenceTemplateRelationships'
        type:
          type: string
      type: object
      x-internal: false
    smartViewNotificationRelationships:
      properties:
        owner:
          description: The owner of the notificiation.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        smartView:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - smartView
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    smartViewRelationships:
      properties:
        owner:
          description: The owner of the smart view.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        smartViewNotifications:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The notifications associated with this smart view.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    snippet:
      description: 'A piece of an email to be reused in multiple messages.

        '
      properties:
        bodyHtml:
          description: '


            The HTML of the snippet.'
          maxLength: 16777215
          nullable: true
          type: string
          x-internal: false
        bodyText:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The text of the snippet.'
          maxLength: 16777215
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the snippet was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the snippet.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        shareType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The permissions for sharing the snippet; must be "private" or "shared."'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        tags:
          description: '


            A list of tags associated with the snippet (e.g. ["Useful", "Prospecting"]).'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the snippet was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    snippetRelationships:
      properties:
        contentCategoryMemberships:
          description: The content categories (collections) of the snippet. You can use only the attribute id to filter snippets
            by contentCategoryMemberships (e.g. filter[contentCategoryMemberships][id]=X).
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - contentCategoryMembership
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the snippet. You can use only the attribute id to filter snippets by creator (e.g. filter[creator][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        favorites:
          description: The snippet favorited by the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - favorite
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of the snippet. You can use only the attribute id to filter snippets by owner (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The updater of the snippet. You can use only the attribute id to filter snippets by updater (e.g. filter[updater][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    snippetResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/snippet'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/snippetRelationships'
        type:
          type: string
      type: object
      x-internal: false
    stage:
      description: 'A descriptor of the point in the process, used for categorizing Prospects.

        '
      properties:
        color:
          description: '


            The color the stage label will be highlighted in the interface, specified as a hexidecimal value (e.g. "#5951ff").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the stage was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the stage (e.g. "Qualified Lead").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The stage''s display order within the collection.'
          nullable: true
          type: integer
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the stage was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    stageRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the stage. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospects:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The prospects associated to the stage. You can use only the attribute id to filter stages by prospects (e.g. filter[prospects][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the stage. Relationship updater cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    stageResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/stage'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/stageRelationships'
        type:
          type: string
      type: object
      x-internal: false
    surveyQuestionOptionRelationships:
      properties:
        surveyQuestion:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - surveyQuestion
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        surveyUserResponses:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - surveyUserResponse
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    surveyQuestionRelationships:
      properties:
        survey:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - survey
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        surveyQuestionOptions:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - surveyQuestionOption
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        surveyUserResponses:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - surveyUserResponse
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    surveyRelationships:
      properties:
        surveyQuestions:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - surveyQuestion
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        surveyUserResponses:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - surveyUserResponse
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    surveyUserResponseRelationships:
      properties:
        survey:
          description: Survey associated with this response.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - survey
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        surveyQuestion:
          description: Survey questions associated with this response.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - surveyQuestion
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        surveyQuestionOption:
          description: Survey question option associated with this response.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - surveyQuestionOption
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The user who responded.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    tagRelationships:
      type: object
    task:
      description: 'An item that requires action to complete.

        '
      properties:
        action:
          description: '


            The action type of the task. Can be ''action_item'', ''call'', ''email'', or ''in_person''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        autoskipAt:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The optional date and time when the task will automatically be skipped. Tasks with an empty autoskip_at will never
            be autoskipped.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        compiledSequenceTemplateHtml:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The compiled template HTML of incomplete SMS or LinkedIn tasks associated with a sequence.'
          nullable: true
          type: string
          x-internal: false
        completed:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A boolean value whether the task has been completed.'
          nullable: true
          type: boolean
          x-internal: false
        completedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the task was completed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        dueAt:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task is due.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        note:
          description: '


            An optional note for the task.'
          maxLength: 65535
          nullable: true
          type: string
          x-internal: false
        opportunityAssociation:
          description: '


            The optional opportunity rule associated with the task. Can be ''recent_created'', ''recent_updated'', ''noop''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        scheduledAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the pending task is scheduled for.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        state:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The current state of the task. Can be ''pending'', ''incomplete'', or ''complete''.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        stateChangedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the state last changed.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        taskType:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The type of task. Can be ''follow_up'', ''manual'', ''no_reply'', ''sequence_open'', ''sequence_click'', ''sequence_step_call'',
            ''sequence_step_email'', ''sequence_step_linkedin_interact_with_post'', ''sequence_step_linkedin_other'', ''sequence_step_linkedin_send_connection_request'',
            ''sequence_step_linkedin_send_message'', ''sequence_step_linkedin_view_profile'', ''sequence_step_sms'', ''sequence_step_task'',
            or ''touch''. Tasks created through the API will automatically be ''manual'' tasks.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    taskDisposition:
      description: 'A collection of task dispositions that help categorize your tasks.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task disposition was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The disposition’s name (e.g. "Initial Contact").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The disposition’s display order within the collection.'
          nullable: true
          type: integer
          x-internal: false
        taskType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The disposition’s task type (e.g. "Meeting in Person").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task disposition was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        value:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The disposition’s value.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    taskDispositionRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the task disposition. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The tasks made with this disposition. Relationship tasks cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    taskDispositionResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/taskDisposition'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/taskDispositionRelationships'
        type:
          type: string
      type: object
      x-internal: false
    taskPriority:
      description: 'A descriptor of importance used for categorizing Tasks.

        '
      properties:
        color:
          description: '


            The color the task priority label will be highlighted in the interface, specified as a hexadecimal value (e.g.
            "0xFF5951FF").'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task priority was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the task priority (e.g. "High").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task priority was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        weight:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A relative value used for display order. Task priorities are listed from lowest to highest weight.'
          nullable: true
          type: integer
          x-internal: false
      type: object
      x-internal: false
    taskPriorityRelationships:
      properties:
        sequenceSteps:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence steps. Relationship sequenceSteps cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated tasks. Relationship tasks cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    taskPriorityResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/taskPriority'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/taskPriorityRelationships'
        type:
          type: string
      type: object
      x-internal: false
    taskPurpose:
      description: 'A collection of task purposes that help categorize your tasks.

        '
      properties:
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task purpose was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The purpose’s name (e.g. "Initial Contact").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        order:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The purpose’s display order within the collection.'
          nullable: true
          type: integer
          x-internal: false
        taskType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The purpose’s task type (e.g. "Meeting in Person").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the task purpose was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    taskPurposeRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the task purpose. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        tasks:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The tasks made with this purpose. Relationship tasks cannot be used as a filter.'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    taskPurposeResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/taskPurpose'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/taskPurposeRelationships'
        type:
          type: string
      type: object
      x-internal: false
    taskRelationships:
      properties:
        account:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated account. You can use only the attribute id to filter tasks by account (e.g. filter[account][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        call:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated call, if a call task. You can use only the attribute id to filter tasks by call (e.g. filter[call][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - call
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        calls:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated calls, if a call task. You can use only the attribute id to filter tasks by calls (e.g. filter[calls][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        completer:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The completer of this task. You can use only the attribute id to filter tasks by completer (e.g. filter[completer][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of this task. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  - stage
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        defaultPluginMapping:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - pluginMapping
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailing:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated mailing, if a mailing task. You can use only the attribute id to filter tasks by mailing (e.g.
            filter[mailing][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailing
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailings:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated mailings, if a mailing task. You can use only the attribute id to filter tasks by mailings (e.g.
            filter[mailings][id]=X).'
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        opportunity:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated opportunity. You can use only the attribute id to filter tasks by opportunity (e.g. filter[opportunity][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - opportunity
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of this task. You can use attributes id, email and firstName to filter tasks by owner (e.g.
            filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospect:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated prospect. You can use attributes id, byPersonaId, byStageId, createdAt, firstName, tags, title
            and updatedAt to filter tasks by prospect (e.g. filter[prospect][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospectAccount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The account of the associated prospect.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospectContacts:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The contacts of the associated prospect.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - emailAddress
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospectOwner:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The owner of the associated prospect.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospectPhoneNumbers:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The phone numbers of the associated prospect.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - phoneNumber
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        prospectStage:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The stage of the associated prospect.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - stage
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequence:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence. You can use attributes id and tags to filter tasks by sequence (e.g. filter[sequence][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequence
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceSequenceSteps:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence steps of the associated sequence. You can use only the attribute id to filter tasks by sequenceSequenceSteps
            (e.g. filter[sequenceSequenceSteps][id]=X).'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - sequenceStep
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceState:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence state. You can use only the attribute id to filter tasks by sequenceState (e.g. filter[sequenceState][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceState
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStateSequenceStep:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence step of the associated sequence state.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStateSequenceStepOverrides:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence step overrides of the associated sequence state.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - sequenceStepOverride
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStateStartingTemplate:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The starting template of the associated sequence state.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - template
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStep:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence step. You can use attributes id and stepType to filter tasks by sequenceStep (e.g. filter[sequenceStep][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceStep
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceStepOverrideTemplates:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The templates of the associated sequence step overrides.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - template
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceTemplate:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated sequence template. You can use only the attribute id to filter tasks by sequenceTemplate (e.g.
            filter[sequenceTemplate][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - sequenceTemplate
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceTemplateTemplate:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The template of the associated sequence template.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - template
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        subject:
          description: The task's subject, either an account or prospect. Relationship subject cannot be used as a filter.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - account
                  - opportunity
                  - prospect
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        taskDisposition:
          description: The associated task disposition.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskDisposition
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        taskPriority:
          description: The associated task priority. You can use attributes id and name to filter tasks by taskPriority (e.g.
            filter[taskPriority][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskPriority
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        taskPurpose:
          description: The associated task purpose.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskPurpose
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        taskTheme:
          description: The associated task theme.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - taskTheme
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        team:
          description: The task's team, will tell you this task was assigned to which team.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        template:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The associated template. You can use only the attribute id to filter tasks by template (e.g. filter[template][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - template
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    taskResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/task'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/taskRelationships'
        type:
          type: string
      type: object
      x-internal: false
    taskThemeRelationships:
      type: object
    team:
      description: 'A descriptor of a group of users.

        '
      properties:
        color:
          description: '


            The color used to label and highlight the team.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the team was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the team (e.g. "SDRs").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        scimExternalId:
          description: '


            The ID from the SCIM provisioning service used to create the team.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        scimSource:
          description: '


            The name of the SCIM provisioning source used to create the team.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the team was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    teamMembershipRelationships:
      properties:
        team:
          description: The team associated with the team membership.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user associated with the team membership.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    teamRecordRelationships:
      properties:
        record:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - role
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        team:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    teamRelationships:
      properties:
        batches:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        contentCategories:
          description: The content categories that are assigned to the team. Relationship contentCategories cannot be used
            as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - contentCategory
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the team. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        favorites:
          description: The team favorited by the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - favorite
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        roleAssignedUsers:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - user
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        teamMemberships:
          description: The membership info of users to the team
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - teamMembership
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        teamRecords:
          description: Data records that are associated with the team.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - teamRecord
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        teamSettings:
          description: Settings to apply to the team. This field is not yet supported and should not be used.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - teamSettings
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the team. Relationship updater cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        users:
          description: The users associated with the team. You can use only the attribute id to filter teams by users (e.g.
            filter[users][id]=X).
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - user
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    teamResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/team'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/teamRelationships'
        type:
          type: string
      type: object
      x-internal: false
    teamSettingsRelationships:
      properties:
        profile:
          description: The governance profile that is applied to the team.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - profile
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        team:
          description: The team the settings apply to.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - team
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    template:
      description: 'A reusable template for building emails.

        '
      properties:
        archived:
          description: '


            Boolean value indicating if the template has been archived.'
          nullable: true
          type: boolean
          x-internal: false
        archivedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the template was archived.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        bccRecipients:
          description: '


            A list of default person and email address pairs to receive this template in the "bcc" field (e.g. [Billy Bob
            `<billy.bob@seattle.city>`])'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        bodyHtml:
          description: '


            The body HTML of the template.'
          maxLength: 16777215
          nullable: true
          type: string
          x-internal: false
        bodyText:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The body text of the template.'
          maxLength: 16777215
          nullable: true
          type: string
          x-internal: false
        bounceCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of bounced mailings during this template.'
          nullable: true
          type: integer
          x-internal: false
        ccRecipients:
          description: '


            A list of default person and email address pairs to receive this template in the "cc" field (e.g. [Billy Bob `<billy.bob@seattle.city>`])'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        clickCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of clicked mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the template was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        deliverCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of delivered mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        failureCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of failed mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        lastUsedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The last time the template was used.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The name of the template.'
          maxLength: 225
          nullable: true
          type: string
          x-internal: false
        negativeReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of negative reply mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        neutralReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of neutral reply mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        openCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of opened mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        optOutCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of opted out mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        positiveReplyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of positive reply mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        replyCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The total count of replied mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        scheduleCount:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The total count of scheduled mailings from this template.'
          nullable: true
          type: integer
          x-internal: false
        shareType:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The share type must be one of "read_only," "private," or "shared".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        subject:
          description: '


            The subject line for the email to be sent.'
          nullable: true
          type: string
          x-internal: false
        tags:
          description: '


            A list of tag values associated with the template (e.g. ["Sequencing", "Quick Response"]).'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        toRecipients:
          description: '


            A list of default person and email address pairs to receive this template in the "to" field (e.g. ["Billy Bob
            <billy.bob@seattle.city>"])'
          items:
            type: string
          nullable: true
          type: array
          x-internal: false
        trackLinks:
          description: '


            Boolean value indicating if link tracking is on for the template.'
          nullable: true
          type: boolean
          x-internal: false
        trackOpens:
          description: '


            Boolean value indicating if open tracking is on for the template.'
          nullable: true
          type: boolean
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the template was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    templateRelationships:
      properties:
        attachments:
          description: The attachments to be sent with this template.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - attachment
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        contentCategoryMemberships:
          description: The content cateogories with which this template is associated. Relationship contentCategoryMemberships
            cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - contentCategoryMembership
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the template. You can use only the attribute id to filter templates by creator (e.g. filter[creator][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        favorites:
          description: The template favorited by the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - favorite
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        owner:
          description: The owner of the template. You can use only the attribute id to filter templates by owner (e.g. filter[owner][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        recipients:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            A list of default email addresses to receive this template. You can use only the attribute id to filter templates
            by recipients (e.g. filter[recipients][id]=X).'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - recipient
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        sequenceTemplates:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The sequence templates using the template for their content. Relationship sequenceTemplates cannot be used as
            a filter.'
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - sequenceTemplate
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        statsTarget:
          description: The template that collects all the metrics instead of current one.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - template
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the template. You can use only the attribute id to filter templates by updater (e.g. filter[updater][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    templateResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/template'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/templateRelationships'
        type:
          type: string
      type: object
      x-internal: false
    territoryModelRelationships:
      type: object
    territoryRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of territory'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        forecastManager:
          description: The forecast manager for territory
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        parentTerritory:
          description: The parent territory of territory
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - territory
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        territoryModel:
          description: The model of territory
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - territoryModel
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        territoryType:
          description: The type of territory
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - territoryType
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The updater of territory'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    territoryTypeRelationships:
      type: object
    uploadResponse:
      properties:
        attributes:
          properties:
            storageKey:
              description: the reference to the upload to use in following API calls such as import.
              type: string
            uploadURL:
              description: the AWS S3 presigned URL at which the file should be uploaded.
              type: string
          type: object
        type:
          type: string
      type: object
    user:
      description: The individual that uses the application. See https://developers.outreach.io/api/common-patterns/#invite-new-users
        for more information on inviting new users.
      properties:
        accountsViewId:
          description: '


            The default smart view to load on the account index view.'
          nullable: true
          type: integer
          x-internal: false
        activityNotificationsDisabled:
          description: '


            A boolean value whether the user''s activity notifications are disabled.'
          nullable: true
          type: boolean
          x-internal: false
        bounceWarningEmailEnabled:
          description: '


            A boolean value whether the user''s bounce warning emails are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        bridgePhone:
          description: '


            The telephone number of the user''s outbound bridge phone.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        bridgePhoneExtension:
          description: '


            The extension number of the user''s outbound bridge phone.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        callsViewId:
          description: '


            The default smart view to load on the calls view.'
          nullable: true
          type: integer
          x-internal: false
        controlledTabDefault:
          description: '


            The user''s preferred default tab to open when in task flow.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the user was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        currentSignInAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the user most recently signed in.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        custom1:
          description: '


            The value of the user''s first custom field.'
          maxLength: 225
          nullable: true
          type: string
          x-internal: false
        custom2:
          description: '


            The value of the user''s second custom field.'
          maxLength: 225
          nullable: true
          type: string
          x-internal: false
        custom3:
          description: '


            The value of the user''s third custom field.'
          maxLength: 225
          nullable: true
          type: string
          x-internal: false
        custom4:
          description: '


            The value of the user''s fourth custom field.'
          maxLength: 225
          nullable: true
          type: string
          x-internal: false
        custom5:
          description: '


            The value of the user''s fifth custom field.'
          maxLength: 225
          nullable: true
          type: string
          x-internal: false
        dailyDigestEmailEnabled:
          description: '


            A boolean value whether the user''s daily digest emails are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        defaultRulesetId:
          description: '


            The id of the default ruleset assigned to the user.'
          nullable: true
          type: integer
          x-internal: false
        duties:
          description: '


            A collection of the user''s work roles.'
          nullable: true
          type: object
          x-internal: false
        email:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The email address of the user. Cannot be updated via the API.'
          format: email
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        enableVoiceRecordings:
          description: '


            A boolean value whether the user has voice recordings enabled.'
          nullable: true
          type: boolean
          x-internal: false
        engagementEmailsEnabled:
          description: '


            A boolean value whether the user has engagement emails enabled.'
          nullable: true
          type: boolean
          x-internal: false
        firstName:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The first name of the user.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        inboundBridgePhone:
          description: '


            The telephone number of the user''s inbound bridge phone.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        inboundBridgePhoneExtension:
          description: '


            The extension number of the user''s inbound bridge phone.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        inboundCallBehavior:
          description: '


            The behavior of inbound calls. Must be either "inbound_bridge" or "inbound_voicemail".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        inboundPhoneType:
          description: '


            The user''s type of telephone for inbound calls. Must be either "bridge", "voip" or "bridge_and_voip".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        inboundVoicemailCustomMessageText:
          description: '


            The message for inbound voicemails (e.g. "Please leave a message and I will get back to you as soon I can").'
          maxLength: 1024
          nullable: true
          type: string
          x-internal: false
        inboundVoicemailMessageTextVoice:
          description: '


            The gender of the voice that reads the voicemail message. Must be either "man" or "woman".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        inboundVoicemailPromptType:
          description: '


            The type of inbound voicemail to use. Must be either "automated", "recorded", or "off".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        jobRoleByName:
          description: '<img src=https://developers.outreach.io/badges/writeonly.svg>


            The name of the job role (e.g. "SDR").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        kaiaRecordingsViewId:
          description: '


            The default smart view to load on the kaia recordings view.'
          nullable: true
          type: integer
          x-internal: false
        keepBridgePhoneConnected:
          description: '


            Whether to keep the user''s bridge phone connected in-between outbound calls.'
          nullable: true
          type: boolean
          x-internal: false
        lastName:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The last name of the user.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        lastSignInAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the user previously signed in.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        locked:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A boolean value whether the user is locked out of the application.'
          nullable: true
          type: boolean
          x-internal: false
        mailboxErrorEmailEnabled:
          description: '


            A boolean value whether the user''s mailbox error emails are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        meetingEngagementNotificationEnabled:
          description: '


            A boolean value whether the user''s meeting engagement notifications are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        name:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The full name of the user.'
          nullable: true
          type: string
          x-internal: false
        notificationsEnabled:
          description: '


            A boolean value whether the user''s notifications are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        oceClickToDialEverywhere:
          description: '


            A boolean value indicating if phone calls will launch a call from Outreach (Salesforce, Github, Gmail, LinkedIn,
            and Twitter).'
          nullable: true
          type: boolean
          x-internal: false
        oceGmailToolbar:
          description: '


            A boolean value indicating whether the Outreach Gmail toolbar is enabled.'
          nullable: true
          type: boolean
          x-internal: false
        oceGmailTrackingState:
          description: '


            The user''s current email tracking settings when using Outreach Everywhere with GMail.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        oceSalesforceEmailDecorating:
          description: '


            A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce.'
          nullable: true
          type: boolean
          x-internal: false
        oceSalesforcePhoneDecorating:
          description: '


            A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce.'
          nullable: true
          type: boolean
          x-internal: false
        oceUniversalTaskFlow:
          description: '


            A boolean value indicating whether Outreach Everywhere universal task flow is enabled.'
          nullable: true
          type: boolean
          x-internal: false
        oceWindowMode:
          description: '


            A boolean value indicating whether Outreach Everywhere window mode is enabled.'
          nullable: true
          type: boolean
          x-internal: false
        opportunitiesViewId:
          description: '


            The default smart view to load on the opportunity index view.'
          nullable: true
          type: integer
          x-internal: false
        passwordExpiresAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the current password expires.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        phoneCountryCode:
          description: '


            The country code of the user''s phone.'
          maxLength: 2
          nullable: true
          type: string
          x-internal: false
        phoneNumber:
          description: '


            The telephone number of the user''s phone.'
          nullable: true
          type: string
          x-internal: false
        phoneType:
          description: '


            The user''s type of telephone for outbound calls. Must be either "bridge" or "voip".'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        pluginAlertNotificationEnabled:
          description: '


            A boolean value whether the user''s plugin related error notifications are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        preferredVoiceRegion:
          description: '


            A string that represents Twilio data center used to connect to Twilio.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        prefersLocalPresence:
          description: '


            A boolean value whether the user prefers that a voice call comes from a local phone number.'
          nullable: true
          type: boolean
          x-internal: false
        prospectsViewId:
          description: '


            The default smart view to load on the prospect index view.'
          nullable: true
          type: integer
          x-internal: false
        reportsTeamPerfViewId:
          description: '


            The default smart view to load on the team performance reports view.'
          nullable: true
          type: integer
          x-internal: false
        reportsViewId:
          description: '


            The default smart view to load on the reports view.'
          nullable: true
          type: integer
          x-internal: false
        scimExternalId:
          description: '


            The ID from the SCIM provisioning service used to create the user.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        scimSource:
          description: '


            The name of the SCIM provisioning source used to create the user.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        senderNotificationsExcluded:
          description: '


            A boolean value whether the user''s sender notifications are excluded.'
          nullable: true
          type: boolean
          x-internal: false
        tasksViewId:
          description: '


            The default smart view to load on the tasks index view.'
          nullable: true
          type: integer
          x-internal: false
        teamsViewId:
          description: '


            The default smart view to load on the teams index view.'
          nullable: true
          type: integer
          x-internal: false
        textingEmailNotifications:
          description: '


            A boolean value whether to send the user email notifications when a text message is missed.'
          nullable: true
          type: boolean
          x-internal: false
        title:
          description: '


            The user''s job title (e.g. "Staff Accountant").'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        unknownReplyEmailEnabled:
          description: '


            A boolean value whether the user''s unknown reply emails are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg> <img src=https://developers.outreach.io/badges/filterable.svg>
            <img src=https://developers.outreach.io/badges/sortable.svg>


            The date and time the user was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        userGuid:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The globally unique ID (GUID) assigned to the user.'
          nullable: true
          type: string
          x-internal: false
        username:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A reader friendly unique identifier of the user.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        usersViewId:
          description: '


            The default smart view to load on the users index view.'
          nullable: true
          type: integer
          x-internal: false
        voicemailNotificationEnabled:
          description: '


            A boolean value whether the user''s voicemail notifications are enabled.'
          nullable: true
          type: boolean
          x-internal: false
        weeklyDigestEmailEnabled:
          description: '


            A boolean value whether the user''s weekly digest email are enabled.'
          nullable: true
          type: boolean
          x-internal: false
      type: object
      x-internal: false
    userRelationships:
      properties:
        batches:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            '
          properties:
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        calendar:
          description: The calendar associated with the user.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - calendar
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        contentCategories:
          description: The groupings of sequences, snippets and templates that this user has access to. Relationship contentCategories
            cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - contentCategory
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        contentCategoryOwnerships:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - contentCategoryOwnership
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the user. Relationship creator cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        directAssignedTeams:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        favorites:
          description: The user favorited by the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - favorite
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        jobRole:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - jobRole
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailbox:
          description: The default mailbox associated with the user. Relationship mailbox cannot be used as a filter.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - mailbox
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        mailboxes:
          description: All mailboxes associated with the user. Relationship mailboxes cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - mailbox
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        outboundVoicemails:
          description: The list of outbound voicemails associated with the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - outboundVoicemail
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        phone:
          description: The default phone to use outbound or inbound voice calls.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - phone
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        phones:
          description: The list of phones associated with the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - phone
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        profile:
          description: The user's profile in Outreach. You can use only the attribute id to filter users by profile (e.g.
            filter[profile][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - profile
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        recipients:
          description: Recipients that will be included by default in all emails composed by user. Relationship recipients
            cannot be used as a filter.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - recipient
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        role:
          description: The role associated with the user. You can use only the attribute id to filter users by role (e.g.
            filter[role][id]=X).
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - role
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        roleAssignedTeams:
          description: ''
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        smsPhone:
          description: The default phone to use for SMS messaging.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - phone
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        teams:
          description: The teams the user belongs to. You can use only the attribute id to filter users by teams (e.g. filter[teams][id]=X).
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - team
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the user. Relationship updater cannot be used as a filter.'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        voicemailPrompts:
          description: The list of voicemail prompts associated with the user.
          properties:
            data:
              items:
                properties:
                  id:
                    type: integer
                  type:
                    enum:
                    - voicemailPrompt
                    type: string
                type: object
              type: array
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    userResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/user'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/userRelationships'
        type:
          type: string
      type: object
      x-internal: false
    userTerritoryAssociationRelationships:
      properties:
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of user territory association'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        territory:
          description: The terriory of user territory association
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - territory
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The updater of user territory association'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        user:
          description: The user of user territory association
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    validateUploadResponse:
      properties:
        attributes:
          properties:
            headerValue:
              description: the headers of the uploaded file with the first value
              properties:
                header:
                  description: the header name
                  type: string
                value:
                  description: the first value of the header
                  type: string
              type: object
            recordCount:
              description: the number of records in the uploaded file.
              type: integer
          type: object
        type:
          type: string
      type: object
    voicePluginRelationships:
      type: object
    voicemailPromptRelationships:
      properties:
        user:
          description: ''
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    webhook:
      description: 'A configurable notification that submits external JSON-API-formatted HTTP requests whenever resources
        are modified.

        '
      properties:
        action:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The action that will trigger this webhook (e.g. "*", "created", "updated", "destroyed"). Webhooks will only execute
            if both the action and resource match.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        active:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            A boolean value indicating whether the webhook is active.'
          nullable: true
          type: boolean
          x-internal: false
        createdAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the webhook was created.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        disabledReason:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The reason why webhook got temporarily disabled. Any update to a webhook resets this to a null value.'
          maxLength: 1024
          nullable: true
          type: string
          x-internal: false
        disabledSince:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time when the webhook got temporarily disabled for the first time. Any update to a webhook resets
            this to a null value.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        disabledUntil:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time till when the webhook got temporarily disabled. Any update to a webhook resets this to a null
            value.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        payloadVersion:
          description: '


            Format of the body data sent when the webhook makes a request. Valid values are 1 or 2.'
          nullable: true
          type: integer
          x-internal: false
        resource:
          description: '<img src=https://developers.outreach.io/badges/filterable.svg> <img src=https://developers.outreach.io/badges/sortable.svg>


            The resource that will trigger this webhook (e.g. "*", "prospect", "sequenceState"). Webhooks will only execute
            if both the action and resource match.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        secret:
          description: '


            A private token used to verify the authenticity of incoming webhook payloads.'
          maxLength: 255
          nullable: true
          type: string
          x-internal: false
        updatedAt:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The date and time the webhook was last updated.'
          format: date-time
          nullable: true
          type: string
          x-internal: false
        url:
          description: '


            The URL where the webhook will route its POST HTTP request.'
          maxLength: 1024
          nullable: true
          type: string
          x-internal: false
      type: object
      x-internal: false
    webhookRelationships:
      properties:
        authorizer:
          description: The authorizer of the webhook. The webhook will not deliver results if the authorizer does not have
            permission to read the resource being returned. Relationship authorizer cannot be used as a filter.
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        creator:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The creator of the webhook. You can use only the attribute id to filter webhooks by creator (e.g. filter[creator][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
        updater:
          description: '<img src=https://developers.outreach.io/badges/readonly.svg>


            The most recent updater of the webhook. You can use only the attribute id to filter webhooks by updater (e.g.
            filter[updater][id]=X).'
          properties:
            data:
              nullable: true
              properties:
                id:
                  type: integer
                type:
                  enum:
                  - user
                  type: string
              type: object
            links:
              properties:
                related:
                  format: uri
                  type: string
              type: object
      type: object
    webhookResponse:
      properties:
        attributes:
          $ref: '#/components/schemas/webhook'
        id:
          type: integer
        relationships:
          $ref: '#/components/schemas/webhookRelationships'
        type:
          type: string
      type: object
      x-internal: false
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
    s2sAuthToken:
      bearerFormat: JWT
      scheme: bearer
      type: http