Salesforce Experience Cloud Favorites API

openapi: 3.1.0
info:
  title: Salesforce Experience Cloud Salesforce CMS Connect Actions Favorites API
  description: Manage content, channels, and media in Experience Cloud CMS. Supports creating, updating, and delivering managed content across channels for headless content delivery and site publishing. Part of the Salesforce Connect REST API.
  version: 59.0.0
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/sfdc-website-terms-of-service/
servers:
- url: https://{instance}.salesforce.com/services/data/v59.0/connect/cms
  description: Salesforce Instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance name or custom domain
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Favorites
  description: User favorites management
paths:
  /favorites:
    get:
      operationId: getFavorites
      summary: Salesforce Experience Cloud Get Favorites
      description: Returns the list of favorites for the context user, including records, list views, and other favorited items.
      tags:
      - Favorites
      responses:
        '200':
          description: Successfully retrieved favorites
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FavoritesRepresentation'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: addFavorite
      summary: Salesforce Experience Cloud Add a Favorite
      description: Adds a record, list view, or other item to the user's favorites.
      tags:
      - Favorites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FavoriteInput'
      responses:
        '201':
          description: Favorite added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Favorite'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /favorites/{favoriteId}:
    delete:
      operationId: removeFavorite
      summary: Salesforce Experience Cloud Remove a Favorite
      description: Removes the specified item from the user's favorites.
      tags:
      - Favorites
      parameters:
      - name: favoriteId
        in: path
        required: true
        description: The ID of the favorite to remove
        schema:
          type: string
      responses:
        '204':
          description: Favorite removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ErrorResponse'
  schemas:
    FavoritesRepresentation:
      type: object
      description: User's favorites
      properties:
        favorites:
          type: array
          items:
            $ref: '#/components/schemas/Favorite'
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        errorCode:
          type: string
        message:
          type: string
    FavoriteInput:
      type: object
      description: Input for adding a favorite
      required:
      - name
      - target
      - targetType
      properties:
        name:
          type: string
          description: Name of the favorite
        sortOrder:
          type: integer
          description: Sort position
        target:
          type: string
          description: ID or reference of the item to favorite
        targetType:
          type: string
          description: Type of item being favorited
          enum:
          - Record
          - ListView
          - Object
    Favorite:
      type: object
      description: A user favorite item
      properties:
        color:
          type: string
        iconUrl:
          type: string
          format: uri
        id:
          type: string
        name:
          type: string
        sortOrder:
          type: integer
        target:
          type: string
        targetType:
          type: string
          enum:
          - Record
          - ListView
          - Object
          - Dashboard
          - Report
  securitySchemes:
    oauth2:
      type: oauth2
      description: Salesforce OAuth 2.0 authentication
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your data
            content: Manage CMS content
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
      description: Bearer token obtained through OAuth 2.0 flow