Salesforce Detail API

The Detail API from Salesforce — 2 operation(s) for detail.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-detail-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Detail 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: Detail
paths:
  /data/v64.0/ui-api/actions/record/{RECORD_IDS}:
    parameters: []
    get:
      tags:
      - Detail
      summary: Salesforce Get Record Detail Page Actions
      description: Get the actions on record detail pages.
      operationId: GetRecordDetailPageActions
      parameters:
      - name: RECORD_IDS
        in: path
        description: A single record ID, or a comma-delimited list of record IDs.
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 10:16:27 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
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"070a59ceff1430940937c233f1b952dd--gzip"'
            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/GetRecordDetailPageActions'
                - examples:
                  - actions:
                      0014H00002LbR7QQAV:
                        actions:
                        - actionListContext: Chatter
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: Follow
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Chatter:Desktop:StandardButton:Follow
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/follow_120.png
                          id: 0JV4H0000328007WAA
                          isMassAction: 'false'
                          label: Follow
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: SingleActionLinks
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Chatter
                          actionTarget: null
                          actionTargetType: null
                          apiName: FollowInStream
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Chatter:Desktop:StandardButton:FollowInStream
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/follow_120.png
                          id: 0JV4H0000328008WAA
                          isMassAction: 'false'
                          label: Follow in Stream
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: SingleActionLinks
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewTask/describe
                          actionTargetType: Describe
                          apiName: Global.NewTask
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2f
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_task_120.png
                          id: 0JV4H0000328011WAA
                          isMassAction: 'false'
                          label: New Task
                          lwcComponent: null
                          primaryColor: 3BA755
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Task
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewEvent/describe
                          actionTargetType: Describe
                          apiName: Global.NewEvent
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2j
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_event_120.png
                          id: 0JV4H0000328012WAA
                          isMassAction: 'false'
                          label: New Event
                          lwcComponent: null
                          primaryColor: FF538A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Event
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.TextPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.TextPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_post_120.png
                          id: 0JV4H0000328013WAA
                          isMassAction: 'false'
                          label: Post
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: CollaborateComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: Edit
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:Edit
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/edit_120.png
                          id: 0JV4H0000328014WAA
                          isMassAction: 'false'
                          label: Edit
                          lwcComponent: dxp_records:lwcEditActionHandler
                          primaryColor: 06A59A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: ScreenAction
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.ContentPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.ContentPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_file_120.png
                          id: 0JV4H0000328015WAA
                          isMassAction: 'false'
                          label: File
                          lwcComponent: null
                          primaryColor: '939393'
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewContact/describe
                          actionTargetType: Describe
                          apiName: Global.NewContact
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2k
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_contact_120.png
                          id: 0JV4H0000328016WAA
                          isMassAction: 'false'
                          label: New Contact
                          lwcComponent: null
                          primaryColor: 5867E8
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Contact
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/LogACall/describe
                          actionTargetType: Describe
                          apiName: Global.LogACall
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2g
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
                          id: 0JV4H0000328017WAA
                          isMassAction: 'false'
                          label: Log a Call
                          lwcComponent: null
                          primaryColor: 06A59A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: ActivityComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: LogACall
                          targetObject: Task
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewOpportunity/describe
                          actionTargetType: Describe
                          apiName: Global.NewOpportunity
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2l
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_opportunity_120.png
                          id: 0JV4H0000328018WAA
                          isMassAction: 'false'
                          label: New Opportunity
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Opportunity
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewCase/describe
                          actionTargetType: Describe
                          apiName: Global.NewCase
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2h
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_case_120.png
                          id: 0JV4H0000328019WAA
                          isMassAction: 'false'
                          label: New Case
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Case
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewLead/describe
                          actionTargetType: Describe
                          apiName: Global.NewLead
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002PE2m
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_lead_120.png
                          id: 0JV4H0000328020WAA
                          isMassAction: 'false'
                          label: New Lead
                          lwcComponent: null
                          primaryColor: FF5D2D
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Lead
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.LinkPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.LinkPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_link_120.png
                          id: 0JV4H0000328021WAA
                          isMassAction: 'false'
                          label: Link
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.PollPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.PollPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/share_poll_120.png
                          id: 0JV4H0000328022WAA
                          isMassAction: 'false'
                          label: Poll
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: CollaborateComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: FeedItem.QuestionPost
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:FeedItem.QuestionPost
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/question_post_action_120.png
                          id: 0JV4H0000328023WAA
                          isMassAction: 'false'
                          label: Question
                          lwcComponent: null
                          primaryColor: 3BA755
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: CollaborateComposer
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Post
                          targetObject: null
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/New_Detailed_Account/describe
                          actionTargetType: Describe
                          apiName: Global.New_Detailed_Account
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:09D58000002Pbt9
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
                          id: 0JV4H0000328024WAA
                          isMassAction: 'false'
                          label: New Detailed Account
                          lwcComponent: null
                          primaryColor: 5867E8
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: Create
                          targetObject: Account
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: ChangeOwnerOne
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:ChangeOwnerOne
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/change_owner_120.png
                          id: 0JV4H0000328025WAA
                          isMassAction: 'false'
                          label: Change Owner
                          lwcComponent: null
                          primaryColor: 107CAD
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: Delete
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:Delete
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/delete_120.png
                          id: 0JV4H0000328026WAA
                          isMassAction: 'false'
                          label: Delete
                          lwcComponent: null
                          primaryColor: FF538A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: AccountHierarchy
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:AccountHierarchy
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000328027WAA
                          isMassAction: 'false'
                          label: View Account Hierarchy
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: IncludeOffline
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:IncludeOffline
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000328028WAA
                          isMassAction: 'false'
                          label: Include Offline
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: EnableAsPartner
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:EnableAsPartner
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000328029WAA
                          isMassAction: 'false'
                          label: Enable As Partner
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: XClean
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:XClean
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000328030WAA
                          isMassAction: 'false'
                          label: Check for New Data
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: PrintableView
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:StandardButton:PrintableView
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000328031WAA
                          isMassAction: 'false'
                          label: Printable View
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: null
                          actionTargetType: null
                          apiName: WebsiteHighlightAction
                          externalId: 00D58000000arpq:0014H00002LbR7QQAV::Record:Desktop:ProductivityAction:WebsiteHighlightAction
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/web_link_120.png
                          id: 0JV4H0000328032WAA
                          isMassAction: 'false'
                          label: View Website
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: 0014H00002LbR7QQAV
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: ProductivityAction
                        links:
                        - /services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV/record-edit
                        - /services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV/related-list
                        - /services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV/related-list-record/${relatedRecordId}
                        url: /services/data/v58.0/ui-api/actions/record/0014H00002LbR7QQAV
                      00158000006QBOhAAO:
                        actions:
                        - actionListContext: Chatter
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: Follow
                          externalId: 00D58000000arpq:00158000006QBOhAAO::Chatter:Desktop:StandardButton:Follow
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/follow_120.png
                          id: 0JV4H0000328009WAA
                          isMassAction: 'false'
                          label: Follow
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: SingleActionLinks
                          sourceObject: 00158000006QBOhAAO
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Chatter
                          actionTarget: null
                          actionTargetType: null
                          apiName: FollowInStream
                          externalId: 00D58000000arpq:00158000006QBOhAAO::Chatter:Desktop:StandardButton:FollowInStream
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/follow_120.png
                          id: 0JV4H0000328010WAA
                          isMassAction: 'false'
                          label: Follow in Stream
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: SingleActionLinks
                          sourceObject: 00158000006QBOhAAO
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: Record
                          actionTarget: /services/data/v58.0/quickActions/NewTask/describe
                          actionTargetType: Describe
                          apiName: Global.NewTask
                          externalId: 00D58000000arpq:00158000006QBOhAAO::Record:Desktop:09D58000002PE2f
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_task_120.png
                          id: 0JV4H0000328033WAA
                          isMassAction: 'false'
                          lab

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