openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Photo 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: Photo paths: /data/v64.0/connect/user-profiles/me/photo: parameters: [] post: tags: - Photo summary: Salesforce User Photo description: 'Get, post, and crop a user photo. To use an image from the Files page as a user photo, pass the file ID in the fileId property of the request body or in the fileId request parameter. Images uploaded on the User page don’t have a file ID and can’t be used as the fileId. To upload a binary file as the user photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see Uploading Binary Files. To display user profile photos in a feed, cache the user photos. Then use the photoVersionId property of the Photo response body to determine when you need to update a photo. This technique helps you avoid running over limits and may improve mobile client performance.' operationId: UserPhoto parameters: [] requestBody: content: multipart/form-data: encoding: {} schema: required: - json - fileUpload type: object properties: json: allOf: - $ref: '#/components/schemas/json' - examples: - cropY: '0' cropX: '0' cropSize: '200' fileUpload: type: string contentEncoding: base64 contentMediaType: multipart/form-data examples: UserphotoRequestExample: summary: Default UserPhoto request x-microcks-default: true value: json: example_value fileUpload: example_value required: false responses: '201': description: Created headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 16:15:44 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/SuccesfulUserPhoto' - examples: - fullEmailPhotoUrl: https:///img/userprofile/default_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///img/userprofile/default_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo contentMediaType: application/json;charset=UTF-8 example: fullEmailPhotoUrl: https:///img/userprofile/default_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///img/userprofile/default_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo 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/actions/photo/{RECORD_IDS}: parameters: [] get: tags: - Photo summary: Salesforce Get Photo Actions description: Get the photo actions for pages. Currently, only group and user pages support photo actions. operationId: GetPhotoActions parameters: - name: RECORD_IDS in: path description: '' 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 11:50:11 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: '"802f98780c61a3109be0a574d2915772--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/GetPhotoActions' - examples: - actions: 0F94H000000UF2xSAG: actions: - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: ViewPhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301820WAA isMassAction: 'false' label: View Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: UpdatePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:UpdatePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301821WAA isMassAction: 'false' label: Update Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: DeletePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:DeletePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301822WAA isMassAction: 'false' label: Delete Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton links: [] url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG eTag: 802f98780c61a3109be0a574d2915772 url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG contentMediaType: application/json;charset=UTF-8 example: actions: 0F94H000000UF2xSAG: actions: - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: ViewPhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301820WAA isMassAction: 'false' label: View Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: UpdatePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:UpdatePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301821WAA isMassAction: 'false' label: Update Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: DeletePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:DeletePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301822WAA isMassAction: 'false' label: Delete Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton links: [] url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG eTag: 802f98780c61a3109be0a574d2915772 url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: GetPhotoActions: title: GetPhotoActions required: - actions - eTag - url type: object properties: actions: $ref: '#/components/schemas/Actions23' eTag: type: string example: example_value url: type: string example: https://www.example.com examples: - actions: 0F94H000000UF2xSAG: actions: - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: ViewPhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301820WAA isMassAction: 'false' label: View Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: UpdatePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:UpdatePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301821WAA isMassAction: 'false' label: Update Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: DeletePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:DeletePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301822WAA isMassAction: 'false' label: Delete Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton links: [] url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG eTag: 802f98780c61a3109be0a574d2915772 url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG json: title: json required: - cropY - cropX - cropSize type: object properties: cropY: type: string example: example_value cropX: type: string example: example_value cropSize: type: string example: example_value examples: - cropY: '0' cropX: '0' cropSize: '200' 0F94H000000UF2xSAG: title: 0F94H000000UF2xSAG required: - actions - links - url type: object properties: actions: type: array items: $ref: '#/components/schemas/Actions24' description: '' example: [] links: type: array items: type: string description: '' example: [] url: type: string example: https://www.example.com examples: - actions: - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: ViewPhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301820WAA isMassAction: 'false' label: View Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: UpdatePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:UpdatePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301821WAA isMassAction: 'false' label: Update Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: DeletePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:DeletePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301822WAA isMassAction: 'false' label: Delete Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton links: [] url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG Actions24: title: Actions24 required: - actionListContext - actionTarget - actionTargetType - apiName - externalId - iconUrl - id - isMassAction - label - lwcComponent - primaryColor - relatedListRecordId - relatedSourceObject - section - sourceObject - subtype - targetObject - targetUrl - type type: object properties: actionListContext: type: string example: example_value actionTarget: type: - string - 'null' example: example_value actionTargetType: type: string example: example_value apiName: type: string example: example_value externalId: type: string example: '500123' iconUrl: type: string example: https://www.example.com id: type: string example: abc123 isMassAction: type: string example: example_value label: type: string example: Example Title lwcComponent: type: - string - 'null' example: example_value primaryColor: type: string example: example_value relatedListRecordId: type: - string - 'null' example: '500123' relatedSourceObject: type: - string - 'null' example: example_value section: type: string example: example_value sourceObject: type: string example: example_value subtype: type: - string - 'null' example: example_value targetObject: type: - string - 'null' example: example_value targetUrl: type: - string - 'null' example: https://www.example.com type: type: string example: example_value examples: - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: ViewPhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301820WAA isMassAction: 'false' label: View Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton SuccesfulUserPhoto: title: SuccesfulUserPhoto 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:///img/userprofile/default_profile_200_v2.png?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///img/userprofile/default_profile_45_v2.png?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo Actions23: title: Actions23 required: - 0F94H000000UF2xSAG type: object properties: 0F94H000000UF2xSAG: $ref: '#/components/schemas/0F94H000000UF2xSAG' examples: - 0F94H000000UF2xSAG: actions: - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: ViewPhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301820WAA isMassAction: 'false' label: View Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: UpdatePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:UpdatePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301821WAA isMassAction: 'false' label: Update Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton - actionListContext: Photo actionTarget: null actionTargetType: Invoke apiName: DeletePhotoAction externalId: 00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:DeletePhotoAction iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png id: 0JV4H0000301822WAA isMassAction: 'false' label: Delete Photo lwcComponent: null primaryColor: '939393' relatedListRecordId: null relatedSourceObject: null section: Page sourceObject: 0F94H000000UF2xSAG subtype: null targetObject: null targetUrl: null type: StandardButton links: [] url: /services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG 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}". '