Salesforce Favorite API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Favorite API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Favorite
paths:
  /data/v64.0/ui-api/favorites:
    parameters: []
    post:
      tags:
      - Favorite
      summary: Salesforce Create a Favorite
      description: Create a Favorite
      operationId: CreateaFavorite
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateaFavoriteRequest'
              - examples:
                - name: Favorite Name
                  sortOrder: 1
                  target: API Name or ID
                  targetType: ListView | ObjectHome | Record | Tab
              contentMediaType: application/json
            example:
              name: Favorite Name
              sortOrder: 1
              target: API Name or ID
              targetType: ListView | ObjectHome | Record | Tab
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:03:31 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/CreateaFavoritelistview'
                - examples:
                  - accessCount: 1
                    iconColor: 5867E8
                    iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                    id: 0MV4H0000004qIeWAI
                    lastAccessDate: '2023-10-06T10:03:32.000Z'
                    name: AllAccountsListView
                    objectType: Account
                    sortOrder: 1
                    subtitle: Accounts
                    target: 00B58000002ssinEAA
                    targetType: ListView
                contentMediaType: application/json;charset=UTF-8
              example:
                accessCount: 1
                iconColor: 5867E8
                iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                id: 0MV4H0000004qIeWAI
                lastAccessDate: '2023-10-06T10:03:32.000Z'
                name: AllAccountsListView
                objectType: Account
                sortOrder: 1
                subtitle: Accounts
                target: 00B58000002ssinEAA
                targetType: ListView
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/ui-api/favorites/{FAVORITE_ID}:
    parameters: []
    get:
      tags:
      - Favorite
      summary: Salesforce Get a Favorite
      description: Get a favorite.
      operationId: GetaFavorite
      parameters:
      - name: FAVORITE_ID
        in: path
        description: The ID of a favorite
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:04:41 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetaFavorite'
                - examples:
                  - accessCount: 1
                    iconColor: 5867E8
                    iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                    id: 0MV4H0000004qIeWAI
                    lastAccessDate: '2023-10-06T10:03:32.000Z'
                    name: AllAccountsListView
                    objectType: Account
                    sortOrder: 1
                    subtitle: Accounts
                    target: 00B58000002ssinEAA
                    targetType: ListView
                contentMediaType: application/json;charset=UTF-8
              example:
                accessCount: 1
                iconColor: 5867E8
                iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                id: 0MV4H0000004qIeWAI
                lastAccessDate: '2023-10-06T10:03:32.000Z'
                name: AllAccountsListView
                objectType: Account
                sortOrder: 1
                subtitle: Accounts
                target: 00B58000002ssinEAA
                targetType: ListView
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - Favorite
      summary: Salesforce Update a Favorite
      description: Update a Favorite
      operationId: UpdateaFavorite
      parameters:
      - name: FAVORITE_ID
        in: path
        description: The ID of a favorite
        required: true
        schema:
          type: string
        example: '500123'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateaFavoriteRequest'
              - examples:
                - name: Red Accounts
                  sortOrder: 1
              contentMediaType: application/json
            example:
              name: Red Accounts
              sortOrder: 1
        required: true
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:06:33 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/UpdateaFavorite'
                - examples:
                  - accessCount: 1
                    iconColor: 5867E8
                    iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                    id: 0MV4H0000004qIeWAI
                    lastAccessDate: '2023-10-06T10:03:32.000Z'
                    name: AllAccountsListViewFavoriteRenamed
                    objectType: Account
                    sortOrder: 1
                    subtitle: Accounts
                    target: 00B58000002ssinEAA
                    targetType: ListView
                contentMediaType: application/json;charset=UTF-8
              example:
                accessCount: 1
                iconColor: 5867E8
                iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                id: 0MV4H0000004qIeWAI
                lastAccessDate: '2023-10-06T10:03:32.000Z'
                name: AllAccountsListViewFavoriteRenamed
                objectType: Account
                sortOrder: 1
                subtitle: Accounts
                target: 00B58000002ssinEAA
                targetType: ListView
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Favorite
      summary: Salesforce Delete a Favorite
      description: Get a favorite.
      operationId: DeleteaFavorite
      parameters:
      - name: FAVORITE_ID
        in: path
        description: The ID of a favorite
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '204':
          description: No Content
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:09:14 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            Content-Security-Policy:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: upgrade-insecure-requests
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
          content: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/ui-api/favorites/{FAVORITE_ID}/usage:
    parameters: []
    patch:
      tags:
      - Favorite
      summary: Salesforce Update Usage of a Favorite
      description: Update the usage of an individual favorite, for example, the last time and number of times the favorite was clicked.
      operationId: UpdateUsageofaFavorite
      parameters:
      - name: FAVORITE_ID
        in: path
        description: The ID of a favorite
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:09:03 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/UpdateUsageofaFavorite'
                - examples:
                  - accessCount: 2
                    iconColor: 5867E8
                    iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                    id: 0MV4H0000004qIeWAI
                    lastAccessDate: '2023-10-06T10:09:03.304Z'
                    name: RenamedAllAcountsListView
                    objectType: Account
                    sortOrder: 1
                    subtitle: Accounts
                    target: 00B58000002ssinEAA
                    targetType: ListView
                contentMediaType: application/json;charset=UTF-8
              example:
                accessCount: 2
                iconColor: 5867E8
                iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
                id: 0MV4H0000004qIeWAI
                lastAccessDate: '2023-10-06T10:09:03.304Z'
                name: RenamedAllAcountsListView
                objectType: Account
                sortOrder: 1
                subtitle: Accounts
                target: 00B58000002ssinEAA
                targetType: ListView
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateaFavoriteRequest:
      title: CreateaFavoriteRequest
      required:
      - name
      - sortOrder
      - target
      - targetType
      type: object
      properties:
        name:
          type: string
          example: Example Title
        sortOrder:
          type: integer
          contentEncoding: int32
          example: 10
        target:
          type: string
          example: example_value
        targetType:
          type: string
          example: example_value
      examples:
      - name: Favorite Name
        sortOrder: 1
        target: API Name or ID
        targetType: ListView | ObjectHome | Record | Tab
    UpdateaFavorite:
      title: UpdateaFavorite
      required:
      - accessCount
      - iconColor
      - iconUrl
      - id
      - lastAccessDate
      - name
      - objectType
      - sortOrder
      - subtitle
      - target
      - targetType
      type: object
      properties:
        accessCount:
          type: integer
          contentEncoding: int32
          example: 42
        iconColor:
          type: string
          example: example_value
        iconUrl:
          type: string
          example: https://www.example.com
        id:
          type: string
          example: abc123
        lastAccessDate:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        objectType:
          type: string
          example: example_value
        sortOrder:
          type: integer
          contentEncoding: int32
          example: 10
        subtitle:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
        targetType:
          type: string
          example: example_value
      examples:
      - accessCount: 1
        iconColor: 5867E8
        iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
        id: 0MV4H0000004qIeWAI
        lastAccessDate: '2023-10-06T10:03:32.000Z'
        name: AllAccountsListViewFavoriteRenamed
        objectType: Account
        sortOrder: 1
        subtitle: Accounts
        target: 00B58000002ssinEAA
        targetType: ListView
    UpdateaFavoriteRequest:
      title: UpdateaFavoriteRequest
      required:
      - name
      - sortOrder
      type: object
      properties:
        name:
          type: string
          example: Example Title
        sortOrder:
          type: integer
          contentEncoding: int32
          example: 10
      examples:
      - name: Red Accounts
        sortOrder: 1
    UpdateUsageofaFavorite:
      title: UpdateUsageofaFavorite
      required:
      - accessCount
      - iconColor
      - iconUrl
      - id
      - lastAccessDate
      - name
      - objectType
      - sortOrder
      - subtitle
      - target
      - targetType
      type: object
      properties:
        accessCount:
          type: integer
          contentEncoding: int32
          example: 42
        iconColor:
          type: string
          example: example_value
        iconUrl:
          type: string
          example: https://www.example.com
        id:
          type: string
          example: abc123
        lastAccessDate:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        objectType:
          type: string
          example: example_value
        sortOrder:
          type: integer
          contentEncoding: int32
          example: 10
        subtitle:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
        targetType:
          type: string
          example: example_value
      examples:
      - accessCount: 2
        iconColor: 5867E8
        iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
        id: 0MV4H0000004qIeWAI
        lastAccessDate: '2023-10-06T10:09:03.304Z'
        name: RenamedAllAcountsListView
        objectType: Account
        sortOrder: 1
        subtitle: Accounts
        target: 00B58000002ssinEAA
        targetType: ListView
    GetaFavorite:
      title: GetaFavorite
      required:
      - accessCount
      - iconColor
      - iconUrl
      - id
      - lastAccessDate
      - name
      - objectType
      - sortOrder
      - subtitle
      - target
      - targetType
      type: object
      properties:
        accessCount:
          type: integer
          contentEncoding: int32
          example: 42
        iconColor:
          type: string
          example: example_value
        iconUrl:
          type: string
          example: https://www.example.com
        id:
          type: string
          example: abc123
        lastAccessDate:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        objectType:
          type: string
          example: example_value
        sortOrder:
          type: integer
          contentEncoding: int32
          example: 10
        subtitle:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
        targetType:
          type: string
          example: example_value
      examples:
      - accessCount: 1
        iconColor: 5867E8
        iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
        id: 0MV4H0000004qIeWAI
        lastAccessDate: '2023-10-06T10:03:32.000Z'
        name: AllAccountsListView
        objectType: Account
        sortOrder: 1
        subtitle: Accounts
        target: 00B58000002ssinEAA
        targetType: ListView
    CreateaFavoritelistview:
      title: CreateaFavoritelistview
      required:
      - accessCount
      - iconColor
      - iconUrl
      - id
      - lastAccessDate
      - name
      - objectType
      - sortOrder
      - subtitle
      - target
      - targetType
      type: object
      properties:
        accessCount:
          type: integer
          contentEncoding: int32
          example: 42
        iconColor:
          type: string
          example: example_value
        iconUrl:
          type: string
          example: https://www.example.com
        id:
          type: string
          example: abc123
        lastAccessDate:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        objectType:
          type: string
          example: example_value
        sortOrder:
          type: integer
          contentEncoding: int32
          example: 10
        subtitle:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
        targetType:
          type: string
          example: example_value
      examples:
      - accessCount: 1
        iconColor: 5867E8
        iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png
        id: 0MV4H0000004qIeWAI
        lastAccessDate: '2023-10-06T10:03:32.000Z'
        name: AllAccountsListView
        objectType: Account
        sortOrder: 1
        subtitle: Accounts
        target: 00B58000002ssinEAA
        targetType: ListView
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '