openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Retrieves 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: Retrieves paths: /async/64.0/job//batch/{_batchId}/result: parameters: [] get: tags: - Retrieves summary: Salesforce Bulk Retrieve Batch Result operationId: BulkRetrieveBatchResult parameters: - name: X-SFDC-Session in: header description: '' required: true schema: type: string example: example_value - name: Accept-Encoding in: header description: '' required: true schema: type: string examples: - gzip example: example_value - name: Content-Encoding in: header description: '' required: true schema: type: string examples: - gzip example: example_value - name: _batchId in: path description: '' required: true schema: type: string example: '500123' responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Thu, 16 Nov 2023 16:20: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-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 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: text/csv: schema: type: string examples: - '"Id","Success","Created","Error" "001...","true","true","" ' contentMediaType: text/csv example: '"Id","Success","Created","Error" "001...","true","true","" ' deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /async/64.0/job//batch/{_batchId}/result/{batchResultId}: parameters: [] get: tags: - Retrieves summary: Salesforce Bulk Retrieve Batch Result Data operationId: BulkRetrieveBatchResultData parameters: - name: batchResultId in: path description: '' required: true schema: type: string examples: - 'null' example: '500123' - name: X-SFDC-Session in: header description: '' required: true schema: type: string example: example_value - name: Accept-Encoding in: header description: '' required: true schema: type: string examples: - gzip example: example_value - name: Content-Encoding in: header description: '' required: true schema: type: string examples: - gzip example: example_value - name: _batchId in: path description: '' required: true schema: type: string example: '500123' responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Thu, 16 Nov 2023 16:36:36 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 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: text/csv; charset=UTF-8: schema: type: string examples: - '"Id","Name" "001...","GenePoint" "001...","United Oil & Gas, UK" "001...","United Oil & Gas, Singapore" "001...","Edge Communications" "001...","Burlington Textiles Corp of America" "001...","Pyramid Construction Inc." "001...","Dickenson plc" "001...","Grand Hotels & Resorts Ltd" "001...","Express Logistics and Transport" "001...","University of Arizona" "001...","United Oil & Gas Corp." "001...","sForce" "001...","Exemple de comptes pour les autorisations" "001...","Tom Jones" ' contentMediaType: text/csv; charset=UTF-8 example: '"Id","Name" "001...","GenePoint" "001...","United Oil & Gas, UK" "001...","United Oil & Gas, Singapore" "001...","Edge Communications" "001...","Burlington Textiles Corp of America" "001...","Pyramid Construction Inc." "001...","Dickenson plc" "001...","Grand Hotels & Resorts Ltd" "001...","Express Logistics and Transport" "001...","University of Arizona" "001...","United Oil & Gas Corp." "001...","sForce" "001...","Exemple de comptes pour les autorisations" "001...","Tom Jones" ' 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/composite/sobjects/{SOBJECT_API_NAME}: parameters: [] get: tags: - Retrieves summary: Salesforce Sobject Collections Retrieve description: 'Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm' operationId: SObjectCollectionsRetrieve parameters: - name: ids in: query description: '' required: true style: form explode: true schema: type: string example: example_value - name: fields in: query description: '' required: true style: form explode: true schema: type: string example: example_value - name: SOBJECT_API_NAME in: path description: '' required: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 15:27:03 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 Sforce-Limit-Info: content: text/plain: schema: type: string contentMediaType: text/plain example: api-usage=44/15000 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: type: array items: $ref: '#/components/schemas/SuccessfulSObjectCollectionsRetrieve' description: '' examples: - - attributes: type: Account url: /services/data/v58.0/sobjects/Account/001... Name: Sample Account Id: 001... contentMediaType: application/json;charset=UTF-8 example: - attributes: type: Account url: /services/data/v58.0/sobjects/Account/001... Name: Sample Account Id: 001... 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/connect/business-rules/expression-set/version/{expressionSetVersionId}/dependencies: parameters: [] get: tags: - Retrieves summary: Salesforce Retrieve Expression Set Version Dependencies description: "[https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_resources_expression_set_dependencies.htm](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_resources_expression_set_dependencies.htm)\n\n# Expression Set Version Dependencies (GET)\n\nRetrieve expression set version dependencies.Resource\n\n```\n/connect/business-rules/expression-set/version/${expressionSetVersionId}/dependencies\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v58.0/connect/business-rules/expression-set/version/9QARN000000016v4AA/dependencies\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nGET\n\nResponse body for GET\n\n[Expression Set Version Dependency](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_version_dependency_output.htm)" operationId: Retrieveexpressionsetversiondependencies parameters: - name: expressionSetVersionId in: path description: 'Expression Set Version Id: For Example 9QLHo000000LBjEOAW' required: true schema: type: string examples: - 9QMHo000000LBnbOAG example: '500123' responses: '400': description: Bad Request headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 14:28:18 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status400-BadRequest1' description: '' examples: - - errorCode: INVALID_ID_FIELD message: 'Invalid identifier: 9QLHo000000LBjJOAW' contentMediaType: application/json;charset=UTF-8 example: - errorCode: INVALID_ID_FIELD message: 'Invalid identifier: 9QLHo000000LBjJOAW' '404': description: Not Found headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 14:29:34 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status404-RecordNotFound1' description: '' examples: - - errorCode: NOT_FOUND message: The requested resource does not exist contentMediaType: application/json;charset=UTF-8 example: - errorCode: NOT_FOUND message: The requested resource does not exist '500': description: Server Error headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 14:26:46 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status500-UnexpectedError1' description: '' examples: - - errorCode: INTERNAL_ERROR message: Unexpected Error contentMediaType: application/json;charset=UTF-8 example: - errorCode: INTERNAL_ERROR message: Unexpected Error 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/connect/business-rules/expression-set/{expressionSetId}: parameters: [] get: tags: - Retrieves summary: Salesforce Expression Set Retrieve description: "# Expression Set Retrieve and Delete (DELETE, GET)\n\nEndpoints to read, and delete expression set.Resource\n\n```\n/connect/business-rules/expression-set/${expressionSetId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n /business-rules/expressionSet/$11Oxx0000006PcLEAU\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE, GET\n\nRequest body for GET\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| context​Definitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usage​Type | String | Usage type of the expression set.

Valid values are:

\\- AiAccelerator​SubscriberChurn​Prediction—Used for Industries Einstein

\\- Bre—Used for Business Rules Engine

\\- CustomLoyalty—Used for Loyalty Management

\\- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud

\\- Qualification—Used for Industries Communications, Media, and Energy (CME)

\\- RecordAlert—Used for Financial Services Cloud

\\- ShipAndDebit—Used for Manufacturing Cloud

\\- TierProcessing—Used for Loyalty Management

\\- TransactionJournal—Used for Loyalty Management

\\- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for GET[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)" operationId: ExpressionSetRetrieve parameters: - name: expressionSetId in: path description: 'Expression Set Id: For Example 9QLHo000000LBjEOAW' required: true schema: type: string examples: - 9QLHo000000LBngOAG example: '500123' responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 09:34:42 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/Status200-RecordFound' - examples: - apiName: myExpressionSet contextDefinitions: [] id: 9QLHo000000LBjEOAW name: myExpressionSet usageType: Bre versions: - apiName: myExpressionSet_V1 description: myExpressionSet V1 Description enabled: true id: 9QMHo000000LBjJOAW name: myExpressionSet V1 rank: 1 showExplExternally: true startDate: '2023-09-06T09:27:06.000Z' steps: - actionType: AssignParameterValues assignment: assignedParameter: condition_output__1 expression: 'true' description: my Description name: myCalculation resultIncluded: true sequenceNumber: 1 shouldExposeConditionDetails: false shouldExposeExecPathMsgOnly: true shouldShowExplExternally: false stepType: BusinessKnowledgeModel variables: - collection: false dataType: Boolean description: condition_output__1 input: false name: condition_output__1 output: true type: Variable value: 'False' - collection: false dataType: Boolean description: condition_output__2 input: false name: condition_output__2 output: false type: Variable value: 'False' versionNumber: 1 contentMediaType: application/json;charset=UTF-8 example: apiName: myExpressionSet contextDefinitions: [] id: 9QLHo000000LBjEOAW name: myExpressionSet usageType: Bre versions: - apiName: myExpressionSet_V1 description: myExpressionSet V1 Description enabled: true id: 9QMHo000000LBjJOAW name: myExpressionSet V1 rank: 1 showExplExternally: true startDate: '2023-09-06T09:27:06.000Z' steps: - actionType: AssignParameterValues assignment: assignedParameter: condition_output__1 expression: 'true' description: my Description name: myCalculation resultIncluded: true sequenceNumber: 1 shouldExposeConditionDetails: false shouldExposeExecPathMsgOnly: true shouldShowExplExternally: false stepType: BusinessKnowledgeModel variables: - collection: false dataType: Boolean description: condition_output__1 input: false name: condition_output__1 output: true type: Variable value: 'False' - collection: false dataType: Boolean description: condition_output__2 input: false name: condition_output__2 output: false type: Variable value: 'False' versionNumber: 1 '400': description: Bad Request headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 10:29:39 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status400-PreviouslyDeletedRecord1' description: '' examples: - - errorCode: INVALID_INPUT message: The expression set id is not available. contentMediaType: application/json;charset=UTF-8 example: - errorCode: INVALID_INPUT message: The expression set id is not available. '404': description: Not Found headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 09:56:59 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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Status404-RecordNotFound1' description: '' examples: - - errorCode: NOT_FOUND message: The requested resource does not exist contentMediaType: application/json;charset=UTF-8 example: - errorCode: NOT_FOUND message: The requested resource does not exist 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/connect/business-rules/lookup-tables: parameters: [] get: tags: - Retrieves summary: Salesforce Retrieve Lookup Tables description: "# Lookup Tables (GET)\n\nRetrieve lookup tables.Resource\n\n```\n/connect/business-rules/lookup-tables\n\n ```\n\nResource example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/lookup-tables?searchKey=D&usageType=Bre&lookupTypes=DecisionTable,DecisionMatrix\n\n ```\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/lookup-tables?searchKey=D&usageType=Bre\n\n ```\n\nAvailable version59.0Requires ChatterNoHTTP methodsGETRequest parameters for GET\n\n| Parameter Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| lookupTypes | String | Type of lookup table. Valid values are:

- DecisionMatrix

- DecisionTable | Optional | 59.0 |\n| searchKey | String | The search text entered by the user to retrieve a list of lookup tables. | Required | 59.0 |\n| usageType | String | Usage type of the lookup table. Valid values are:

- AiAccelerator​SubscriberChurn​Prediction—Used for Industries Einstein

- Bre—Used for Business Rules Engine

- CustomLoyalty—Used for Loyalty Management

- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud

- Qualification—Used for Industries Communications, Media, and Energy (CME)

- RecordAlert—Used for Financial Services Cloud

- ShipAndDebit—Used for Manufacturing Cloud

- TierProcessing—Used for Loyalty Management

- TransactionJournal—Used for Loyalty Management

