openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Messages 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: Messages paths: /data/v64.0/chatter/users/me/messages: parameters: [] post: tags: - Messages summary: Salesforce User Messages, General description: 'Returns all the messages for all the private conversations for the context user. Also used to search across all messages and post a message. To return all private conversations for the context user, see User Conversations, General. https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_messages_general.htm' operationId: UserMessages,General parameters: - name: text in: query description: '' required: true style: form explode: true schema: type: string examples: - This is a private message example: example_value - name: recipients in: query description: Comma-separated list of User IDs required: true style: form explode: true schema: type: string examples: - , example: example_value responses: '201': description: Created headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 16:22:22 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-XSS-Protection: content: text/plain: schema: type: string contentMediaType: text/plain example: 1; mode=block 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/SuccessfulUserMessagesGeneral' - examples: - body: isRichText: null messageSegments: [] text: This is a private message conversationId: 03M... conversationUrl: /services/data/v58.0/chatter/users/me/conversations/03M... id: 03J... recipients: - additionalLabel: null communityNickname: automatedprocess companyName: Salesforce displayName: Automated Process firstName: Automated id: 005... isActive: true isInThisCommunity: true lastName: Process motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Automated Process outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///img/userprofile/default_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/005/F mediumPhotoUrl: https:///profilephoto/005/M photoVersionId: null smallPhotoUrl: https:///profilephoto/005/T standardEmailPhotoUrl: https:///img/userprofile/default_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: System - additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: FirstName id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal sender: additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal sendingCommunity: null sentDate: url: /services/data/v58.0/chatter/users/me/messages/03J... contentMediaType: application/json;charset=UTF-8 example: body: isRichText: null messageSegments: [] text: This is a private message conversationId: 03M... conversationUrl: /services/data/v58.0/chatter/users/me/conversations/03M... id: 03J... recipients: - additionalLabel: null communityNickname: automatedprocess companyName: Salesforce displayName: Automated Process firstName: Automated id: 005... isActive: true isInThisCommunity: true lastName: Process motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Automated Process outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///img/userprofile/default_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/005/F mediumPhotoUrl: https:///profilephoto/005/M photoVersionId: null smallPhotoUrl: https:///profilephoto/005/T standardEmailPhotoUrl: https:///img/userprofile/default_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: System - additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: FirstName id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal sender: additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal sendingCommunity: null sentDate: url: /services/data/v58.0/chatter/users/me/messages/03J... deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Body14: title: Body14 required: - isRichText - messageSegments - text type: object properties: isRichText: type: - string - 'null' example: example_value messageSegments: type: array items: type: string description: '' example: [] text: type: string example: example_value examples: - isRichText: null messageSegments: [] text: This is a private message Photo: title: Photo required: - fullEmailPhotoUrl - largePhotoUrl - mediumPhotoUrl - photoVersionId - smallPhotoUrl - standardEmailPhotoUrl - url type: object properties: fullEmailPhotoUrl: type: string example: user@example.com largePhotoUrl: type: string example: https://www.example.com mediumPhotoUrl: type: string example: https://www.example.com photoVersionId: type: string example: '500123' smallPhotoUrl: type: string example: https://www.example.com standardEmailPhotoUrl: type: string example: user@example.com url: type: string example: https://www.example.com examples: - fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo Recipient: title: Recipient required: - additionalLabel - communityNickname - companyName - displayName - firstName - id - isActive - isInThisCommunity - lastName - motif - mySubscription - name - outOfOffice - photo - reputation - title - type - url - userType type: object properties: additionalLabel: type: - string - 'null' example: example_value communityNickname: type: string example: example_value companyName: type: string example: example_value displayName: type: string example: example_value firstName: type: string example: example_value id: type: string example: abc123 isActive: type: boolean example: true isInThisCommunity: type: boolean example: true lastName: type: string example: example_value motif: $ref: '#/components/schemas/Motif' mySubscription: type: - string - 'null' example: example_value name: type: string example: Example Title outOfOffice: $ref: '#/components/schemas/OutOfOffice' photo: $ref: '#/components/schemas/Photo15' reputation: type: - string - 'null' example: example_value title: type: - string - 'null' example: Example Title type: type: string example: example_value url: type: string example: https://www.example.com userType: type: string example: example_value examples: - additionalLabel: null communityNickname: automatedprocess companyName: Salesforce displayName: Automated Process firstName: Automated id: 005... isActive: true isInThisCommunity: true lastName: Process motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Automated Process outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///img/userprofile/default_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/005/F mediumPhotoUrl: https:///profilephoto/005/M photoVersionId: null smallPhotoUrl: https:///profilephoto/005/T standardEmailPhotoUrl: https:///img/userprofile/default_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: System Sender: title: Sender required: - additionalLabel - communityNickname - companyName - displayName - firstName - id - isActive - isInThisCommunity - lastName - motif - mySubscription - name - outOfOffice - photo - reputation - title - type - url - userType type: object properties: additionalLabel: type: - string - 'null' example: example_value communityNickname: type: string example: example_value companyName: type: string example: example_value displayName: type: string example: example_value firstName: type: string example: example_value id: type: string example: abc123 isActive: type: boolean example: true isInThisCommunity: type: boolean example: true lastName: type: string example: example_value motif: $ref: '#/components/schemas/Motif' mySubscription: type: - string - 'null' example: example_value name: type: string example: Example Title outOfOffice: $ref: '#/components/schemas/OutOfOffice' photo: $ref: '#/components/schemas/Photo' reputation: type: - string - 'null' example: example_value title: type: - string - 'null' example: Example Title type: type: string example: example_value url: type: string example: https://www.example.com userType: type: string example: example_value examples: - additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal Photo15: title: Photo15 required: - fullEmailPhotoUrl - largePhotoUrl - mediumPhotoUrl - photoVersionId - smallPhotoUrl - standardEmailPhotoUrl - url type: object properties: fullEmailPhotoUrl: type: string example: user@example.com largePhotoUrl: type: string example: https://www.example.com mediumPhotoUrl: type: string example: https://www.example.com photoVersionId: type: - string - 'null' example: '500123' smallPhotoUrl: type: string example: https://www.example.com standardEmailPhotoUrl: type: string example: user@example.com url: type: string example: https://www.example.com examples: - fullEmailPhotoUrl: https:///img/userprofile/default_group_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/0F9/F mediumPhotoUrl: https:///profilephoto/0F9/M photoVersionId: null smallPhotoUrl: https:///profilephoto/0F9/T standardEmailPhotoUrl: https:///img/userprofile/default_group_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/chatter/groups/0F9.../photo Motif: title: Motif required: - color - largeIconUrl - mediumIconUrl - smallIconUrl - svgIconUrl type: object properties: color: type: string example: example_value largeIconUrl: type: string example: https://www.example.com mediumIconUrl: type: string example: https://www.example.com smallIconUrl: type: string example: https://www.example.com svgIconUrl: type: - string - 'null' example: https://www.example.com examples: - color: '939393' largeIconUrl: /img/content/content64.png mediumIconUrl: /img/content/content32.png smallIconUrl: /img/icon/files16.png svgIconUrl: null SuccessfulUserMessagesGeneral: title: SuccessfulUserMessagesGeneral required: - body - conversationId - conversationUrl - id - recipients - sender - sendingCommunity - sentDate - url type: object properties: body: $ref: '#/components/schemas/Body14' conversationId: type: string example: '500123' conversationUrl: type: string example: https://www.example.com id: type: string example: abc123 recipients: type: array items: $ref: '#/components/schemas/Recipient' description: '' example: [] sender: $ref: '#/components/schemas/Sender' sendingCommunity: type: - string - 'null' example: example_value sentDate: type: string example: example_value url: type: string example: https://www.example.com examples: - body: isRichText: null messageSegments: [] text: This is a private message conversationId: 03M... conversationUrl: /services/data/v58.0/chatter/users/me/conversations/03M... id: 03J... recipients: - additionalLabel: null communityNickname: automatedprocess companyName: Salesforce displayName: Automated Process firstName: Automated id: 005... isActive: true isInThisCommunity: true lastName: Process motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Automated Process outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///img/userprofile/default_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/005/F mediumPhotoUrl: https:///profilephoto/005/M photoVersionId: null smallPhotoUrl: https:///profilephoto/005/T standardEmailPhotoUrl: https:///img/userprofile/default_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: System - additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: FirstName id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal sender: additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal sendingCommunity: null sentDate: url: /services/data/v58.0/chatter/users/me/messages/03J... OutOfOffice: title: OutOfOffice required: - message type: object properties: message: type: string example: example_value examples: - message: '' 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}". '