Marketo Smart Lists API

openapi: 3.0.1
info:
  title: Marketo Engage Rest Approve Smart  Lists API
  description: Marketo exposes a REST API which allows for remote execution of many of the systems capabilities. From creating programs to bulk lead import, there are many options which allow fine-grained control of a Marketo instance.
  termsOfService: https://www.adobe.com/legal.html
  contact:
    name: Adobe Developer Relations
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
    email: developerfeedback@marketo.com
  license:
    name: API License Agreement
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/api-license
  version: '1.0'
servers:
- url: https://localhost:8080/
tags:
- name: Smart  Lists
paths:
  /rest/asset/v1/smartList/{id}.json:
    get:
      tags:
      - Smart  Lists
      summary: Marketo Get Smart List by Id
      description: 'Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset'
      operationId: getSmartListByIdUsingGET
      parameters:
      - name: id
        in: path
        description: Id of the smart list to retrieve
        required: true
        schema:
          type: integer
          format: int64
      - name: includeRules
        in: query
        description: Set true to populate smart list rules. Default false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfSmartListResponseWithRules'
  /rest/asset/v1/smartList/{id}/delete.json:
    post:
      tags:
      - Smart  Lists
      summary: Marketo Delete Smart List
      description: 'Deletes the designated Smart List. Required Permissions: Read-Write Asset'
      operationId: deleteSmartListByIdUsingPOST
      parameters:
      - name: id
        in: path
        description: Id of the smart list to delete
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfIdResponse'
  /rest/asset/v1/smartLists.json:
    get:
      tags:
      - Smart  Lists
      summary: Marketo Get Smart Lists
      description: 'Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset'
      operationId: getSmartListsUsingGET
      parameters:
      - name: folder
        in: query
        description: JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
        schema:
          type: string
      - name: offset
        in: query
        description: Integer offset for paging
        schema:
          type: integer
          format: int32
      - name: maxReturn
        in: query
        description: Maximum number of smart lists to return. Max 200, default 20.
        schema:
          type: integer
          format: int32
      - name: earliestUpdatedAt
        in: query
        description: Exclude smart lists prior to this date. Must be valid ISO-8601 string. See <a href="http://developers.marketo.com/rest-api/lead-database/fields/field-types/">Datetime</a> field type description.
        schema:
          type: string
      - name: latestUpdatedAt
        in: query
        description: Exclude smart lists after this date. Must be valid ISO-8601 string. See <a href="http://developers.marketo.com/rest-api/lead-database/fields/field-types/">Datetime</a> field type description.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfSmartListResponse'
  /rest/asset/v1/smartList/{id}/clone.json:
    post:
      tags:
      - Smart  Lists
      summary: Marketo Clone Smart List
      description: 'Clones the designated Smart List. Required Permissions: Read-Write Asset'
      operationId: cloneSmartListUsingPOST
      parameters:
      - name: id
        in: path
        description: Id of smart list to clone
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: cloneSmartListRequest
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CloneSmartListRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfSmartListResponse'
      x-codegen-request-body-name: cloneSmartListRequest
components:
  schemas:
    Folder:
      required:
      - id
      - type
      type: object
      properties:
        id:
          type: integer
          description: Id of the folder
          format: int32
        type:
          type: string
          description: Type of folder
          enum:
          - Folder
          - Program
      description: JSON representation of a folder
    SmartListConditions:
      required:
      - activityAttributeId
      - activityAttributeName
      - isPrimary
      - operator
      - values
      type: object
      properties:
        activityAttributeId:
          type: integer
          description: Id of the activity attribute
          format: int32
        activityAttributeName:
          type: string
          description: Name of activity attribute
        operator:
          type: string
          description: Value of operator
        values:
          type: array
          description: List of values
          items:
            type: string
        isPrimary:
          type: boolean
          description: Whether the condition is primary or not (first condition of the smart list)
      description: JSON representation of smart list conditions
    ResponseOfSmartListResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/SmartListResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    CloneSmartListRequest:
      required:
      - folder
      - name
      type: object
      properties:
        name:
          type: string
          description: Name for the cloned smart list
        folder:
          $ref: '#/components/schemas/Folder'
        description:
          type: string
          description: Description of the cloned smart list
    SmartListRules:
      required:
      - filterMatchType
      - filters
      - triggers
      type: object
      properties:
        filterMatchType:
          type: string
          description: Smart list filter match type (rule logic)
          enum:
          - All
          - Any
          - Advanced
        triggers:
          type: array
          description: List of smart list triggers
          items:
            type: string
        filters:
          type: array
          description: List of smart list filters
          items:
            $ref: '#/components/schemas/SmartListFilters'
      description: JSON representation of smart list rules
    SmartListFilters:
      required:
      - conditions
      - id
      - name
      - operator
      - ruleType
      - ruleTypeId
      type: object
      properties:
        id:
          type: integer
          description: Id of the filter
          format: int32
        name:
          type: string
          description: Name of filter
        ruleTypeId:
          type: integer
          description: Id of the rule type
          format: int32
        ruleType:
          type: string
          description: Name of rule type
        operator:
          type: string
          description: Name of operator
        conditions:
          type: array
          description: List of smart list conditions
          items:
            $ref: '#/components/schemas/SmartListConditions'
      description: JSON representation of smart list filters
    SmartListResponseWithRules:
      required:
      - createdAt
      - description
      - folder
      - id
      - name
      - updatedAt
      - url
      - workspace
      type: object
      properties:
        id:
          type: integer
          description: Id of the smart list
          format: int64
        name:
          type: string
          description: Name of the smart list
        description:
          type: string
          description: Description of the smart list
        createdAt:
          type: string
          description: Datetime the smart list was created
          format: date-time
        updatedAt:
          type: string
          description: Datetime the smart list was most recently updated
          format: date-time
        url:
          type: string
          description: Url of the smart list in the Marketo UI
        folder:
          $ref: '#/components/schemas/Folder'
        workspace:
          type: string
          description: Name of the workspace
        rules:
          $ref: '#/components/schemas/SmartListRules'
    ResponseOfIdResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/IdResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    SmartListResponse:
      required:
      - createdAt
      - description
      - folder
      - id
      - name
      - updatedAt
      - url
      - workspace
      type: object
      properties:
        id:
          type: integer
          description: Id of the smart list
          format: int64
        name:
          type: string
          description: Name of the smart list
        description:
          type: string
          description: Description of the smart list
        createdAt:
          type: string
          description: Datetime the smart list was created
          format: date-time
        updatedAt:
          type: string
          description: Datetime the smart list was most recently updated
          format: date-time
        url:
          type: string
          description: Url of the smart list in the Marketo UI
        folder:
          $ref: '#/components/schemas/Folder'
        workspace:
          type: string
          description: Name of the workspace
    IdResponse:
      required:
      - id
      type: object
      properties:
        id:
          type: integer
          description: Id of the asset
          format: int32
    Error:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: Error code of the error. See full list of error codes <a href="https://developers.marketo.com/rest-api/error-codes/">here</a>
        message:
          type: string
          description: Message describing the cause of the error
    ResponseOfSmartListResponseWithRules:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/SmartListResponseWithRules'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
x-original-swagger-version: '2.0'