Salesforce

Salesforce Active API

The Active API from Salesforce — 1 operation(s) for active.

GitHub OpenAPI

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-active-api-openapi.yml

Schemas & Data

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

OpenAPI Specification

salesforce-active-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Active 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: Active
paths:
  /data/v64.0/ui-api/themes/active:
    parameters: []
    get:
      tags:
      - Active
      summary: Salesforce Get Active Theme
      description: Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection.
      operationId: GetActiveTheme
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 09:24:07 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/GetActiveTheme'
                - examples:
                  - brandColor: '#0176D3'
                    brandImage:
                      largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png
                      mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png
                      smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png
                    defaultGroupBanner:
                      fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group.png
                    defaultGroupImage:
                      largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png
                      mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png
                      smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png
                    defaultPageBanner:
                      fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_background.png
                    defaultUserBanner:
                      fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile.png
                    defaultUserImage:
                      largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png
                      mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png
                      smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png
                    density: ViewOne
                    headerColor: '#FFFFFF'
                    linkColor: '#0176D3'
                    pageColor: '#B0C4DF'
                contentMediaType: application/json;charset=UTF-8
              example:
                brandColor: '#0176D3'
                brandImage:
                  largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png
                  mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png
                  smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png
                defaultGroupBanner:
                  fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group.png
                defaultGroupImage:
                  largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png
                  mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png
                  smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png
                defaultPageBanner:
                  fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_background.png
                defaultUserBanner:
                  fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile.png
                defaultUserImage:
                  largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png
                  mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png
                  smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png
                density: ViewOne
                headerColor: '#FFFFFF'
                linkColor: '#0176D3'
                pageColor: '#B0C4DF'
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DefaultUserImage:
      title: DefaultUserImage
      required:
      - largeUrl
      - mediumUrl
      - smallUrl
      type: object
      properties:
        largeUrl:
          type: string
          example: https://www.example.com
        mediumUrl:
          type: string
          example: https://www.example.com
        smallUrl:
          type: string
          example: https://www.example.com
      examples:
      - largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png
        mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png
        smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png
    BrandImage:
      title: BrandImage
      required:
      - largeUrl
      - mediumUrl
      - smallUrl
      type: object
      properties:
        largeUrl:
          type: string
          example: https://www.example.com
        mediumUrl:
          type: string
          example: https://www.example.com
        smallUrl:
          type: string
          example: https://www.example.com
      examples:
      - largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png
        mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png
        smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png
    DefaultGroupBanner:
      title: DefaultGroupBanner
      required:
      - fullSizeUrl
      type: object
      properties:
        fullSizeUrl:
          type: string
          example: https://www.example.com
      examples:
      - fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group.png
    DefaultGroupImage:
      title: DefaultGroupImage
      required:
      - largeUrl
      - mediumUrl
      - smallUrl
      type: object
      properties:
        largeUrl:
          type: string
          example: https://www.example.com
        mediumUrl:
          type: string
          example: https://www.example.com
        smallUrl:
          type: string
          example: https://www.example.com
      examples:
      - largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png
        mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png
        smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png
    DefaultPageBanner:
      title: DefaultPageBanner
      required:
      - fullSizeUrl
      type: object
      properties:
        fullSizeUrl:
          type: string
          example: https://www.example.com
      examples:
      - fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_background.png
    DefaultUserBanner:
      title: DefaultUserBanner
      required:
      - fullSizeUrl
      type: object
      properties:
        fullSizeUrl:
          type: string
          example: https://www.example.com
      examples:
      - fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile.png
    GetActiveTheme:
      title: GetActiveTheme
      required:
      - brandColor
      - brandImage
      - defaultGroupBanner
      - defaultGroupImage
      - defaultPageBanner
      - defaultUserBanner
      - defaultUserImage
      - density
      - headerColor
      - linkColor
      - pageColor
      type: object
      properties:
        brandColor:
          type: string
          example: example_value
        brandImage:
          $ref: '#/components/schemas/BrandImage'
        defaultGroupBanner:
          $ref: '#/components/schemas/DefaultGroupBanner'
        defaultGroupImage:
          $ref: '#/components/schemas/DefaultGroupImage'
        defaultPageBanner:
          $ref: '#/components/schemas/DefaultPageBanner'
        defaultUserBanner:
          $ref: '#/components/schemas/DefaultUserBanner'
        defaultUserImage:
          $ref: '#/components/schemas/DefaultUserImage'
        density:
          type: string
          example: example_value
        headerColor:
          type: string
          example: example_value
        linkColor:
          type: string
          example: example_value
        pageColor:
          type: string
          example: example_value
      examples:
      - brandColor: '#0176D3'
        brandImage:
          largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png
          mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png
          smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png
        defaultGroupBanner:
          fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group.png
        defaultGroupImage:
          largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png
          mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png
          smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png
        defaultPageBanner:
          fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_background.png
        defaultUserBanner:
          fullSizeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile.png
        defaultUserImage:
          largeUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png
          mediumUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png
          smallUrl: /_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png
        density: ViewOne
        headerColor: '#FFFFFF'
        linkColor: '#0176D3'
        pageColor: '#B0C4DF'
  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}".

        '