Outreach Batch API

openapi: 3.2.0
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 Batch API
  version: ''
servers:
- url: https://api.outreach.io/api/v2
security:
- bearerAuth: []
tags:
- 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
paths:
  /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
    

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/outreach/refs/heads/main/openapi/outreach-batch-api-openapi.yml