Salesforce

Salesforce Favorite API

The Favorite API from Salesforce — 3 operation(s) for favorite.

GitHub OpenAPI

Operations 3

GET /data/v64.0/ui-api/favorites/{FAVORITE_ID} Salesforce Get a Favorite #
PATCH /data/v64.0/ui-api/favorites/{FAVORITE_ID} Salesforce Update a Favorite #
PATCH /data/v64.0/ui-api/favorites/{FAVORITE_ID}/usage Salesforce Update Usage of a Favorite #

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-favorite-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/salesforce-favorite-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

salesforce-favorite-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salesforce Favorite API
  description: 'Find the resources you need to start building. '
  contact: {}
  version: '1.0'
servers:
- url: https://login.salesforce.com
  variables: {}
- url: https://id
  variables: {}
- url: https://services
  variables: {}
- url: '{{url}}{{site}}/services/oauth2'
  variables:
    url:
      default: DefaultParameterValue
    site:
      default: DefaultParameterValue
security:
- oauth2:
  - api
tags:
- name: Favorite
paths:
  /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
  /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:
    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
    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
    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
    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
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: '{DefaultParameterValue}{DefaultParameterValue}/services/oauth2/authorize'
          scopes:
            api: ''