- WarrantyClaim—Used for Manufacturing Cloud | Required | 59.0 |\n\nResponse body for GET[Lookup Tables Result List](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_lookup_tables_result_list.htm)" operationId: Retrievelookuptables parameters: - name: searchKey in: query description: '' required: true style: form explode: true schema: type: string examples: - my example: example_value - name: usageType in: query description: '' required: true style: form explode: true schema: type: string examples: - Bre example: example_value - name: lookupTypes in: query description: 'Optional: Type of lookup table. Valid values are: DecisionMatrix, DecisionTable' required: true style: form explode: true schema: type: string examples: - DecisionTable example: example_value responses: '404': description: Not Found headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Sep 2023 08:56: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-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 Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/404-BecauseVersion59.0NotPresentInTargetOrg1' description: '' examples: - - errorCode: NOT_FOUND message: The requested resource does not exist contentMediaType: application/json;charset=UTF-8 example: - errorCode: NOT_FOUND message: The requested resource does not exist 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/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}/{BLOB_FIELD}: parameters: [] get: tags: - Retrieves summary: Salesforce Sobject Blob Retrieve description: Retrieves the specified blob field from an individual record. operationId: SObjectBlobRetrieve parameters: - name: SOBJECT_API_NAME in: path description: '' required: true schema: type: string example: example_value - name: RECORD_ID in: path description: '' required: true schema: type: string example: '500123' - name: BLOB_FIELD in: path description: '' required: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} 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/sobjects/{SOBJECT_API_NAME}/{RECORD_ID}/richTextImageFields/{FIELD_NAME}/{CONTENT_REFERENCE_ID}: parameters: [] get: tags: - Retrieves summary: Salesforce Sobject Rich Text Image Retrieve description: "Retrieves the specified image data from a specific rich text area field in a given record.\ncontentReferenceId\tThe reference ID that uniquely identifies an image within a rich text area field.\nYou can obtain the reference by retrieving information for the object. The description will show the contents of the rich text area field" operationId: SObjectRichTextImageRetrieve parameters: - name: SOBJECT_API_NAME in: path description: '' required: true schema: type: string example: example_value - name: RECORD_ID in: path description: '' required: true schema: type: string example: '500123' - name: FIELD_NAME in: path description: '' required: true schema: type: string example: example_value - name: CONTENT_REFERENCE_ID in: path description: '' required: true schema: type: string example: '500123' - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} 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/async/specifications/oas3/{schemaId}: parameters: [] get: tags: - Retrieves summary: Salesforce Retrieve Openapi Schema description: Generate an OpenAPI 3.0 document for the sObjects REST API. This is a [Beta feature](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/openapi_beta.htm) that requires an activation step before it can be used. operationId: RetrieveOpenAPISchema parameters: - name: schemaId in: path description: Identifier that was returned in the original request to generate the Schema. required: true schema: type: string example: '500123' responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 26 Feb 2024 13:53:54 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 Sforce-Limit-Info: content: text/plain: schema: type: string contentMediaType: text/plain example: api-usage=11/15000 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: schema: $ref: '#/components/schemas/RetrieveOpenAPISchema' examples: Retrieveopenapischema200Example: summary: Default RetrieveOpenAPISchema 200 response x-microcks-default: true value: openapi: example_value info: title: Example Title description: A sample description. version: example_value servers: - url: https://www.example.com security: - bearerAuth: {} oAuth2: {} openIDConnectDiscovery: {} paths: {} components: {} 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/knowledgeManagement/settings: parameters: [] get: tags: - Retrieves summary: Salesforce Retrieve Knowledge Language Settings description: 'Returns the existing Knowledge language settings, including the default knowledge language and a list of supported Knowledge language information. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_knowledge_retrieve_language.htm' operationId: RetrieveKnowledgeLanguageSettings parameters: - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Scopes1: title: Scopes1 required: - api type: object properties: api: type: string example: example_value examples: - api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. MailingPostalCode: title: MailingPostalCode required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Mailing address details. MailingGeocodeAccuracy: title: MailingGeocodeAccuracy required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see . AssistantPhone: title: AssistantPhone required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The assistant’s telephone number. NumberofLocationsC: title: NumberofLocationsC required: - type type: object properties: type: type: string example: example_value examples: - type: number Fax: title: Fax required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Fax number for the account. Tradestyle: title: Tradestyle required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: A name, different from its legal name, that an org may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum length is 255 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. IsSubtype: title: IsSubtype required: - type type: object properties: type: type: string example: example_value examples: - type: boolean ShippingAddress: title: ShippingAddress required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: object description: The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields. SobjectsContact: title: SobjectsContact required: - description - get - post type: object properties: description: type: string example: A sample description. get: $ref: '#/components/schemas/Get' post: $ref: '#/components/schemas/Post' MailingLongitude: title: MailingLongitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with MailingLatitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . Searchable: title: Searchable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean RestApiError: title: RestApiError required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties3' examples: - type: object properties: errorCode: type: string message: type: string RetrieveOpenAPISchema: title: RetrieveOpenAPISchema required: - openapi - info - servers - security - paths - components type: object properties: openapi: type: string example: example_value info: $ref: '#/components/schemas/Info' servers: type: array items: $ref: '#/components/schemas/Server' description: '' example: [] security: type: array items: $ref: '#/components/schemas/Security' description: '' example: [] paths: $ref: '#/components/schemas/Paths' components: $ref: '#/components/schemas/Components' ReportsToId: title: ReportsToId required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: This field doesn’t appear if IsPersonAccount is true. MailingCountry: title: MailingCountry required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Mailing address details. Deletable: title: Deletable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean OtherCity: title: OtherCity required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Alternate address details. Title: title: Title required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Title of the contact, such as CEO or Vice President. OtherCountry: title: OtherCountry required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Alternate address details. Phone: title: Phone required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Phone number for this account. Maximum size is 40 characters. Info: title: Info required: - title - description - version type: object properties: title: type: string example: Example Title description: type: string example: A sample description. version: type: string example: example_value examples: - title: Lightning Platform REST API description: 'REST API provides you with programmatic access to your data in Salesforce. The flexibility and scalability of REST API make it an excellent choice for integrating Salesforce into your applications and for performing complex operations on a large scale. You can use REST API tools to create, manipulate, and search data in Salesforce by sending HTTP requests to endpoints in Salesforce. Depending on where you send requests, you access and operate on different pieces of information, called resources. Resources include records, query results, metadata, and more. ' version: '60.0' LastCURequestDate: title: LastCURequestDate required: - type - format type: object properties: type: type: string example: example_value format: type: string example: example_value examples: - type: string format: date-time Status404-RecordNotFound1: title: Status404-RecordNotFound1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: NOT_FOUND message: The requested resource does not exist Content: title: Content required: - application/json type: object properties: application/json: $ref: '#/components/schemas/ApplicationJson' examples: - application/json: schema: $ref: '#/components/schemas/SObjectRootInfo' Properties1: title: Properties1 required: - name - label - labelPlural - keyPrefix - custom - customSetting - activateable - createable - updateable - deletable - undeletable - mergeable - replicateable - triggerable - queryable - retrieveable - searchable - layoutable - feedEnabled - mruEnabled - hasSubtypes - isSubtype - dataTranslationEnabled - isInterface - deepCloneable - associateEntityType - associateParentEntity - deprecatedAndHidden - urls type: object properties: name: $ref: '#/components/schemas/Name13' label: $ref: '#/components/schemas/Label' labelPlural: $ref: '#/components/schemas/LabelPlural' keyPrefix: $ref: '#/components/schemas/KeyPrefix' custom: $ref: '#/components/schemas/Custom' customSetting: $ref: '#/components/schemas/CustomSetting' activateable: $ref: '#/components/schemas/Activateable' createable: $ref: '#/components/schemas/Createable' updateable: $ref: '#/components/schemas/Updateable' deletable: $ref: '#/components/schemas/Deletable' undeletable: $ref: '#/components/schemas/Undeletable' mergeable: $ref: '#/components/schemas/Mergeable' replicateable: $ref: '#/components/schemas/Replicateable' triggerable: $ref: '#/components/schemas/Triggerable' queryable: $ref: '#/components/schemas/Queryable' retrieveable: $ref: '#/components/schemas/Retrieveable' searchable: $ref: '#/components/schemas/Searchable' layoutable: $ref: '#/components/schemas/Layoutable' feedEnabled: $ref: '#/components/schemas/FeedEnabled' mruEnabled: $ref: '#/components/schemas/MruEnabled' hasSubtypes: $ref: '#/components/schemas/HasSubtypes' isSubtype: $ref: '#/components/schemas/IsSubtype' dataTranslationEnabled: $ref: '#/components/schemas/DataTranslationEnabled' isInterface: $ref: '#/components/schemas/IsInterface' deepCloneable: $ref: '#/components/schemas/DeepCloneable' associateEntityType: $ref: '#/components/schemas/AssociateEntityType' associateParentEntity: $ref: '#/components/schemas/AssociateParentEntity' deprecatedAndHidden: $ref: '#/components/schemas/DeprecatedAndHidden' urls: $ref: '#/components/schemas/Urls5' examples: - name: type: string label: type: string labelPlural: type: string keyPrefix: type: string custom: type: boolean customSetting: type: boolean activateable: type: boolean createable: type: boolean updateable: type: boolean deletable: type: boolean undeletable: type: boolean mergeable: type: boolean replicateable: type: boolean triggerable: type: boolean queryable: type: boolean retrieveable: type: boolean searchable: type: boolean layoutable: type: boolean feedEnabled: type: boolean mruEnabled: type: boolean hasSubtypes: type: boolean isSubtype: type: boolean dataTranslationEnabled: type: boolean isInterface: type: boolean deepCloneable: type: boolean associateEntityType: type: string associateParentEntity: type: string deprecatedAndHidden: type: boolean urls: type: object additionalProperties: type: string OtherState: title: OtherState required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Alternate address details. Type5: title: Type5 required: - type type: object properties: type: type: string example: example_value examples: - type: string OtherGeocodeAccuracy: title: OtherGeocodeAccuracy required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Accuracy level of the geocode for the other address. For details on geolocation compound fields, see . Createable: title: Createable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Items23: title: Items23 required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties10' examples: - type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string ContactSObject: title: ContactSObject required: - type - properties - description type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties12' description: type: string example: A sample description. examples: - type: object properties: Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this record was deleted as the result of a merge, this field contains the ID of the record that remains. If this record was deleted for any other reason, or has not been deleted, the value is null. AccountId: type: string description: ID of the account that’s the parent of this contact. We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. LastName: type: string description: Required. Last name of the contact up to 80 characters. FirstName: type: string description: The contact’s first name up to 40 characters. Salutation: type: string description: Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs. Name: type: string description: Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces. OtherStreet: type: string description: Street for alternate address. OtherCity: type: string description: Alternate address details. OtherState: type: string description: Alternate address details. OtherPostalCode: type: string description: Alternate address details. OtherCountry: type: string description: Alternate address details. OtherLatitude: type: number description: Used with OtherLongitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . OtherLongitude: type: number description: Used with OtherLatitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . OtherGeocodeAccuracy: type: string description: Accuracy level of the geocode for the other address. For details on geolocation compound fields, see . OtherAddress: type: object description: The compound form of the other address. Read-only. For details on compound address fields, see Address Compound Fields. MailingStreet: type: string description: Street address for mailing address. MailingCity: type: string description: Mailing address details. MailingState: type: string description: Mailing address details. MailingPostalCode: type: string description: Mailing address details. MailingCountry: type: string description: Mailing address details. MailingLatitude: type: number description: Used with MailingLongitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . MailingLongitude: type: number description: Used with MailingLatitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . MailingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see . MailingAddress: type: object description: The compound form of the mailing address. Read-only. For details on compound address fields, see Address Compound Fields. Phone: type: string description: Telephone number for the contact. Label is Business Phone. Fax: type: string description: The contact’s fax number. Label is Business Fax. MobilePhone: type: string description: Contact’s mobile phone number. HomePhone: type: string description: The contact’s home telephone number. OtherPhone: type: string description: Telephone for alternate address. AssistantPhone: type: string description: The assistant’s telephone number. ReportsToId: type: string description: This field doesn’t appear if IsPersonAccount is true. Email: type: string description: The contact’s email address. Title: type: string description: Title of the contact, such as CEO or Vice President. Department: type: string description: The contact’s department. AssistantName: type: string description: The assistant’s name. LeadSource: type: string description: The lead’s source. Birthdate: type: string description: The contact’s birthdate. Filter criteria for report filters, list view filters, and SOQL queries ignore the year portion of the Birthdate field. For example, this SOQL query returns contacts with birthdays later in the year than today:SELECT Name, Birthdate FROM Contact WHERE Birthdate > TODAY format: date Description: type: string description: A description of the contact. Label is Contact Description up to 32 KB. OwnerId: type: string description: The ID of the owner of the account associated with this contact. CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is the most recent of either: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastCURequestDate: type: string format: date-time LastCUUpdateDate: type: string format: date-time LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time EmailBouncedReason: type: string description: If bounce management is activated and an email sent to the contact bounces, the reason for the bounce. EmailBouncedDate: type: string description: If bounce management is activated and an email sent to the contact bounces, the date and time of the bounce. format: date-time IsEmailBounced: type: boolean description: If bounce management is activated and an email is sent to a contact, indicates whether the email bounced (true) or not (false). PhotoUrl: type: string description: 'Path to be combined with the URL of a Salesforce instance (Example: https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the contact. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the contact. Empty if Social Accounts and Contacts isn''t enabled or if Social Accounts and Contacts is disabled for the requesting user.' Jigsaw: type: string description: References the company’s ID in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify this value. JigsawContactId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values include: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus appear with different labels on the contact record. Matched appears as In Sync Acknowledged appears as Reviewed Pending appears as Not Compared' IndividualId: type: string description: ID of the data privacy record associated with this contact. This field is available if Data Protection and Privacy is enabled. attributes: type: object properties: type: type: string url: type: string description: Represents a contact, which is a person associated with an account. ShippingStreet: title: ShippingStreet required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The street address of the shipping address for this account. Maximum of 255 characters. Custom: title: Custom required: - type type: object properties: type: type: string example: example_value examples: - type: boolean SecuritySchemes: title: SecuritySchemes required: - openIDConnectDiscovery - bearerAuth - oAuth2 type: object properties: openIDConnectDiscovery: $ref: '#/components/schemas/OpenIDConnectDiscovery' bearerAuth: $ref: '#/components/schemas/BearerAuth' oAuth2: $ref: '#/components/schemas/OAuth2' examples: - openIDConnectDiscovery: type: openIdConnect openIdConnectUrl: https://login.salesforce.com/.well-known/openid-configuration bearerAuth: type: http description: Use Session Id or Access Token as valid bearer token to authenticate with Salesforce. Access Token could be retrieved via any supported OAuth2 flows listed or not listed here (e.g. JWT Bearer Token Flow).To obtain a session ID, you can use the SOAP API login() call or through the Salesforce CLI. scheme: bearer oAuth2: type: oauth2 description: 'For more information on all supported OAuth Flows, please see ''https://help.salesforce.com/articleView?id=remoteaccess_oauth_flows.htm&type=5''. For more information on all available scope options, please see ''https://help.salesforce.com/articleView?id=remoteaccess_oauth_tokens_scopes.htm&type=5#oauth_scopes''. ' flows: implicit: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. password: tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. authorizationCode: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. Fields: title: Fields required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items18' examples: - type: array items: type: string MailingState: title: MailingState required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Mailing address details. Updateable: title: Updateable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Replicateable: title: Replicateable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Url: title: Url required: - type type: object properties: type: type: string example: example_value examples: - type: string ErrorInfo: title: ErrorInfo required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties6' examples: - type: object properties: message: type: string errorCode: type: string fields: type: array items: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string Errors12: title: Errors12 required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items20' examples: - type: array items: type: object properties: message: type: string fields: type: array items: type: string statusCode: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string PhotoUrl: title: PhotoUrl required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. Blank if Social Accounts and Contacts isn't enabled for the org or if Social Accounts and Contacts is disabled for the requesting user. Items17: title: Items17 required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties2' examples: - type: object properties: id: type: string OtherPostalCode: title: OtherPostalCode required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Alternate address details. StatusCode: title: StatusCode required: - type type: object properties: type: type: string example: example_value examples: - type: string Name14: title: Name14 required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: 'Required. Label is Account Name. Name of the account. Maximum size is 255 characters. If the account has a record type of Person Account: This value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. You can''t modify this value.' ChannelProgramLevelName: title: ChannelProgramLevelName required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Read only. Name of the channel program level the account has enrolled.If this account has enrolled more than one channel program level, the oldest channel program name will be displayed. Attributes15: title: Attributes15 required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties5' examples: - type: object properties: type: type: string url: type: string BearerAuth: title: BearerAuth required: - type - description - scheme type: object properties: type: type: string example: example_value description: type: string example: A sample description. scheme: type: string example: example_value examples: - type: http description: Use Session Id or Access Token as valid bearer token to authenticate with Salesforce. Access Token could be retrieved via any supported OAuth2 flows listed or not listed here (e.g. JWT Bearer Token Flow).To obtain a session ID, you can use the SOAP API login() call or through the Salesforce CLI. scheme: bearer Type4: title: Type4 required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Type of account, for example, Customer, Competitor, or Partner. Step: title: Step required: - actionType - assignment - description - name - resultIncluded - sequenceNumber - shouldExposeConditionDetails - shouldExposeExecPathMsgOnly - shouldShowExplExternally - stepType type: object properties: actionType: type: string example: example_value assignment: $ref: '#/components/schemas/Assignment' description: type: string example: A sample description. name: type: string example: Example Title resultIncluded: type: boolean example: true sequenceNumber: type: integer contentEncoding: int32 example: 10 shouldExposeConditionDetails: type: boolean example: true shouldExposeExecPathMsgOnly: type: boolean example: true shouldShowExplExternally: type: boolean example: true stepType: type: string example: example_value examples: - actionType: AssignParameterValues assignment: assignedParameter: condition_output__1 expression: 'true' description: my Description name: myCalculation resultIncluded: true sequenceNumber: 1 shouldExposeConditionDetails: false shouldExposeExecPathMsgOnly: true shouldShowExplExternally: false stepType: BusinessKnowledgeModel BillingAddress: title: BillingAddress required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: object description: The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields. Status400-PreviouslyDeletedRecord1: title: Status400-PreviouslyDeletedRecord1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: INVALID_INPUT message: The expression set id is not available. IsInterface: title: IsInterface required: - type type: object properties: type: type: string example: example_value examples: - type: boolean IsEmailBounced: title: IsEmailBounced required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: boolean description: If bounce management is activated and an email is sent to a contact, indicates whether the email bounced (true) or not (false). MailingLatitude: title: MailingLatitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with MailingLongitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . BillingCity: title: BillingCity required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details for the billing address of this account. Maximum size is 40 characters. BillingPostalCode: title: BillingPostalCode required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details for the billing address of this account. Maximum size is 20 characters. Paths: title: Paths required: - /sobjects/Contact type: object properties: /sobjects/Contact: $ref: '#/components/schemas/SobjectsContact' MobilePhone: title: MobilePhone required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Contact’s mobile phone number. LastViewedDate: title: LastViewedDate required: - type - description - format type: object properties: type: type: string example: example_value description: type: string example: A sample description. format: type: string example: example_value examples: - type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time Rating: title: Rating required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The account’s prospect rating, for example Hot, Warm, or Cold. AnnualRevenue: title: AnnualRevenue required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Estimated annual revenue of the account. ShippingCity: title: ShippingCity required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details of the shipping address for this account. City maximum size is 40 characters LabelPlural: title: LabelPlural required: - type type: object properties: type: type: string example: example_value examples: - type: string Department: title: Department required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The contact’s department. OtherStreet: title: OtherStreet required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Street for alternate address. Label: title: Label required: - type type: object properties: type: type: string example: example_value examples: - type: string ExtendedErrorDetails1: title: ExtendedErrorDetails1 required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items22' examples: - type: array items: type: object properties: extendedErrorCode: type: string Infos: title: Infos required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items23' examples: - type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string Properties10: title: Properties10 required: - message - statusCode - extendedDetails type: object properties: message: $ref: '#/components/schemas/Message' statusCode: $ref: '#/components/schemas/StatusCode' extendedDetails: $ref: '#/components/schemas/ExtendedDetails' examples: - message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string ShippingState: title: ShippingState required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details of the shipping address for this account. State maximum size is 80 characters. Message: title: Message required: - type type: object properties: type: type: string example: example_value examples: - type: string Security: title: Security type: object properties: bearerAuth: type: array items: type: string description: '' example: [] oAuth2: type: array items: type: string description: '' example: [] openIDConnectDiscovery: type: array items: type: string description: '' example: [] examples: - bearerAuth: [] CleanStatus: title: CleanStatus required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: 'Indicates the record’s clean status as compared with Data.com. Values are: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus display with different labels on the account record detail page. Matched displays as In Sync Acknowledged displays as Reviewed Pending displays as Not Compared' ObjectDescribe: title: ObjectDescribe required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties1' examples: - type: object properties: name: type: string label: type: string labelPlural: type: string keyPrefix: type: string custom: type: boolean customSetting: type: boolean activateable: type: boolean createable: type: boolean updateable: type: boolean deletable: type: boolean undeletable: type: boolean mergeable: type: boolean replicateable: type: boolean triggerable: type: boolean queryable: type: boolean retrieveable: type: boolean searchable: type: boolean layoutable: type: boolean feedEnabled: type: boolean mruEnabled: type: boolean hasSubtypes: type: boolean isSubtype: type: boolean dataTranslationEnabled: type: boolean isInterface: type: boolean deepCloneable: type: boolean associateEntityType: type: string associateParentEntity: type: string deprecatedAndHidden: type: boolean urls: type: object additionalProperties: type: string LeadSource: title: LeadSource required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The lead’s source. EmailBouncedReason: title: EmailBouncedReason required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: If bounce management is activated and an email sent to the contact bounces, the reason for the bounce. Salutation: title: Salutation required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs. PotentialValueC: title: PotentialValueC required: - type type: object properties: type: type: string example: example_value examples: - type: number SLASerialNumberC: title: SLASerialNumberC required: - type type: object properties: type: type: string example: example_value examples: - type: string FirstName: title: FirstName required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The contact’s first name up to 40 characters. ShippingLatitude: title: ShippingLatitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Items19: title: Items19 required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties7' examples: - type: object properties: extendedErrorCode: type: string Server: title: Server required: - url type: object properties: url: type: string example: https://www.example.com examples: - url: https://pozil-dev-ed.my.salesforce.com/services/data/v60.0 LastModifiedById: title: LastModifiedById required: - type type: object properties: type: type: string example: example_value examples: - type: string Layoutable: title: Layoutable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Items20: title: Items20 required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties9' examples: - type: object properties: message: type: string fields: type: array items: type: string statusCode: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string Properties7: title: Properties7 required: - extendedErrorCode type: object properties: extendedErrorCode: $ref: '#/components/schemas/ExtendedErrorCode' examples: - extendedErrorCode: type: string ErrorCode: title: ErrorCode required: - type type: object properties: type: type: string example: example_value examples: - type: string IndividualId: title: IndividualId required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: ID of the data privacy record associated with this contact. This field is available if Data Protection and Privacy is enabled. Status200-RecordFound: title: Status200-RecordFound required: - apiName - contextDefinitions - id - name - usageType - versions type: object properties: apiName: type: string example: example_value contextDefinitions: type: array items: type: string description: '' example: [] id: type: string example: abc123 name: type: string example: Example Title usageType: type: string example: example_value versions: type: array items: $ref: '#/components/schemas/Version2' description: '' example: [] examples: - apiName: myExpressionSet contextDefinitions: [] id: 9QLHo000000LBjEOAW name: myExpressionSet usageType: Bre versions: - apiName: myExpressionSet_V1 description: myExpressionSet V1 Description enabled: true id: 9QMHo000000LBjJOAW name: myExpressionSet V1 rank: 1 showExplExternally: true startDate: '2023-09-06T09:27:06.000Z' steps: - actionType: AssignParameterValues assignment: assignedParameter: condition_output__1 expression: 'true' description: my Description name: myCalculation resultIncluded: true sequenceNumber: 1 shouldExposeConditionDetails: false shouldExposeExecPathMsgOnly: true shouldShowExplExternally: false stepType: BusinessKnowledgeModel variables: - collection: false dataType: Boolean description: condition_output__1 input: false name: condition_output__1 output: true type: Variable value: 'False' - collection: false dataType: Boolean description: condition_output__2 input: false name: condition_output__2 output: false type: Variable value: 'False' versionNumber: 1 Ownership: title: Ownership required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Ownership type for the account, for example Private, Public, or Subsidiary. Properties: title: Properties required: - objectDescribe - recentItems type: object properties: objectDescribe: $ref: '#/components/schemas/ObjectDescribe' recentItems: $ref: '#/components/schemas/RecentItems' examples: - objectDescribe: type: object properties: name: type: string label: type: string labelPlural: type: string keyPrefix: type: string custom: type: boolean customSetting: type: boolean activateable: type: boolean createable: type: boolean updateable: type: boolean deletable: type: boolean undeletable: type: boolean mergeable: type: boolean replicateable: type: boolean triggerable: type: boolean queryable: type: boolean retrieveable: type: boolean searchable: type: boolean layoutable: type: boolean feedEnabled: type: boolean mruEnabled: type: boolean hasSubtypes: type: boolean isSubtype: type: boolean dataTranslationEnabled: type: boolean isInterface: type: boolean deepCloneable: type: boolean associateEntityType: type: string associateParentEntity: type: string deprecatedAndHidden: type: boolean urls: type: object additionalProperties: type: string recentItems: type: array items: type: object properties: id: type: string LastModifiedDate: title: LastModifiedDate required: - type - format type: object properties: type: type: string example: example_value format: type: string example: example_value examples: - type: string format: date-time Name13: title: Name13 required: - type type: object properties: type: type: string example: example_value examples: - type: string BillingStreet: title: BillingStreet required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Street address for the billing address of this account. BillingLongitude: title: BillingLongitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. Post: title: Post required: - parameters - requestBody - responses type: object properties: parameters: type: array items: $ref: '#/components/schemas/Parameter4' description: '' example: [] requestBody: $ref: '#/components/schemas/RequestBody' responses: type: object additionalProperties: $ref: '#/components/schemas/m200' example: example_value DunsNumber: title: DunsNumber required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. SLAExpirationDateC: title: SLAExpirationDateC required: - type - format type: object properties: type: type: string example: example_value format: type: string example: example_value examples: - type: string format: date NaicsCode: title: NaicsCode required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. Maximum size is 8 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. YearStarted: title: YearStarted required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The date when an org was legally established. Maximum length is 4 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. BillingState: title: BillingState required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details for the billing address of this account. Maximum size is 80 characters. TickerSymbol: title: TickerSymbol required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The stock market symbol for this account. Maximum of 20 characters. This field is available on business accounts, not person accounts. ExtendedDetails: title: ExtendedDetails required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items22' examples: - type: array items: type: object properties: extendedErrorCode: type: string Industry: title: Industry required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: An industry associated with this account. Maximum size is 40 characters. OtherAddress: title: OtherAddress required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: object description: The compound form of the other address. Read-only. For details on compound address fields, see Address Compound Fields. OpenIDConnectDiscovery: title: OpenIDConnectDiscovery required: - type - openIdConnectUrl type: object properties: type: type: string example: example_value openIdConnectUrl: type: string example: https://www.example.com examples: - type: openIdConnect openIdConnectUrl: https://login.salesforce.com/.well-known/openid-configuration Status500-UnexpectedError1: title: Status500-UnexpectedError1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: INTERNAL_ERROR message: Unexpected Error CreatedDate: title: CreatedDate required: - type - format type: object properties: type: type: string example: example_value format: type: string example: example_value examples: - type: string format: date-time AssistantName: title: AssistantName required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The assistant’s name. Properties3: title: Properties3 required: - errorCode - message type: object properties: errorCode: $ref: '#/components/schemas/ErrorCode' message: $ref: '#/components/schemas/Message' examples: - errorCode: type: string message: type: string SaveResult: title: SaveResult required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties8' examples: - type: object properties: success: type: boolean id: type: string errors: type: array items: type: object properties: message: type: string fields: type: array items: type: string statusCode: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string warnings: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string infos: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string Attributes4: title: Attributes4 required: - type - url type: object properties: type: type: string example: example_value url: type: string example: https://www.example.com examples: - type: Account url: /services/data/v58.0/sobjects/Account/001... DeprecatedAndHidden: title: DeprecatedAndHidden required: - type type: object properties: type: type: string example: example_value examples: - type: boolean ExtendedErrorCode: title: ExtendedErrorCode required: - type type: object properties: type: type: string example: example_value examples: - type: string MailingStreet: title: MailingStreet required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Street address for mailing address. AccountSObject: title: AccountSObject required: - type - properties - description type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties4' description: type: string example: A sample description. examples: - type: object properties: Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. Name: type: string description: 'Required. Label is Account Name. Name of the account. Maximum size is 255 characters. If the account has a record type of Person Account: This value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. You can''t modify this value.' Type: type: string description: Type of account, for example, Customer, Competitor, or Partner. ParentId: type: string description: ID of the parent object, if any. BillingStreet: type: string description: Street address for the billing address of this account. BillingCity: type: string description: Details for the billing address of this account. Maximum size is 40 characters. BillingState: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingPostalCode: type: string description: Details for the billing address of this account. Maximum size is 20 characters. BillingCountry: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingLatitude: type: number description: Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingLongitude: type: number description: Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the billing address. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingAddress: type: object description: The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields. ShippingStreet: type: string description: The street address of the shipping address for this account. Maximum of 255 characters. ShippingCity: type: string description: Details of the shipping address for this account. City maximum size is 40 characters ShippingState: type: string description: Details of the shipping address for this account. State maximum size is 80 characters. ShippingPostalCode: type: string description: Details of the shipping address for this account. Postal code maximum size is 20 characters. ShippingCountry: type: string description: Details of the shipping address for this account. Country maximum size is 80 characters. ShippingLatitude: type: number description: Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingLongitude: type: number description: Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the shipping address. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingAddress: type: object description: The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields. Phone: type: string description: Phone number for this account. Maximum size is 40 characters. Fax: type: string description: Fax number for the account. AccountNumber: type: string description: Account number assigned to this account (not the unique, system-generated ID assigned during creation). Maximum size is 40 characters. Website: type: string description: The website of this account. Maximum of 255 characters. PhotoUrl: type: string description: Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. Blank if Social Accounts and Contacts isn't enabled for the org or if Social Accounts and Contacts is disabled for the requesting user. Sic: type: string description: Standard Industrial Classification code of the company’s main business categorization, for example, 57340 for Electronics. Maximum of 20 characters. This field is available on business accounts, not person accounts. Industry: type: string description: An industry associated with this account. Maximum size is 40 characters. AnnualRevenue: type: number description: Estimated annual revenue of the account. NumberOfEmployees: type: integer description: Label is Employees. Number of employees working at the company represented by this account. Maximum size is eight digits. Ownership: type: string description: Ownership type for the account, for example Private, Public, or Subsidiary. TickerSymbol: type: string description: The stock market symbol for this account. Maximum of 20 characters. This field is available on business accounts, not person accounts. Description: type: string description: Text description of the account. Limited to 32,000 KB. Rating: type: string description: The account’s prospect rating, for example Hot, Warm, or Cold. Site: type: string description: Name of the account’s location, for example Headquarters or London. Label is Account Site. Maximum of 80 characters. OwnerId: type: string description: 'The ID of the user who currently owns this account. Default value is the user logged in to the API to perform the create. If you have set up account teams in your org, updating this field has different consequences depending on your version of the API: For API version 12.0 and later, sharing records are kept, as they are for all objects. For API version before 12.0, sharing records are deleted. For API version 16.0 and later, users must have the “Transfer Record” permission in order to update (transfer) account ownership using this field.' CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is one of the following, whichever is the most recent: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time IsPartner: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's partner portal (true) or not (false). This field is available if partner relationship management (partner portal) is enabled ORdigitial experiences is enabled and you have partner portal licenses. If you change this field's value from true to false, you can disable up to 15 partner portal users associated with the account and permanently delete all of the account's partner portal roles and groups. You can't restore deleted partner portal roles and groups. Disabling a partner portal user in the Salesforce user interface or the API does not change this field's value from true to false. Even if this field's value is false, you can enable a contact on an account as a partner portal user via the API. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. IsCustomerPortal: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's Customer Portal (true) or not (false). This field is available if Customer Portal is enabled OR digital experiences is enabled and you have Customer Portal licenses. If you change this field's value from true to false, you can disable up to 100 Customer Portal users associated with the account and permanently delete all of the account's Customer Portal roles and groups. You can't restore deleted Customer Portal roles and groups. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. ChannelProgramName: type: string description: Read only. Name of the channel program the account has enrolled.If this account has enrolled more than one channel program, the oldest channel program name will be displayed. . ChannelProgramLevelName: type: string description: Read only. Name of the channel program level the account has enrolled.If this account has enrolled more than one channel program level, the oldest channel program name will be displayed. Jigsaw: type: string description: References the ID of a company in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key. This field is available on business accounts, not person accounts.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify the value in the Jigsaw field. JigsawCompanyId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values are: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus display with different labels on the account record detail page. Matched displays as In Sync Acknowledged displays as Reviewed Pending displays as Not Compared' AccountSource: type: string description: The source of the account record. For example, Advertisement, Data.com, or Trade Show. The source is selected from a picklist of available values, which are set by an administrator. Each picklist value can have up to 40 characters. DunsNumber: type: string description: The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. Tradestyle: type: string description: A name, different from its legal name, that an org may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum length is 255 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsCode: type: string description: The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. Maximum size is 8 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsDesc: type: string description: A brief description of an org’s line of business, based on its NAICS code. Maximum size is 120 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. YearStarted: type: string description: The date when an org was legally established. Maximum length is 4 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. SicDesc: type: string description: A brief description of an org’s line of business, based on its SIC code. Maximum length is 80 characters. This field is available on business accounts, not person accounts. DandbCompanyId: type: string CustomerPriority__c: type: string SLA__c: type: string Active__c: type: string NumberofLocations__c: type: number UpsellOpportunity__c: type: string SLASerialNumber__c: type: string SLAExpirationDate__c: type: string format: date Potential_Value__c: type: number Match_Billing_Address__c: type: boolean Number_of_Contacts__c: type: number Region__c: type: string attributes: type: object properties: type: type: string url: type: string description: Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners). SLAC: title: SLAC required: - type type: object properties: type: type: string example: example_value examples: - type: string OwnerId: title: OwnerId required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: 'The ID of the user who currently owns this account. Default value is the user logged in to the API to perform the create. If you have set up account teams in your org, updating this field has different consequences depending on your version of the API: For API version 12.0 and later, sharing records are kept, as they are for all objects. For API version before 12.0, sharing records are deleted. For API version 16.0 and later, users must have the “Transfer Record” permission in order to update (transfer) account ownership using this field.' ParentId: title: ParentId required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: ID of the parent object, if any. SObjectRootInfo: title: SObjectRootInfo required: - type - properties type: object properties: type: type: string example: example_value properties: $ref: '#/components/schemas/Properties' examples: - type: object properties: objectDescribe: type: object properties: name: type: string label: type: string labelPlural: type: string keyPrefix: type: string custom: type: boolean customSetting: type: boolean activateable: type: boolean createable: type: boolean updateable: type: boolean deletable: type: boolean undeletable: type: boolean mergeable: type: boolean replicateable: type: boolean triggerable: type: boolean queryable: type: boolean retrieveable: type: boolean searchable: type: boolean layoutable: type: boolean feedEnabled: type: boolean mruEnabled: type: boolean hasSubtypes: type: boolean isSubtype: type: boolean dataTranslationEnabled: type: boolean isInterface: type: boolean deepCloneable: type: boolean associateEntityType: type: string associateParentEntity: type: string deprecatedAndHidden: type: boolean urls: type: object additionalProperties: type: string recentItems: type: array items: type: object properties: id: type: string Version2: title: Version2 required: - apiName - description - enabled - id - name - rank - showExplExternally - startDate - steps - variables - versionNumber type: object properties: apiName: type: string example: example_value description: type: string example: A sample description. enabled: type: boolean example: true id: type: string example: abc123 name: type: string example: Example Title rank: type: integer contentEncoding: int32 example: 10 showExplExternally: type: boolean example: true startDate: type: string example: example_value steps: type: array items: $ref: '#/components/schemas/Step' description: '' example: [] variables: type: array items: $ref: '#/components/schemas/Variable' description: '' example: [] versionNumber: type: integer contentEncoding: int32 example: 10 examples: - apiName: myExpressionSet_V1 description: myExpressionSet V1 Description enabled: true id: 9QMHo000000LBjJOAW name: myExpressionSet V1 rank: 1 showExplExternally: true startDate: '2023-09-06T09:27:06.000Z' steps: - actionType: AssignParameterValues assignment: assignedParameter: condition_output__1 expression: 'true' description: my Description name: myCalculation resultIncluded: true sequenceNumber: 1 shouldExposeConditionDetails: false shouldExposeExecPathMsgOnly: true shouldShowExplExternally: false stepType: BusinessKnowledgeModel variables: - collection: false dataType: Boolean description: condition_output__1 input: false name: condition_output__1 output: true type: Variable value: 'False' - collection: false dataType: Boolean description: condition_output__2 input: false name: condition_output__2 output: false type: Variable value: 'False' versionNumber: 1 Items22: title: Items22 required: - type - properties type: object properties: type: type: string example: example_value properties: type: object example: example_value examples: - type: object properties: extendedErrorCode: type: string JigsawContactId: title: JigsawContactId required: - type type: object properties: type: type: string example: example_value examples: - type: string Schemas: title: Schemas required: - SObjectRootInfo - RestApiError - AccountSObject - ErrorInfo - SaveResult - ContactSObject type: object properties: SObjectRootInfo: $ref: '#/components/schemas/SObjectRootInfo' RestApiError: $ref: '#/components/schemas/RestApiError' AccountSObject: $ref: '#/components/schemas/AccountSObject' ErrorInfo: $ref: '#/components/schemas/ErrorInfo' SaveResult: $ref: '#/components/schemas/SaveResult' ContactSObject: $ref: '#/components/schemas/ContactSObject' examples: - SObjectRootInfo: type: object properties: objectDescribe: type: object properties: name: type: string label: type: string labelPlural: type: string keyPrefix: type: string custom: type: boolean customSetting: type: boolean activateable: type: boolean createable: type: boolean updateable: type: boolean deletable: type: boolean undeletable: type: boolean mergeable: type: boolean replicateable: type: boolean triggerable: type: boolean queryable: type: boolean retrieveable: type: boolean searchable: type: boolean layoutable: type: boolean feedEnabled: type: boolean mruEnabled: type: boolean hasSubtypes: type: boolean isSubtype: type: boolean dataTranslationEnabled: type: boolean isInterface: type: boolean deepCloneable: type: boolean associateEntityType: type: string associateParentEntity: type: string deprecatedAndHidden: type: boolean urls: type: object additionalProperties: type: string recentItems: type: array items: type: object properties: id: type: string RestApiError: type: object properties: errorCode: type: string message: type: string AccountSObject: type: object properties: Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. Name: type: string description: 'Required. Label is Account Name. Name of the account. Maximum size is 255 characters. If the account has a record type of Person Account: This value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. You can''t modify this value.' Type: type: string description: Type of account, for example, Customer, Competitor, or Partner. ParentId: type: string description: ID of the parent object, if any. BillingStreet: type: string description: Street address for the billing address of this account. BillingCity: type: string description: Details for the billing address of this account. Maximum size is 40 characters. BillingState: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingPostalCode: type: string description: Details for the billing address of this account. Maximum size is 20 characters. BillingCountry: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingLatitude: type: number description: Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingLongitude: type: number description: Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the billing address. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingAddress: type: object description: The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields. ShippingStreet: type: string description: The street address of the shipping address for this account. Maximum of 255 characters. ShippingCity: type: string description: Details of the shipping address for this account. City maximum size is 40 characters ShippingState: type: string description: Details of the shipping address for this account. State maximum size is 80 characters. ShippingPostalCode: type: string description: Details of the shipping address for this account. Postal code maximum size is 20 characters. ShippingCountry: type: string description: Details of the shipping address for this account. Country maximum size is 80 characters. ShippingLatitude: type: number description: Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingLongitude: type: number description: Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the shipping address. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingAddress: type: object description: The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields. Phone: type: string description: Phone number for this account. Maximum size is 40 characters. Fax: type: string description: Fax number for the account. AccountNumber: type: string description: Account number assigned to this account (not the unique, system-generated ID assigned during creation). Maximum size is 40 characters. Website: type: string description: The website of this account. Maximum of 255 characters. PhotoUrl: type: string description: Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. Blank if Social Accounts and Contacts isn't enabled for the org or if Social Accounts and Contacts is disabled for the requesting user. Sic: type: string description: Standard Industrial Classification code of the company’s main business categorization, for example, 57340 for Electronics. Maximum of 20 characters. This field is available on business accounts, not person accounts. Industry: type: string description: An industry associated with this account. Maximum size is 40 characters. AnnualRevenue: type: number description: Estimated annual revenue of the account. NumberOfEmployees: type: integer description: Label is Employees. Number of employees working at the company represented by this account. Maximum size is eight digits. Ownership: type: string description: Ownership type for the account, for example Private, Public, or Subsidiary. TickerSymbol: type: string description: The stock market symbol for this account. Maximum of 20 characters. This field is available on business accounts, not person accounts. Description: type: string description: Text description of the account. Limited to 32,000 KB. Rating: type: string description: The account’s prospect rating, for example Hot, Warm, or Cold. Site: type: string description: Name of the account’s location, for example Headquarters or London. Label is Account Site. Maximum of 80 characters. OwnerId: type: string description: 'The ID of the user who currently owns this account. Default value is the user logged in to the API to perform the create. If you have set up account teams in your org, updating this field has different consequences depending on your version of the API: For API version 12.0 and later, sharing records are kept, as they are for all objects. For API version before 12.0, sharing records are deleted. For API version 16.0 and later, users must have the “Transfer Record” permission in order to update (transfer) account ownership using this field.' CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is one of the following, whichever is the most recent: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time IsPartner: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's partner portal (true) or not (false). This field is available if partner relationship management (partner portal) is enabled ORdigitial experiences is enabled and you have partner portal licenses. If you change this field's value from true to false, you can disable up to 15 partner portal users associated with the account and permanently delete all of the account's partner portal roles and groups. You can't restore deleted partner portal roles and groups. Disabling a partner portal user in the Salesforce user interface or the API does not change this field's value from true to false. Even if this field's value is false, you can enable a contact on an account as a partner portal user via the API. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. IsCustomerPortal: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's Customer Portal (true) or not (false). This field is available if Customer Portal is enabled OR digital experiences is enabled and you have Customer Portal licenses. If you change this field's value from true to false, you can disable up to 100 Customer Portal users associated with the account and permanently delete all of the account's Customer Portal roles and groups. You can't restore deleted Customer Portal roles and groups. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. ChannelProgramName: type: string description: Read only. Name of the channel program the account has enrolled.If this account has enrolled more than one channel program, the oldest channel program name will be displayed. . ChannelProgramLevelName: type: string description: Read only. Name of the channel program level the account has enrolled.If this account has enrolled more than one channel program level, the oldest channel program name will be displayed. Jigsaw: type: string description: References the ID of a company in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key. This field is available on business accounts, not person accounts.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify the value in the Jigsaw field. JigsawCompanyId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values are: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus display with different labels on the account record detail page. Matched displays as In Sync Acknowledged displays as Reviewed Pending displays as Not Compared' AccountSource: type: string description: The source of the account record. For example, Advertisement, Data.com, or Trade Show. The source is selected from a picklist of available values, which are set by an administrator. Each picklist value can have up to 40 characters. DunsNumber: type: string description: The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. Tradestyle: type: string description: A name, different from its legal name, that an org may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum length is 255 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsCode: type: string description: The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. Maximum size is 8 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsDesc: type: string description: A brief description of an org’s line of business, based on its NAICS code. Maximum size is 120 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. YearStarted: type: string description: The date when an org was legally established. Maximum length is 4 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. SicDesc: type: string description: A brief description of an org’s line of business, based on its SIC code. Maximum length is 80 characters. This field is available on business accounts, not person accounts. DandbCompanyId: type: string CustomerPriority__c: type: string SLA__c: type: string Active__c: type: string NumberofLocations__c: type: number UpsellOpportunity__c: type: string SLASerialNumber__c: type: string SLAExpirationDate__c: type: string format: date Potential_Value__c: type: number Match_Billing_Address__c: type: boolean Number_of_Contacts__c: type: number Region__c: type: string attributes: type: object properties: type: type: string url: type: string description: Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners). ErrorInfo: type: object properties: message: type: string errorCode: type: string fields: type: array items: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string SaveResult: type: object properties: success: type: boolean id: type: string errors: type: array items: type: object properties: message: type: string fields: type: array items: type: string statusCode: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string warnings: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string infos: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string ContactSObject: type: object properties: Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this record was deleted as the result of a merge, this field contains the ID of the record that remains. If this record was deleted for any other reason, or has not been deleted, the value is null. AccountId: type: string description: ID of the account that’s the parent of this contact. We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. LastName: type: string description: Required. Last name of the contact up to 80 characters. FirstName: type: string description: The contact’s first name up to 40 characters. Salutation: type: string description: Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs. Name: type: string description: Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces. OtherStreet: type: string description: Street for alternate address. OtherCity: type: string description: Alternate address details. OtherState: type: string description: Alternate address details. OtherPostalCode: type: string description: Alternate address details. OtherCountry: type: string description: Alternate address details. OtherLatitude: type: number description: Used with OtherLongitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . OtherLongitude: type: number description: Used with OtherLatitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . OtherGeocodeAccuracy: type: string description: Accuracy level of the geocode for the other address. For details on geolocation compound fields, see . OtherAddress: type: object description: The compound form of the other address. Read-only. For details on compound address fields, see Address Compound Fields. MailingStreet: type: string description: Street address for mailing address. MailingCity: type: string description: Mailing address details. MailingState: type: string description: Mailing address details. MailingPostalCode: type: string description: Mailing address details. MailingCountry: type: string description: Mailing address details. MailingLatitude: type: number description: Used with MailingLongitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . MailingLongitude: type: number description: Used with MailingLatitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . MailingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see . MailingAddress: type: object description: The compound form of the mailing address. Read-only. For details on compound address fields, see Address Compound Fields. Phone: type: string description: Telephone number for the contact. Label is Business Phone. Fax: type: string description: The contact’s fax number. Label is Business Fax. MobilePhone: type: string description: Contact’s mobile phone number. HomePhone: type: string description: The contact’s home telephone number. OtherPhone: type: string description: Telephone for alternate address. AssistantPhone: type: string description: The assistant’s telephone number. ReportsToId: type: string description: This field doesn’t appear if IsPersonAccount is true. Email: type: string description: The contact’s email address. Title: type: string description: Title of the contact, such as CEO or Vice President. Department: type: string description: The contact’s department. AssistantName: type: string description: The assistant’s name. LeadSource: type: string description: The lead’s source. Birthdate: type: string description: The contact’s birthdate. Filter criteria for report filters, list view filters, and SOQL queries ignore the year portion of the Birthdate field. For example, this SOQL query returns contacts with birthdays later in the year than today:SELECT Name, Birthdate FROM Contact WHERE Birthdate > TODAY format: date Description: type: string description: A description of the contact. Label is Contact Description up to 32 KB. OwnerId: type: string description: The ID of the owner of the account associated with this contact. CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is the most recent of either: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastCURequestDate: type: string format: date-time LastCUUpdateDate: type: string format: date-time LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time EmailBouncedReason: type: string description: If bounce management is activated and an email sent to the contact bounces, the reason for the bounce. EmailBouncedDate: type: string description: If bounce management is activated and an email sent to the contact bounces, the date and time of the bounce. format: date-time IsEmailBounced: type: boolean description: If bounce management is activated and an email is sent to a contact, indicates whether the email bounced (true) or not (false). PhotoUrl: type: string description: 'Path to be combined with the URL of a Salesforce instance (Example: https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the contact. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the contact. Empty if Social Accounts and Contacts isn''t enabled or if Social Accounts and Contacts is disabled for the requesting user.' Jigsaw: type: string description: References the company’s ID in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify this value. JigsawContactId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values include: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus appear with different labels on the contact record. Matched appears as In Sync Acknowledged appears as Reviewed Pending appears as Not Compared' IndividualId: type: string description: ID of the data privacy record associated with this contact. This field is available if Data Protection and Privacy is enabled. attributes: type: object properties: type: type: string url: type: string description: Represents a contact, which is a person associated with an account. SicDesc: title: SicDesc required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: A brief description of an org’s line of business, based on its SIC code. Maximum length is 80 characters. This field is available on business accounts, not person accounts. IsCustomerPortal: title: IsCustomerPortal required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: boolean description: Indicates whether the account has at least one contact enabled to use the org's Customer Portal (true) or not (false). This field is available if Customer Portal is enabled OR digital experiences is enabled and you have Customer Portal licenses. If you change this field's value from true to false, you can disable up to 100 Customer Portal users associated with the account and permanently delete all of the account's Customer Portal roles and groups. You can't restore deleted Customer Portal roles and groups. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. SuccessfulSObjectCollectionsRetrieve: title: SuccessfulSObjectCollectionsRetrieve required: - attributes - Name - Id type: object properties: attributes: $ref: '#/components/schemas/Attributes4' Name: type: string example: Example Title Id: type: string example: abc123 examples: - attributes: type: Account url: /services/data/v58.0/sobjects/Account/001... Name: Sample Account Id: 001... CustomSetting: title: CustomSetting required: - type type: object properties: type: type: string example: example_value examples: - type: boolean OAuth2: title: OAuth2 required: - type - description - flows type: object properties: type: type: string example: example_value description: type: string example: A sample description. flows: $ref: '#/components/schemas/Flows' examples: - type: oauth2 description: 'For more information on all supported OAuth Flows, please see ''https://help.salesforce.com/articleView?id=remoteaccess_oauth_flows.htm&type=5''. For more information on all available scope options, please see ''https://help.salesforce.com/articleView?id=remoteaccess_oauth_tokens_scopes.htm&type=5#oauth_scopes''. ' flows: implicit: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. password: tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. authorizationCode: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. Status400-BadRequest1: title: Status400-BadRequest1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: INVALID_ID_FIELD message: 'Invalid identifier: 9QLHo000000LBjJOAW' Parameter4: title: Parameter4 required: - name - in - description - required - schema type: object properties: name: type: string example: Example Title in: type: string example: example_value description: type: string example: A sample description. required: type: boolean example: true schema: $ref: '#/components/schemas/Schema10' examples: - name: Content-Type in: header description: 'An optional header, which can only be used with POST, specifying the format for the request and response. Possible choices are: Content-Type: application/json Content-Type: application/xml' required: true schema: type: string AdditionalProperties: title: AdditionalProperties required: - type type: object properties: type: type: string example: example_value examples: - type: string Schema: title: Schema required: - $ref type: object properties: $ref: type: string example: example_value Mergeable: title: Mergeable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean AssociateEntityType: title: AssociateEntityType required: - type type: object properties: type: type: string example: example_value examples: - type: string AuthorizationCode: title: AuthorizationCode required: - authorizationUrl - tokenUrl - scopes type: object properties: authorizationUrl: type: string example: https://www.example.com tokenUrl: type: string example: https://www.example.com scopes: $ref: '#/components/schemas/Scopes' examples: - authorizationUrl: https://login.salesforce.com/services/oauth2/authorize tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. OtherPhone: title: OtherPhone required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Telephone for alternate address. Properties2: title: Properties2 required: - id type: object properties: id: $ref: '#/components/schemas/Id' examples: - id: type: string UpsellOpportunityC: title: UpsellOpportunityC required: - type type: object properties: type: type: string example: example_value examples: - type: string Flows: title: Flows required: - implicit - password - authorizationCode type: object properties: implicit: $ref: '#/components/schemas/Implicit' password: $ref: '#/components/schemas/Password' authorizationCode: $ref: '#/components/schemas/AuthorizationCode' examples: - implicit: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. password: tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. authorizationCode: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. OtherLongitude: title: OtherLongitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with OtherLatitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . Items18: title: Items18 required: - type type: object properties: type: type: string example: example_value examples: - type: string ChannelProgramName: title: ChannelProgramName required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Read only. Name of the channel program the account has enrolled.If this account has enrolled more than one channel program, the oldest channel program name will be displayed. . Warnings: title: Warnings required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items23' examples: - type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string Activateable: title: Activateable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean IsPartner: title: IsPartner required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: boolean description: Indicates whether the account has at least one contact enabled to use the org's partner portal (true) or not (false). This field is available if partner relationship management (partner portal) is enabled ORdigitial experiences is enabled and you have partner portal licenses. If you change this field's value from true to false, you can disable up to 15 partner portal users associated with the account and permanently delete all of the account's partner portal roles and groups. You can't restore deleted partner portal roles and groups. Disabling a partner portal user in the Salesforce user interface or the API does not change this field's value from true to false. Even if this field's value is false, you can enable a contact on an account as a partner portal user via the API. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. BillingGeocodeAccuracy: title: BillingGeocodeAccuracy required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Accuracy level of the geocode for the billing address. See Compound Field Considerations and Limitations for details on geolocation compound fields. EmailBouncedDate: title: EmailBouncedDate required: - type - description - format type: object properties: type: type: string example: example_value description: type: string example: A sample description. format: type: string example: example_value examples: - type: string description: If bounce management is activated and an email sent to the contact bounces, the date and time of the bounce. format: date-time Id: title: Id required: - type type: object properties: type: type: string example: example_value examples: - type: string Birthdate: title: Birthdate required: - type - description - format type: object properties: type: type: string example: example_value description: type: string example: A sample description. format: type: string example: example_value examples: - type: string description: The contact’s birthdate. Filter criteria for report filters, list view filters, and SOQL queries ignore the year portion of the Birthdate field. For example, this SOQL query returns contacts with birthdays later in the year than today:SELECT Name, Birthdate FROM Contact WHERE Birthdate > TODAY format: date MailingCity: title: MailingCity required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Mailing address details. Sic: title: Sic required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Standard Industrial Classification code of the company’s main business categorization, for example, 57340 for Electronics. Maximum of 20 characters. This field is available on business accounts, not person accounts. Jigsaw: title: Jigsaw required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: References the ID of a company in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key. This field is available on business accounts, not person accounts.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify the value in the Jigsaw field. Properties5: title: Properties5 required: - type - url type: object properties: type: $ref: '#/components/schemas/Type5' url: $ref: '#/components/schemas/Url' examples: - type: type: string url: type: string Success: title: Success required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Properties4: title: Properties4 required: - Id - IsDeleted - MasterRecordId - Name - Type - ParentId - BillingStreet - BillingCity - BillingState - BillingPostalCode - BillingCountry - BillingLatitude - BillingLongitude - BillingGeocodeAccuracy - BillingAddress - ShippingStreet - ShippingCity - ShippingState - ShippingPostalCode - ShippingCountry - ShippingLatitude - ShippingLongitude - ShippingGeocodeAccuracy - ShippingAddress - Phone - Fax - AccountNumber - Website - PhotoUrl - Sic - Industry - AnnualRevenue - NumberOfEmployees - Ownership - TickerSymbol - Description - Rating - Site - OwnerId - CreatedDate - CreatedById - LastModifiedDate - LastModifiedById - SystemModstamp - LastActivityDate - LastViewedDate - LastReferencedDate - IsPartner - IsCustomerPortal - ChannelProgramName - ChannelProgramLevelName - Jigsaw - JigsawCompanyId - CleanStatus - AccountSource - DunsNumber - Tradestyle - NaicsCode - NaicsDesc - YearStarted - SicDesc - DandbCompanyId - CustomerPriority__c - SLA__c - Active__c - NumberofLocations__c - UpsellOpportunity__c - SLASerialNumber__c - SLAExpirationDate__c - Potential_Value__c - Match_Billing_Address__c - Number_of_Contacts__c - Region__c - attributes type: object properties: Id: $ref: '#/components/schemas/Id' IsDeleted: $ref: '#/components/schemas/IsDeleted' MasterRecordId: $ref: '#/components/schemas/MasterRecordId' Name: $ref: '#/components/schemas/Name14' Type: $ref: '#/components/schemas/Type4' ParentId: $ref: '#/components/schemas/ParentId' BillingStreet: $ref: '#/components/schemas/BillingStreet' BillingCity: $ref: '#/components/schemas/BillingCity' BillingState: $ref: '#/components/schemas/BillingState' BillingPostalCode: $ref: '#/components/schemas/BillingPostalCode' BillingCountry: $ref: '#/components/schemas/BillingCountry' BillingLatitude: $ref: '#/components/schemas/BillingLatitude' BillingLongitude: $ref: '#/components/schemas/BillingLongitude' BillingGeocodeAccuracy: $ref: '#/components/schemas/BillingGeocodeAccuracy' BillingAddress: $ref: '#/components/schemas/BillingAddress' ShippingStreet: $ref: '#/components/schemas/ShippingStreet' ShippingCity: $ref: '#/components/schemas/ShippingCity' ShippingState: $ref: '#/components/schemas/ShippingState' ShippingPostalCode: $ref: '#/components/schemas/ShippingPostalCode' ShippingCountry: $ref: '#/components/schemas/ShippingCountry' ShippingLatitude: $ref: '#/components/schemas/ShippingLatitude' ShippingLongitude: $ref: '#/components/schemas/ShippingLongitude' ShippingGeocodeAccuracy: $ref: '#/components/schemas/ShippingGeocodeAccuracy' ShippingAddress: $ref: '#/components/schemas/ShippingAddress' Phone: $ref: '#/components/schemas/Phone' Fax: $ref: '#/components/schemas/Fax' AccountNumber: $ref: '#/components/schemas/AccountNumber' Website: $ref: '#/components/schemas/Website' PhotoUrl: $ref: '#/components/schemas/PhotoUrl' Sic: $ref: '#/components/schemas/Sic' Industry: $ref: '#/components/schemas/Industry' AnnualRevenue: $ref: '#/components/schemas/AnnualRevenue' NumberOfEmployees: $ref: '#/components/schemas/NumberOfEmployees' Ownership: $ref: '#/components/schemas/Ownership' TickerSymbol: $ref: '#/components/schemas/TickerSymbol' Description: $ref: '#/components/schemas/Description3' Rating: $ref: '#/components/schemas/Rating' Site: $ref: '#/components/schemas/Site' OwnerId: $ref: '#/components/schemas/OwnerId' CreatedDate: $ref: '#/components/schemas/CreatedDate' CreatedById: $ref: '#/components/schemas/CreatedById' LastModifiedDate: $ref: '#/components/schemas/LastModifiedDate' LastModifiedById: $ref: '#/components/schemas/LastModifiedById' SystemModstamp: $ref: '#/components/schemas/SystemModstamp' LastActivityDate: $ref: '#/components/schemas/LastActivityDate' LastViewedDate: $ref: '#/components/schemas/LastViewedDate' LastReferencedDate: $ref: '#/components/schemas/LastReferencedDate' IsPartner: $ref: '#/components/schemas/IsPartner' IsCustomerPortal: $ref: '#/components/schemas/IsCustomerPortal' ChannelProgramName: $ref: '#/components/schemas/ChannelProgramName' ChannelProgramLevelName: $ref: '#/components/schemas/ChannelProgramLevelName' Jigsaw: $ref: '#/components/schemas/Jigsaw' JigsawCompanyId: $ref: '#/components/schemas/JigsawCompanyId' CleanStatus: $ref: '#/components/schemas/CleanStatus' AccountSource: $ref: '#/components/schemas/AccountSource' DunsNumber: $ref: '#/components/schemas/DunsNumber' Tradestyle: $ref: '#/components/schemas/Tradestyle' NaicsCode: $ref: '#/components/schemas/NaicsCode' NaicsDesc: $ref: '#/components/schemas/NaicsDesc' YearStarted: $ref: '#/components/schemas/YearStarted' SicDesc: $ref: '#/components/schemas/SicDesc' DandbCompanyId: $ref: '#/components/schemas/DandbCompanyId' CustomerPriority__c: $ref: '#/components/schemas/CustomerPriorityC' SLA__c: $ref: '#/components/schemas/SLAC' Active__c: $ref: '#/components/schemas/ActiveC' NumberofLocations__c: $ref: '#/components/schemas/NumberofLocationsC' UpsellOpportunity__c: $ref: '#/components/schemas/UpsellOpportunityC' SLASerialNumber__c: $ref: '#/components/schemas/SLASerialNumberC' SLAExpirationDate__c: $ref: '#/components/schemas/SLAExpirationDateC' Potential_Value__c: $ref: '#/components/schemas/PotentialValueC' Match_Billing_Address__c: $ref: '#/components/schemas/MatchBillingAddressC' Number_of_Contacts__c: $ref: '#/components/schemas/NumberOfContactsC' Region__c: $ref: '#/components/schemas/RegionC' attributes: $ref: '#/components/schemas/Attributes15' examples: - Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. Name: type: string description: 'Required. Label is Account Name. Name of the account. Maximum size is 255 characters. If the account has a record type of Person Account: This value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. You can''t modify this value.' Type: type: string description: Type of account, for example, Customer, Competitor, or Partner. ParentId: type: string description: ID of the parent object, if any. BillingStreet: type: string description: Street address for the billing address of this account. BillingCity: type: string description: Details for the billing address of this account. Maximum size is 40 characters. BillingState: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingPostalCode: type: string description: Details for the billing address of this account. Maximum size is 20 characters. BillingCountry: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingLatitude: type: number description: Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingLongitude: type: number description: Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the billing address. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingAddress: type: object description: The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields. ShippingStreet: type: string description: The street address of the shipping address for this account. Maximum of 255 characters. ShippingCity: type: string description: Details of the shipping address for this account. City maximum size is 40 characters ShippingState: type: string description: Details of the shipping address for this account. State maximum size is 80 characters. ShippingPostalCode: type: string description: Details of the shipping address for this account. Postal code maximum size is 20 characters. ShippingCountry: type: string description: Details of the shipping address for this account. Country maximum size is 80 characters. ShippingLatitude: type: number description: Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingLongitude: type: number description: Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the shipping address. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingAddress: type: object description: The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields. Phone: type: string description: Phone number for this account. Maximum size is 40 characters. Fax: type: string description: Fax number for the account. AccountNumber: type: string description: Account number assigned to this account (not the unique, system-generated ID assigned during creation). Maximum size is 40 characters. Website: type: string description: The website of this account. Maximum of 255 characters. PhotoUrl: type: string description: Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. Blank if Social Accounts and Contacts isn't enabled for the org or if Social Accounts and Contacts is disabled for the requesting user. Sic: type: string description: Standard Industrial Classification code of the company’s main business categorization, for example, 57340 for Electronics. Maximum of 20 characters. This field is available on business accounts, not person accounts. Industry: type: string description: An industry associated with this account. Maximum size is 40 characters. AnnualRevenue: type: number description: Estimated annual revenue of the account. NumberOfEmployees: type: integer description: Label is Employees. Number of employees working at the company represented by this account. Maximum size is eight digits. Ownership: type: string description: Ownership type for the account, for example Private, Public, or Subsidiary. TickerSymbol: type: string description: The stock market symbol for this account. Maximum of 20 characters. This field is available on business accounts, not person accounts. Description: type: string description: Text description of the account. Limited to 32,000 KB. Rating: type: string description: The account’s prospect rating, for example Hot, Warm, or Cold. Site: type: string description: Name of the account’s location, for example Headquarters or London. Label is Account Site. Maximum of 80 characters. OwnerId: type: string description: 'The ID of the user who currently owns this account. Default value is the user logged in to the API to perform the create. If you have set up account teams in your org, updating this field has different consequences depending on your version of the API: For API version 12.0 and later, sharing records are kept, as they are for all objects. For API version before 12.0, sharing records are deleted. For API version 16.0 and later, users must have the “Transfer Record” permission in order to update (transfer) account ownership using this field.' CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is one of the following, whichever is the most recent: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time IsPartner: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's partner portal (true) or not (false). This field is available if partner relationship management (partner portal) is enabled ORdigitial experiences is enabled and you have partner portal licenses. If you change this field's value from true to false, you can disable up to 15 partner portal users associated with the account and permanently delete all of the account's partner portal roles and groups. You can't restore deleted partner portal roles and groups. Disabling a partner portal user in the Salesforce user interface or the API does not change this field's value from true to false. Even if this field's value is false, you can enable a contact on an account as a partner portal user via the API. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. IsCustomerPortal: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's Customer Portal (true) or not (false). This field is available if Customer Portal is enabled OR digital experiences is enabled and you have Customer Portal licenses. If you change this field's value from true to false, you can disable up to 100 Customer Portal users associated with the account and permanently delete all of the account's Customer Portal roles and groups. You can't restore deleted Customer Portal roles and groups. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. ChannelProgramName: type: string description: Read only. Name of the channel program the account has enrolled.If this account has enrolled more than one channel program, the oldest channel program name will be displayed. . ChannelProgramLevelName: type: string description: Read only. Name of the channel program level the account has enrolled.If this account has enrolled more than one channel program level, the oldest channel program name will be displayed. Jigsaw: type: string description: References the ID of a company in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key. This field is available on business accounts, not person accounts.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify the value in the Jigsaw field. JigsawCompanyId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values are: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus display with different labels on the account record detail page. Matched displays as In Sync Acknowledged displays as Reviewed Pending displays as Not Compared' AccountSource: type: string description: The source of the account record. For example, Advertisement, Data.com, or Trade Show. The source is selected from a picklist of available values, which are set by an administrator. Each picklist value can have up to 40 characters. DunsNumber: type: string description: The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. Tradestyle: type: string description: A name, different from its legal name, that an org may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum length is 255 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsCode: type: string description: The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. Maximum size is 8 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsDesc: type: string description: A brief description of an org’s line of business, based on its NAICS code. Maximum size is 120 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. YearStarted: type: string description: The date when an org was legally established. Maximum length is 4 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. SicDesc: type: string description: A brief description of an org’s line of business, based on its SIC code. Maximum length is 80 characters. This field is available on business accounts, not person accounts. DandbCompanyId: type: string CustomerPriority__c: type: string SLA__c: type: string Active__c: type: string NumberofLocations__c: type: number UpsellOpportunity__c: type: string SLASerialNumber__c: type: string SLAExpirationDate__c: type: string format: date Potential_Value__c: type: number Match_Billing_Address__c: type: boolean Number_of_Contacts__c: type: number Region__c: type: string attributes: type: object properties: type: type: string url: type: string AccountNumber: title: AccountNumber required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Account number assigned to this account (not the unique, system-generated ID assigned during creation). Maximum size is 40 characters. ShippingCountry: title: ShippingCountry required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details of the shipping address for this account. Country maximum size is 80 characters. DeepCloneable: title: DeepCloneable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean NaicsDesc: title: NaicsDesc required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: A brief description of an org’s line of business, based on its NAICS code. Maximum size is 120 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. LastName: title: LastName required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Required. Last name of the contact up to 80 characters. MasterRecordId: title: MasterRecordId required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. Properties12: title: Properties12 required: - Id - IsDeleted - MasterRecordId - AccountId - LastName - FirstName - Salutation - Name - OtherStreet - OtherCity - OtherState - OtherPostalCode - OtherCountry - OtherLatitude - OtherLongitude - OtherGeocodeAccuracy - OtherAddress - MailingStreet - MailingCity - MailingState - MailingPostalCode - MailingCountry - MailingLatitude - MailingLongitude - MailingGeocodeAccuracy - MailingAddress - Phone - Fax - MobilePhone - HomePhone - OtherPhone - AssistantPhone - ReportsToId - Email - Title - Department - AssistantName - LeadSource - Birthdate - Description - OwnerId - CreatedDate - CreatedById - LastModifiedDate - LastModifiedById - SystemModstamp - LastActivityDate - LastCURequestDate - LastCUUpdateDate - LastViewedDate - LastReferencedDate - EmailBouncedReason - EmailBouncedDate - IsEmailBounced - PhotoUrl - Jigsaw - JigsawContactId - CleanStatus - IndividualId - attributes type: object properties: Id: $ref: '#/components/schemas/Id' IsDeleted: $ref: '#/components/schemas/IsDeleted' MasterRecordId: $ref: '#/components/schemas/MasterRecordId' AccountId: $ref: '#/components/schemas/AccountId' LastName: $ref: '#/components/schemas/LastName' FirstName: $ref: '#/components/schemas/FirstName' Salutation: $ref: '#/components/schemas/Salutation' Name: $ref: '#/components/schemas/Name14' OtherStreet: $ref: '#/components/schemas/OtherStreet' OtherCity: $ref: '#/components/schemas/OtherCity' OtherState: $ref: '#/components/schemas/OtherState' OtherPostalCode: $ref: '#/components/schemas/OtherPostalCode' OtherCountry: $ref: '#/components/schemas/OtherCountry' OtherLatitude: $ref: '#/components/schemas/OtherLatitude' OtherLongitude: $ref: '#/components/schemas/OtherLongitude' OtherGeocodeAccuracy: $ref: '#/components/schemas/OtherGeocodeAccuracy' OtherAddress: $ref: '#/components/schemas/OtherAddress' MailingStreet: $ref: '#/components/schemas/MailingStreet' MailingCity: $ref: '#/components/schemas/MailingCity' MailingState: $ref: '#/components/schemas/MailingState' MailingPostalCode: $ref: '#/components/schemas/MailingPostalCode' MailingCountry: $ref: '#/components/schemas/MailingCountry' MailingLatitude: $ref: '#/components/schemas/MailingLatitude' MailingLongitude: $ref: '#/components/schemas/MailingLongitude' MailingGeocodeAccuracy: $ref: '#/components/schemas/MailingGeocodeAccuracy' MailingAddress: $ref: '#/components/schemas/MailingAddress' Phone: $ref: '#/components/schemas/Phone' Fax: $ref: '#/components/schemas/Fax' MobilePhone: $ref: '#/components/schemas/MobilePhone' HomePhone: $ref: '#/components/schemas/HomePhone' OtherPhone: $ref: '#/components/schemas/OtherPhone' AssistantPhone: $ref: '#/components/schemas/AssistantPhone' ReportsToId: $ref: '#/components/schemas/ReportsToId' Email: $ref: '#/components/schemas/Email' Title: $ref: '#/components/schemas/Title' Department: $ref: '#/components/schemas/Department' AssistantName: $ref: '#/components/schemas/AssistantName' LeadSource: $ref: '#/components/schemas/LeadSource' Birthdate: $ref: '#/components/schemas/Birthdate' Description: $ref: '#/components/schemas/Description3' OwnerId: $ref: '#/components/schemas/OwnerId' CreatedDate: $ref: '#/components/schemas/CreatedDate' CreatedById: $ref: '#/components/schemas/CreatedById' LastModifiedDate: $ref: '#/components/schemas/LastModifiedDate' LastModifiedById: $ref: '#/components/schemas/LastModifiedById' SystemModstamp: $ref: '#/components/schemas/SystemModstamp' LastActivityDate: $ref: '#/components/schemas/LastActivityDate' LastCURequestDate: $ref: '#/components/schemas/LastCURequestDate' LastCUUpdateDate: $ref: '#/components/schemas/LastCUUpdateDate' LastViewedDate: $ref: '#/components/schemas/LastViewedDate' LastReferencedDate: $ref: '#/components/schemas/LastReferencedDate' EmailBouncedReason: $ref: '#/components/schemas/EmailBouncedReason' EmailBouncedDate: $ref: '#/components/schemas/EmailBouncedDate' IsEmailBounced: $ref: '#/components/schemas/IsEmailBounced' PhotoUrl: $ref: '#/components/schemas/PhotoUrl' Jigsaw: $ref: '#/components/schemas/Jigsaw' JigsawContactId: $ref: '#/components/schemas/JigsawContactId' CleanStatus: $ref: '#/components/schemas/CleanStatus' IndividualId: $ref: '#/components/schemas/IndividualId' attributes: $ref: '#/components/schemas/Attributes15' examples: - Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this record was deleted as the result of a merge, this field contains the ID of the record that remains. If this record was deleted for any other reason, or has not been deleted, the value is null. AccountId: type: string description: ID of the account that’s the parent of this contact. We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. LastName: type: string description: Required. Last name of the contact up to 80 characters. FirstName: type: string description: The contact’s first name up to 40 characters. Salutation: type: string description: Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs. Name: type: string description: Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces. OtherStreet: type: string description: Street for alternate address. OtherCity: type: string description: Alternate address details. OtherState: type: string description: Alternate address details. OtherPostalCode: type: string description: Alternate address details. OtherCountry: type: string description: Alternate address details. OtherLatitude: type: number description: Used with OtherLongitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . OtherLongitude: type: number description: Used with OtherLatitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . OtherGeocodeAccuracy: type: string description: Accuracy level of the geocode for the other address. For details on geolocation compound fields, see . OtherAddress: type: object description: The compound form of the other address. Read-only. For details on compound address fields, see Address Compound Fields. MailingStreet: type: string description: Street address for mailing address. MailingCity: type: string description: Mailing address details. MailingState: type: string description: Mailing address details. MailingPostalCode: type: string description: Mailing address details. MailingCountry: type: string description: Mailing address details. MailingLatitude: type: number description: Used with MailingLongitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . MailingLongitude: type: number description: Used with MailingLatitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . MailingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see . MailingAddress: type: object description: The compound form of the mailing address. Read-only. For details on compound address fields, see Address Compound Fields. Phone: type: string description: Telephone number for the contact. Label is Business Phone. Fax: type: string description: The contact’s fax number. Label is Business Fax. MobilePhone: type: string description: Contact’s mobile phone number. HomePhone: type: string description: The contact’s home telephone number. OtherPhone: type: string description: Telephone for alternate address. AssistantPhone: type: string description: The assistant’s telephone number. ReportsToId: type: string description: This field doesn’t appear if IsPersonAccount is true. Email: type: string description: The contact’s email address. Title: type: string description: Title of the contact, such as CEO or Vice President. Department: type: string description: The contact’s department. AssistantName: type: string description: The assistant’s name. LeadSource: type: string description: The lead’s source. Birthdate: type: string description: The contact’s birthdate. Filter criteria for report filters, list view filters, and SOQL queries ignore the year portion of the Birthdate field. For example, this SOQL query returns contacts with birthdays later in the year than today:SELECT Name, Birthdate FROM Contact WHERE Birthdate > TODAY format: date Description: type: string description: A description of the contact. Label is Contact Description up to 32 KB. OwnerId: type: string description: The ID of the owner of the account associated with this contact. CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is the most recent of either: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastCURequestDate: type: string format: date-time LastCUUpdateDate: type: string format: date-time LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time EmailBouncedReason: type: string description: If bounce management is activated and an email sent to the contact bounces, the reason for the bounce. EmailBouncedDate: type: string description: If bounce management is activated and an email sent to the contact bounces, the date and time of the bounce. format: date-time IsEmailBounced: type: boolean description: If bounce management is activated and an email is sent to a contact, indicates whether the email bounced (true) or not (false). PhotoUrl: type: string description: 'Path to be combined with the URL of a Salesforce instance (Example: https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the contact. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the contact. Empty if Social Accounts and Contacts isn''t enabled or if Social Accounts and Contacts is disabled for the requesting user.' Jigsaw: type: string description: References the company’s ID in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify this value. JigsawContactId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values include: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus appear with different labels on the contact record. Matched appears as In Sync Acknowledged appears as Reviewed Pending appears as Not Compared' IndividualId: type: string description: ID of the data privacy record associated with this contact. This field is available if Data Protection and Privacy is enabled. attributes: type: object properties: type: type: string url: type: string Properties9: title: Properties9 required: - message - fields - statusCode - extendedErrorDetails type: object properties: message: $ref: '#/components/schemas/Message' fields: $ref: '#/components/schemas/Fields' statusCode: $ref: '#/components/schemas/StatusCode' extendedErrorDetails: $ref: '#/components/schemas/ExtendedErrorDetails1' examples: - message: type: string fields: type: array items: type: string statusCode: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string Undeletable: title: Undeletable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Assignment: title: Assignment required: - assignedParameter - expression type: object properties: assignedParameter: type: string example: example_value expression: type: string example: example_value examples: - assignedParameter: condition_output__1 expression: 'true' LastReferencedDate: title: LastReferencedDate required: - type - description - format type: object properties: type: type: string example: example_value description: type: string example: A sample description. format: type: string example: example_value examples: - type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time Variable: title: Variable required: - collection - dataType - description - input - name - output - type - value type: object properties: collection: type: boolean example: true dataType: type: string example: example_value description: type: string example: A sample description. input: type: boolean example: true name: type: string example: Example Title output: type: boolean example: true type: type: string example: example_value value: type: string example: example_value examples: - collection: false dataType: Boolean description: condition_output__1 input: false name: condition_output__1 output: true type: Variable value: 'False' 404-BecauseVersion59.0NotPresentInTargetOrg1: title: 404-BecauseVersion59.0NotPresentInTargetOrg1 required: - errorCode - message type: object properties: errorCode: type: string example: example_value message: type: string example: example_value examples: - errorCode: NOT_FOUND message: The requested resource does not exist Triggerable: title: Triggerable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean KeyPrefix: title: KeyPrefix required: - type type: object properties: type: type: string example: example_value examples: - type: string m200: title: m200 required: - description - content type: object properties: description: type: string example: A sample description. content: $ref: '#/components/schemas/Content' examples: - description: Status Code 200 content: application/json: schema: $ref: '#/components/schemas/SObjectRootInfo' AccountId: title: AccountId required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: ID of the account that’s the parent of this contact. We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. Site: title: Site required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Name of the account’s location, for example Headquarters or London. Label is Account Site. Maximum of 80 characters. MruEnabled: title: MruEnabled required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Components: title: Components required: - schemas - securitySchemes type: object properties: schemas: $ref: '#/components/schemas/Schemas' securitySchemes: $ref: '#/components/schemas/SecuritySchemes' examples: - schemas: SObjectRootInfo: type: object properties: objectDescribe: type: object properties: name: type: string label: type: string labelPlural: type: string keyPrefix: type: string custom: type: boolean customSetting: type: boolean activateable: type: boolean createable: type: boolean updateable: type: boolean deletable: type: boolean undeletable: type: boolean mergeable: type: boolean replicateable: type: boolean triggerable: type: boolean queryable: type: boolean retrieveable: type: boolean searchable: type: boolean layoutable: type: boolean feedEnabled: type: boolean mruEnabled: type: boolean hasSubtypes: type: boolean isSubtype: type: boolean dataTranslationEnabled: type: boolean isInterface: type: boolean deepCloneable: type: boolean associateEntityType: type: string associateParentEntity: type: string deprecatedAndHidden: type: boolean urls: type: object additionalProperties: type: string recentItems: type: array items: type: object properties: id: type: string RestApiError: type: object properties: errorCode: type: string message: type: string AccountSObject: type: object properties: Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null. Name: type: string description: 'Required. Label is Account Name. Name of the account. Maximum size is 255 characters. If the account has a record type of Person Account: This value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. You can''t modify this value.' Type: type: string description: Type of account, for example, Customer, Competitor, or Partner. ParentId: type: string description: ID of the parent object, if any. BillingStreet: type: string description: Street address for the billing address of this account. BillingCity: type: string description: Details for the billing address of this account. Maximum size is 40 characters. BillingState: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingPostalCode: type: string description: Details for the billing address of this account. Maximum size is 20 characters. BillingCountry: type: string description: Details for the billing address of this account. Maximum size is 80 characters. BillingLatitude: type: number description: Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingLongitude: type: number description: Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the billing address. See Compound Field Considerations and Limitations for details on geolocation compound fields. BillingAddress: type: object description: The compound form of the billing address. Read-only. See Address Compound Fields for details on compound address fields. ShippingStreet: type: string description: The street address of the shipping address for this account. Maximum of 255 characters. ShippingCity: type: string description: Details of the shipping address for this account. City maximum size is 40 characters ShippingState: type: string description: Details of the shipping address for this account. State maximum size is 80 characters. ShippingPostalCode: type: string description: Details of the shipping address for this account. Postal code maximum size is 20 characters. ShippingCountry: type: string description: Details of the shipping address for this account. Country maximum size is 80 characters. ShippingLatitude: type: number description: Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingLongitude: type: number description: Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the shipping address. See Compound Field Considerations and Limitations for details on geolocation compound fields. ShippingAddress: type: object description: The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields. Phone: type: string description: Phone number for this account. Maximum size is 40 characters. Fax: type: string description: Fax number for the account. AccountNumber: type: string description: Account number assigned to this account (not the unique, system-generated ID assigned during creation). Maximum size is 40 characters. Website: type: string description: The website of this account. Maximum of 255 characters. PhotoUrl: type: string description: Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. Blank if Social Accounts and Contacts isn't enabled for the org or if Social Accounts and Contacts is disabled for the requesting user. Sic: type: string description: Standard Industrial Classification code of the company’s main business categorization, for example, 57340 for Electronics. Maximum of 20 characters. This field is available on business accounts, not person accounts. Industry: type: string description: An industry associated with this account. Maximum size is 40 characters. AnnualRevenue: type: number description: Estimated annual revenue of the account. NumberOfEmployees: type: integer description: Label is Employees. Number of employees working at the company represented by this account. Maximum size is eight digits. Ownership: type: string description: Ownership type for the account, for example Private, Public, or Subsidiary. TickerSymbol: type: string description: The stock market symbol for this account. Maximum of 20 characters. This field is available on business accounts, not person accounts. Description: type: string description: Text description of the account. Limited to 32,000 KB. Rating: type: string description: The account’s prospect rating, for example Hot, Warm, or Cold. Site: type: string description: Name of the account’s location, for example Headquarters or London. Label is Account Site. Maximum of 80 characters. OwnerId: type: string description: 'The ID of the user who currently owns this account. Default value is the user logged in to the API to perform the create. If you have set up account teams in your org, updating this field has different consequences depending on your version of the API: For API version 12.0 and later, sharing records are kept, as they are for all objects. For API version before 12.0, sharing records are deleted. For API version 16.0 and later, users must have the “Transfer Record” permission in order to update (transfer) account ownership using this field.' CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is one of the following, whichever is the most recent: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time IsPartner: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's partner portal (true) or not (false). This field is available if partner relationship management (partner portal) is enabled ORdigitial experiences is enabled and you have partner portal licenses. If you change this field's value from true to false, you can disable up to 15 partner portal users associated with the account and permanently delete all of the account's partner portal roles and groups. You can't restore deleted partner portal roles and groups. Disabling a partner portal user in the Salesforce user interface or the API does not change this field's value from true to false. Even if this field's value is false, you can enable a contact on an account as a partner portal user via the API. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. IsCustomerPortal: type: boolean description: Indicates whether the account has at least one contact enabled to use the org's Customer Portal (true) or not (false). This field is available if Customer Portal is enabled OR digital experiences is enabled and you have Customer Portal licenses. If you change this field's value from true to false, you can disable up to 100 Customer Portal users associated with the account and permanently delete all of the account's Customer Portal roles and groups. You can't restore deleted Customer Portal roles and groups. This field can be updated in API version 16.0 and later.We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. ChannelProgramName: type: string description: Read only. Name of the channel program the account has enrolled.If this account has enrolled more than one channel program, the oldest channel program name will be displayed. . ChannelProgramLevelName: type: string description: Read only. Name of the channel program level the account has enrolled.If this account has enrolled more than one channel program level, the oldest channel program name will be displayed. Jigsaw: type: string description: References the ID of a company in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key. This field is available on business accounts, not person accounts.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify the value in the Jigsaw field. JigsawCompanyId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values are: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus display with different labels on the account record detail page. Matched displays as In Sync Acknowledged displays as Reviewed Pending displays as Not Compared' AccountSource: type: string description: The source of the account record. For example, Advertisement, Data.com, or Trade Show. The source is selected from a picklist of available values, which are set by an administrator. Each picklist value can have up to 40 characters. DunsNumber: type: string description: The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is 9 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. Tradestyle: type: string description: A name, different from its legal name, that an org may use for conducting business. Similar to “Doing business as” or “DBA”. Maximum length is 255 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsCode: type: string description: The six-digit North American Industry Classification System (NAICS) code is the standard used by business and government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. Maximum size is 8 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. NaicsDesc: type: string description: A brief description of an org’s line of business, based on its NAICS code. Maximum size is 120 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. YearStarted: type: string description: The date when an org was legally established. Maximum length is 4 characters. This field is available on business accounts, not person accounts.This field is only available to organizations that use Data.com Prospector or Data.com Clean. SicDesc: type: string description: A brief description of an org’s line of business, based on its SIC code. Maximum length is 80 characters. This field is available on business accounts, not person accounts. DandbCompanyId: type: string CustomerPriority__c: type: string SLA__c: type: string Active__c: type: string NumberofLocations__c: type: number UpsellOpportunity__c: type: string SLASerialNumber__c: type: string SLAExpirationDate__c: type: string format: date Potential_Value__c: type: number Match_Billing_Address__c: type: boolean Number_of_Contacts__c: type: number Region__c: type: string attributes: type: object properties: type: type: string url: type: string description: Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners). ErrorInfo: type: object properties: message: type: string errorCode: type: string fields: type: array items: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string SaveResult: type: object properties: success: type: boolean id: type: string errors: type: array items: type: object properties: message: type: string fields: type: array items: type: string statusCode: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string warnings: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string infos: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string ContactSObject: type: object properties: Id: type: string IsDeleted: type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. MasterRecordId: type: string description: If this record was deleted as the result of a merge, this field contains the ID of the record that remains. If this record was deleted for any other reason, or has not been deleted, the value is null. AccountId: type: string description: ID of the account that’s the parent of this contact. We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours. LastName: type: string description: Required. Last name of the contact up to 80 characters. FirstName: type: string description: The contact’s first name up to 40 characters. Salutation: type: string description: Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs. Name: type: string description: Concatenation of FirstName, MiddleName, LastName, and Suffix up to 203 characters, including whitespaces. OtherStreet: type: string description: Street for alternate address. OtherCity: type: string description: Alternate address details. OtherState: type: string description: Alternate address details. OtherPostalCode: type: string description: Alternate address details. OtherCountry: type: string description: Alternate address details. OtherLatitude: type: number description: Used with OtherLongitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . OtherLongitude: type: number description: Used with OtherLatitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . OtherGeocodeAccuracy: type: string description: Accuracy level of the geocode for the other address. For details on geolocation compound fields, see . OtherAddress: type: object description: The compound form of the other address. Read-only. For details on compound address fields, see Address Compound Fields. MailingStreet: type: string description: Street address for mailing address. MailingCity: type: string description: Mailing address details. MailingState: type: string description: Mailing address details. MailingPostalCode: type: string description: Mailing address details. MailingCountry: type: string description: Mailing address details. MailingLatitude: type: number description: Used with MailingLongitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . MailingLongitude: type: number description: Used with MailingLatitude to specify the precise geolocation of a mailing address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see . MailingGeocodeAccuracy: type: string description: Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see . MailingAddress: type: object description: The compound form of the mailing address. Read-only. For details on compound address fields, see Address Compound Fields. Phone: type: string description: Telephone number for the contact. Label is Business Phone. Fax: type: string description: The contact’s fax number. Label is Business Fax. MobilePhone: type: string description: Contact’s mobile phone number. HomePhone: type: string description: The contact’s home telephone number. OtherPhone: type: string description: Telephone for alternate address. AssistantPhone: type: string description: The assistant’s telephone number. ReportsToId: type: string description: This field doesn’t appear if IsPersonAccount is true. Email: type: string description: The contact’s email address. Title: type: string description: Title of the contact, such as CEO or Vice President. Department: type: string description: The contact’s department. AssistantName: type: string description: The assistant’s name. LeadSource: type: string description: The lead’s source. Birthdate: type: string description: The contact’s birthdate. Filter criteria for report filters, list view filters, and SOQL queries ignore the year portion of the Birthdate field. For example, this SOQL query returns contacts with birthdays later in the year than today:SELECT Name, Birthdate FROM Contact WHERE Birthdate > TODAY format: date Description: type: string description: A description of the contact. Label is Contact Description up to 32 KB. OwnerId: type: string description: The ID of the owner of the account associated with this contact. CreatedDate: type: string format: date-time CreatedById: type: string LastModifiedDate: type: string format: date-time LastModifiedById: type: string SystemModstamp: type: string format: date-time LastActivityDate: type: string description: 'Value is the most recent of either: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date LastCURequestDate: type: string format: date-time LastCUUpdateDate: type: string format: date-time LastViewedDate: type: string description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. format: date-time LastReferencedDate: type: string description: The timestamp when the current user last accessed this record, a record related to this record, or a list view. format: date-time EmailBouncedReason: type: string description: If bounce management is activated and an email sent to the contact bounces, the reason for the bounce. EmailBouncedDate: type: string description: If bounce management is activated and an email sent to the contact bounces, the date and time of the bounce. format: date-time IsEmailBounced: type: boolean description: If bounce management is activated and an email is sent to a contact, indicates whether the email bounced (true) or not (false). PhotoUrl: type: string description: 'Path to be combined with the URL of a Salesforce instance (Example: https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the contact. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the contact. Empty if Social Accounts and Contacts isn''t enabled or if Social Accounts and Contacts is disabled for the requesting user.' Jigsaw: type: string description: References the company’s ID in Data.com. If an account has a value in this field, it means that the account was imported from Data.com. If the field value is null, the account was not imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key.The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify this value. JigsawContactId: type: string CleanStatus: type: string description: 'Indicates the record’s clean status as compared with Data.com. Values include: Matched, Different, Acknowledged, NotFound, Inactive, Pending, SelectMatch, or Skipped. Several values for CleanStatus appear with different labels on the contact record. Matched appears as In Sync Acknowledged appears as Reviewed Pending appears as Not Compared' IndividualId: type: string description: ID of the data privacy record associated with this contact. This field is available if Data Protection and Privacy is enabled. attributes: type: object properties: type: type: string url: type: string description: Represents a contact, which is a person associated with an account. securitySchemes: openIDConnectDiscovery: type: openIdConnect openIdConnectUrl: https://login.salesforce.com/.well-known/openid-configuration bearerAuth: type: http description: Use Session Id or Access Token as valid bearer token to authenticate with Salesforce. Access Token could be retrieved via any supported OAuth2 flows listed or not listed here (e.g. JWT Bearer Token Flow).To obtain a session ID, you can use the SOAP API login() call or through the Salesforce CLI. scheme: bearer oAuth2: type: oauth2 description: 'For more information on all supported OAuth Flows, please see ''https://help.salesforce.com/articleView?id=remoteaccess_oauth_flows.htm&type=5''. For more information on all available scope options, please see ''https://help.salesforce.com/articleView?id=remoteaccess_oauth_tokens_scopes.htm&type=5#oauth_scopes''. ' flows: implicit: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. password: tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. authorizationCode: authorizationUrl: https://login.salesforce.com/services/oauth2/authorize tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. HasSubtypes: title: HasSubtypes required: - type type: object properties: type: type: string example: example_value examples: - type: boolean SystemModstamp: title: SystemModstamp required: - type - format type: object properties: type: type: string example: example_value format: type: string example: example_value examples: - type: string format: date-time ShippingLongitude: title: ShippingLongitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. MatchBillingAddressC: title: MatchBillingAddressC required: - type type: object properties: type: type: string example: example_value examples: - type: boolean IsDeleted: title: IsDeleted required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: boolean description: Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted. ActiveC: title: ActiveC required: - type type: object properties: type: type: string example: example_value examples: - type: string DataTranslationEnabled: title: DataTranslationEnabled required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Implicit: title: Implicit required: - authorizationUrl - scopes type: object properties: authorizationUrl: type: string example: https://www.example.com scopes: $ref: '#/components/schemas/Scopes' examples: - authorizationUrl: https://login.salesforce.com/services/oauth2/authorize scopes: visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. LastCUUpdateDate: title: LastCUUpdateDate required: - type - format type: object properties: type: type: string example: example_value format: type: string example: example_value examples: - type: string format: date-time BillingCountry: title: BillingCountry required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details for the billing address of this account. Maximum size is 80 characters. NumberOfEmployees: title: NumberOfEmployees required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: integer description: Label is Employees. Number of employees working at the company represented by this account. Maximum size is eight digits. JigsawCompanyId: title: JigsawCompanyId required: - type type: object properties: type: type: string example: example_value examples: - type: string Schema10: title: Schema10 required: - type type: object properties: type: type: string example: example_value examples: - type: string ApplicationJson: title: ApplicationJson required: - schema type: object properties: schema: $ref: '#/components/schemas/Schema' examples: - schema: $ref: '#/components/schemas/SObjectRootInfo' BillingLatitude: title: BillingLatitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. AccountSource: title: AccountSource required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The source of the account record. For example, Advertisement, Data.com, or Trade Show. The source is selected from a picklist of available values, which are set by an administrator. Each picklist value can have up to 40 characters. Description3: title: Description3 required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Text description of the account. Limited to 32,000 KB. RegionC: title: RegionC required: - type type: object properties: type: type: string example: example_value examples: - type: string OtherLatitude: title: OtherLatitude required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: number description: Used with OtherLongitude to specify the precise geolocation of an alternate address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see . ExtendedErrorDetails: title: ExtendedErrorDetails required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items19' examples: - type: array items: type: object properties: extendedErrorCode: type: string Properties6: title: Properties6 required: - message - errorCode - fields - extendedErrorDetails type: object properties: message: $ref: '#/components/schemas/Message' errorCode: $ref: '#/components/schemas/ErrorCode' fields: $ref: '#/components/schemas/Fields' extendedErrorDetails: $ref: '#/components/schemas/ExtendedErrorDetails' examples: - message: type: string errorCode: type: string fields: type: array items: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string ShippingGeocodeAccuracy: title: ShippingGeocodeAccuracy required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Accuracy level of the geocode for the shipping address. See Compound Field Considerations and Limitations for details on geolocation compound fields. LastActivityDate: title: LastActivityDate required: - type - description - format type: object properties: type: type: string example: example_value description: type: string example: A sample description. format: type: string example: example_value examples: - type: string description: 'Value is one of the following, whichever is the most recent: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.' format: date Website: title: Website required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The website of this account. Maximum of 255 characters. RecentItems: title: RecentItems required: - type - items type: object properties: type: type: string example: example_value items: $ref: '#/components/schemas/Items17' examples: - type: array items: type: object properties: id: type: string Email: title: Email required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The contact’s email address. ShippingPostalCode: title: ShippingPostalCode required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: Details of the shipping address for this account. Postal code maximum size is 20 characters. CustomerPriorityC: title: CustomerPriorityC required: - type type: object properties: type: type: string example: example_value examples: - type: string DandbCompanyId: title: DandbCompanyId required: - type type: object properties: type: type: string example: example_value examples: - type: string CreatedById: title: CreatedById required: - type type: object properties: type: type: string example: example_value examples: - type: string RequestBody: title: RequestBody required: - content type: object properties: content: $ref: '#/components/schemas/Content' examples: - content: application/json: schema: $ref: '#/components/schemas/ContactSObject' Urls5: title: Urls5 required: - type - additionalProperties type: object properties: type: type: string example: example_value additionalProperties: $ref: '#/components/schemas/AdditionalProperties' examples: - type: object additionalProperties: type: string Get: title: Get required: - responses type: object properties: responses: type: object additionalProperties: $ref: '#/components/schemas/m200' example: example_value Queryable: title: Queryable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean MailingAddress: title: MailingAddress required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: object description: The compound form of the mailing address. Read-only. For details on compound address fields, see Address Compound Fields. FeedEnabled: title: FeedEnabled required: - type type: object properties: type: type: string example: example_value examples: - type: boolean AssociateParentEntity: title: AssociateParentEntity required: - type type: object properties: type: type: string example: example_value examples: - type: string NumberOfContactsC: title: NumberOfContactsC required: - type type: object properties: type: type: string example: example_value examples: - type: number HomePhone: title: HomePhone required: - type - description type: object properties: type: type: string example: example_value description: type: string example: A sample description. examples: - type: string description: The contact’s home telephone number. Properties8: title: Properties8 required: - success - id - errors - warnings - infos type: object properties: success: $ref: '#/components/schemas/Success' id: $ref: '#/components/schemas/Id' errors: $ref: '#/components/schemas/Errors12' warnings: $ref: '#/components/schemas/Warnings' infos: $ref: '#/components/schemas/Infos' examples: - success: type: boolean id: type: string errors: type: array items: type: object properties: message: type: string fields: type: array items: type: string statusCode: type: string extendedErrorDetails: type: array items: type: object properties: extendedErrorCode: type: string warnings: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string infos: type: array items: type: object properties: message: type: string statusCode: type: string extendedDetails: type: array items: type: object properties: extendedErrorCode: type: string Retrieveable: title: Retrieveable required: - type type: object properties: type: type: string example: example_value examples: - type: boolean Scopes: title: Scopes required: - visualforce - address - custom_permissions - openid - profile - refresh_token - wave_api - web - phone - offline_access - chatter_api - id - api - eclair_api - email - pardot_api - full type: object properties: visualforce: type: string example: example_value address: type: string example: example_value custom_permissions: type: string example: example_value openid: type: string example: '500123' profile: type: string example: example_value refresh_token: type: string example: CAUQAA wave_api: type: string example: example_value web: type: string example: example_value phone: type: string example: example_value offline_access: type: string example: example_value chatter_api: type: string example: example_value id: type: string example: abc123 api: type: string example: example_value eclair_api: type: string example: example_value email: type: string example: user@example.com pardot_api: type: string example: example_value full: type: string example: example_value examples: - visualforce: Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs. address: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. custom_permissions: Allows access to the custom permissions in an org associated with the connected app. This scope also shows whether the current user has each permission enabled. openid: Allows access to the current, logged in user’s unique identifier for OpenID Connect apps. In the OAuth 2.0 user-agent flow and the OAuth 2.0 web server flow, use the openid scope. In addition to the access token, this scope enables you to receive a signed ID token that conforms to the OpenID Connect specifications. profile: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. refresh_token: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. wave_api: Access and manage your Wave data. web: Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. phone: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. offline_access: Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. chatter_api: Allows access to Connect REST API resources on behalf of the user. id: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. eclair_api: Access and manage your Eclair data. email: Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id; they are all synonymous. pardot_api: Allows access to Pardot API services on behalf of the user. Manage the full extent of accessible services in Pardot. full: Allows access to all data accessible by the logged-in user, and encompasses all other scopes. full doesn’t return a refresh token. You must explicitly request the refresh_token scope to get a refresh token. Password: title: Password required: - tokenUrl - scopes type: object properties: tokenUrl: type: string example: https://www.example.com scopes: $ref: '#/components/schemas/Scopes1' examples: - tokenUrl: https://login.salesforce.com/services/oauth2/token scopes: api: Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API. This scope also includes chatter_api, which allows access to Connect REST API resources. 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}". '