gatewaysdk 0.3.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- gatewaysdk/__init__.py +540 -0
- gatewaysdk/adapter/__init__.py +15 -0
- gatewaysdk/adapter/base.py +94 -0
- gatewaysdk/adapter/messages.py +270 -0
- gatewaysdk/adapter/triplet.py +1026 -0
- gatewaysdk/algorithm/__init__.py +39 -0
- gatewaysdk/algorithm/apo/__init__.py +5 -0
- gatewaysdk/algorithm/apo/apo.py +898 -0
- gatewaysdk/algorithm/apo/prompts/apply_edit_variant01.poml +22 -0
- gatewaysdk/algorithm/apo/prompts/apply_edit_variant02.poml +18 -0
- gatewaysdk/algorithm/apo/prompts/text_gradient_variant01.poml +18 -0
- gatewaysdk/algorithm/apo/prompts/text_gradient_variant02.poml +16 -0
- gatewaysdk/algorithm/apo/prompts/text_gradient_variant03.poml +107 -0
- gatewaysdk/algorithm/base.py +262 -0
- gatewaysdk/algorithm/decorator.py +264 -0
- gatewaysdk/algorithm/evals/__init__.py +7 -0
- gatewaysdk/algorithm/evals/evals.py +217 -0
- gatewaysdk/algorithm/fast.py +250 -0
- gatewaysdk/algorithm/gepa/__init__.py +61 -0
- gatewaysdk/algorithm/gepa/adapter.py +495 -0
- gatewaysdk/algorithm/gepa/gepa.py +570 -0
- gatewaysdk/algorithm/gepa/lib/__init__.py +18 -0
- gatewaysdk/algorithm/gepa/lib/adapters/README.md +12 -0
- gatewaysdk/algorithm/gepa/lib/adapters/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/adapters/anymaths_adapter/README.md +341 -0
- gatewaysdk/algorithm/gepa/lib/adapters/anymaths_adapter/__init__.py +1 -0
- gatewaysdk/algorithm/gepa/lib/adapters/anymaths_adapter/anymaths_adapter.py +174 -0
- gatewaysdk/algorithm/gepa/lib/adapters/anymaths_adapter/requirements.txt +1 -0
- gatewaysdk/algorithm/gepa/lib/adapters/default_adapter/README.md +0 -0
- gatewaysdk/algorithm/gepa/lib/adapters/default_adapter/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/adapters/default_adapter/default_adapter.py +209 -0
- gatewaysdk/algorithm/gepa/lib/adapters/dspy_adapter/README.md +7 -0
- gatewaysdk/algorithm/gepa/lib/adapters/dspy_adapter/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/adapters/dspy_adapter/dspy_adapter.py +307 -0
- gatewaysdk/algorithm/gepa/lib/adapters/dspy_full_program_adapter/README.md +99 -0
- gatewaysdk/algorithm/gepa/lib/adapters/dspy_full_program_adapter/dspy_program_proposal_signature.py +137 -0
- gatewaysdk/algorithm/gepa/lib/adapters/dspy_full_program_adapter/full_program_adapter.py +268 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/GEPA_RAG.md +621 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/__init__.py +56 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/evaluation_metrics.py +226 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/generic_rag_adapter.py +496 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/rag_pipeline.py +238 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/vector_store_interface.py +212 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/vector_stores/__init__.py +2 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/vector_stores/chroma_store.py +196 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/vector_stores/lancedb_store.py +422 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/vector_stores/milvus_store.py +409 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/vector_stores/qdrant_store.py +368 -0
- gatewaysdk/algorithm/gepa/lib/adapters/generic_rag_adapter/vector_stores/weaviate_store.py +418 -0
- gatewaysdk/algorithm/gepa/lib/adapters/mcp_adapter/README.md +552 -0
- gatewaysdk/algorithm/gepa/lib/adapters/mcp_adapter/__init__.py +37 -0
- gatewaysdk/algorithm/gepa/lib/adapters/mcp_adapter/mcp_adapter.py +699 -0
- gatewaysdk/algorithm/gepa/lib/adapters/mcp_adapter/mcp_client.py +364 -0
- gatewaysdk/algorithm/gepa/lib/adapters/terminal_bench_adapter/README.md +9 -0
- gatewaysdk/algorithm/gepa/lib/adapters/terminal_bench_adapter/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/adapters/terminal_bench_adapter/terminal_bench_adapter.py +217 -0
- gatewaysdk/algorithm/gepa/lib/api.py +382 -0
- gatewaysdk/algorithm/gepa/lib/core/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/core/adapter.py +180 -0
- gatewaysdk/algorithm/gepa/lib/core/data_loader.py +74 -0
- gatewaysdk/algorithm/gepa/lib/core/engine.py +379 -0
- gatewaysdk/algorithm/gepa/lib/core/result.py +233 -0
- gatewaysdk/algorithm/gepa/lib/core/state.py +636 -0
- gatewaysdk/algorithm/gepa/lib/examples/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/examples/aime.py +24 -0
- gatewaysdk/algorithm/gepa/lib/examples/anymaths-bench/eval_default.py +111 -0
- gatewaysdk/algorithm/gepa/lib/examples/anymaths-bench/prompt-templates/instruction_prompt.txt +9 -0
- gatewaysdk/algorithm/gepa/lib/examples/anymaths-bench/prompt-templates/optimal_prompt.txt +24 -0
- gatewaysdk/algorithm/gepa/lib/examples/anymaths-bench/train_anymaths.py +177 -0
- gatewaysdk/algorithm/gepa/lib/examples/dspy_full_program_evolution/arc_agi.ipynb +25705 -0
- gatewaysdk/algorithm/gepa/lib/examples/dspy_full_program_evolution/example.ipynb +348 -0
- gatewaysdk/algorithm/gepa/lib/examples/mcp_adapter/__init__.py +4 -0
- gatewaysdk/algorithm/gepa/lib/examples/mcp_adapter/mcp_optimization_example.py +456 -0
- gatewaysdk/algorithm/gepa/lib/examples/rag_adapter/RAG_GUIDE.md +613 -0
- gatewaysdk/algorithm/gepa/lib/examples/rag_adapter/__init__.py +9 -0
- gatewaysdk/algorithm/gepa/lib/examples/rag_adapter/rag_optimization.py +820 -0
- gatewaysdk/algorithm/gepa/lib/examples/rag_adapter/requirements-rag.txt +29 -0
- gatewaysdk/algorithm/gepa/lib/examples/terminal-bench/prompt-templates/instruction_prompt.txt +16 -0
- gatewaysdk/algorithm/gepa/lib/examples/terminal-bench/prompt-templates/terminus.txt +9 -0
- gatewaysdk/algorithm/gepa/lib/examples/terminal-bench/train_terminus.py +161 -0
- gatewaysdk/algorithm/gepa/lib/gepa_utils.py +117 -0
- gatewaysdk/algorithm/gepa/lib/logging/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/logging/experiment_tracker.py +187 -0
- gatewaysdk/algorithm/gepa/lib/logging/logger.py +75 -0
- gatewaysdk/algorithm/gepa/lib/logging/utils.py +103 -0
- gatewaysdk/algorithm/gepa/lib/proposer/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/proposer/base.py +31 -0
- gatewaysdk/algorithm/gepa/lib/proposer/merge.py +357 -0
- gatewaysdk/algorithm/gepa/lib/proposer/reflective_mutation/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/proposer/reflective_mutation/base.py +49 -0
- gatewaysdk/algorithm/gepa/lib/proposer/reflective_mutation/reflective_mutation.py +176 -0
- gatewaysdk/algorithm/gepa/lib/py.typed +0 -0
- gatewaysdk/algorithm/gepa/lib/strategies/__init__.py +0 -0
- gatewaysdk/algorithm/gepa/lib/strategies/batch_sampler.py +77 -0
- gatewaysdk/algorithm/gepa/lib/strategies/candidate_selector.py +50 -0
- gatewaysdk/algorithm/gepa/lib/strategies/component_selector.py +36 -0
- gatewaysdk/algorithm/gepa/lib/strategies/eval_policy.py +64 -0
- gatewaysdk/algorithm/gepa/lib/strategies/instruction_proposal.py +126 -0
- gatewaysdk/algorithm/gepa/lib/utils/__init__.py +10 -0
- gatewaysdk/algorithm/gepa/lib/utils/stop_condition.py +196 -0
- gatewaysdk/algorithm/gepa/tracing.py +105 -0
- gatewaysdk/algorithm/utils.py +177 -0
- gatewaysdk/algorithm/verl/__init__.py +5 -0
- gatewaysdk/algorithm/verl/interface.py +202 -0
- gatewaysdk/automations.py +111 -0
- gatewaysdk/benchmark_hub/README.md +88 -0
- gatewaysdk/benchmark_hub/__init__.py +119 -0
- gatewaysdk/benchmark_hub/_archive.py +189 -0
- gatewaysdk/benchmark_hub/_tar.py +6 -0
- gatewaysdk/benchmark_hub/client.py +992 -0
- gatewaysdk/benchmark_hub/dispatch_shard.py +34 -0
- gatewaysdk/benchmark_hub/eval_config.py +20 -0
- gatewaysdk/benchmark_hub/evals.py +351 -0
- gatewaysdk/benchmark_hub/harbor_adapter.py +673 -0
- gatewaysdk/benchmark_hub/path_utils.py +81 -0
- gatewaysdk/benchmark_hub/save_utils.py +101 -0
- gatewaysdk/benchmark_hub/verifiers_adapter.py +327 -0
- gatewaysdk/benchmark_hub/versioning.py +72 -0
- gatewaysdk/build.py +515 -0
- gatewaysdk/cli/__init__.py +58 -0
- gatewaysdk/cli/agent_runner.py +132 -0
- gatewaysdk/cli/http_client.py +115 -0
- gatewaysdk/cli/platform.py +4086 -0
- gatewaysdk/cli/prometheus.py +115 -0
- gatewaysdk/cli/release_gate.py +215 -0
- gatewaysdk/cli/store.py +131 -0
- gatewaysdk/cli/vllm.py +29 -0
- gatewaysdk/client.py +406 -0
- gatewaysdk/config.py +348 -0
- gatewaysdk/connectors/__init__.py +25 -0
- gatewaysdk/connectors/client.py +203 -0
- gatewaysdk/connectors/skill.py +25 -0
- gatewaysdk/connectors/template.py +106 -0
- gatewaysdk/context.py +606 -0
- gatewaysdk/emitter/__init__.py +43 -0
- gatewaysdk/emitter/annotation.py +370 -0
- gatewaysdk/emitter/exception.py +54 -0
- gatewaysdk/emitter/message.py +61 -0
- gatewaysdk/emitter/object.py +117 -0
- gatewaysdk/emitter/reward.py +320 -0
- gatewaysdk/env_var.py +156 -0
- gatewaysdk/environment/__init__.py +108 -0
- gatewaysdk/environment/_bundle.py +281 -0
- gatewaysdk/environment/_harbor.py +276 -0
- gatewaysdk/environment/_materialize.py +97 -0
- gatewaysdk/environment/_tar.py +33 -0
- gatewaysdk/environment/_world.py +346 -0
- gatewaysdk/environment/core.py +527 -0
- gatewaysdk/environment/errors.py +58 -0
- gatewaysdk/environment/runtime.py +150 -0
- gatewaysdk/environment/schema/__init__.py +35 -0
- gatewaysdk/environment/schema/__main__.py +225 -0
- gatewaysdk/environment/schema/_slack_fidelity.py +116 -0
- gatewaysdk/environment/schema/_slack_scenario.py +183 -0
- gatewaysdk/environment/schema/api.py +1628 -0
- gatewaysdk/environment/schema/batch.py +755 -0
- gatewaysdk/environment/schema/compiler.py +615 -0
- gatewaysdk/environment/schema/conform.py +428 -0
- gatewaysdk/environment/schema/connector.py +777 -0
- gatewaysdk/environment/schema/connectors/apple-business-manager/handlers.py +17 -0
- gatewaysdk/environment/schema/connectors/apple-business-manager/parity.json +28 -0
- gatewaysdk/environment/schema/connectors/apple-business-manager/provenance.json +233 -0
- gatewaysdk/environment/schema/connectors/apple-business-manager/scope.toml +112 -0
- gatewaysdk/environment/schema/connectors/apple-business-manager/world.json +1380 -0
- gatewaysdk/environment/schema/connectors/base.json +28 -0
- gatewaysdk/environment/schema/connectors/custom/handlers.py +18 -0
- gatewaysdk/environment/schema/connectors/custom/world.json +123 -0
- gatewaysdk/environment/schema/connectors/github/handlers.py +81 -0
- gatewaysdk/environment/schema/connectors/github/parity.json +37 -0
- gatewaysdk/environment/schema/connectors/github/provenance.json +134 -0
- gatewaysdk/environment/schema/connectors/github/scope.toml +158 -0
- gatewaysdk/environment/schema/connectors/github/world.json +5869 -0
- gatewaysdk/environment/schema/connectors/google-calendar/handlers.py +23 -0
- gatewaysdk/environment/schema/connectors/google-calendar/world.json +209 -0
- gatewaysdk/environment/schema/connectors/google-drive/handlers.py +18 -0
- gatewaysdk/environment/schema/connectors/google-drive/world.json +286 -0
- gatewaysdk/environment/schema/connectors/jamf/handlers.py +34 -0
- gatewaysdk/environment/schema/connectors/jamf/parity.json +49 -0
- gatewaysdk/environment/schema/connectors/jamf/provenance.json +181 -0
- gatewaysdk/environment/schema/connectors/jamf/scope.toml +128 -0
- gatewaysdk/environment/schema/connectors/jamf/world.json +2218 -0
- gatewaysdk/environment/schema/connectors/jira/handlers.py +28 -0
- gatewaysdk/environment/schema/connectors/jira/world.json +389 -0
- gatewaysdk/environment/schema/connectors/kandji/handlers.py +38 -0
- gatewaysdk/environment/schema/connectors/kandji/parity.json +29 -0
- gatewaysdk/environment/schema/connectors/kandji/provenance.json +152 -0
- gatewaysdk/environment/schema/connectors/kandji/scope.toml +120 -0
- gatewaysdk/environment/schema/connectors/kandji/world.json +765 -0
- gatewaysdk/environment/schema/connectors/linear/handlers.py +20 -0
- gatewaysdk/environment/schema/connectors/linear/world.json +363 -0
- gatewaysdk/environment/schema/connectors/microsoft-teams/fidelity.json +45 -0
- gatewaysdk/environment/schema/connectors/microsoft-teams/handlers.py +1 -0
- gatewaysdk/environment/schema/connectors/microsoft-teams/provenance.json +851 -0
- gatewaysdk/environment/schema/connectors/microsoft-teams/scope.md +231 -0
- gatewaysdk/environment/schema/connectors/microsoft-teams/teams-types.json +1710 -0
- gatewaysdk/environment/schema/connectors/microsoft-teams/world.json +858 -0
- gatewaysdk/environment/schema/connectors/netsuite/handlers.py +32 -0
- gatewaysdk/environment/schema/connectors/netsuite/parity.json +50 -0
- gatewaysdk/environment/schema/connectors/netsuite/provenance.json +137 -0
- gatewaysdk/environment/schema/connectors/netsuite/scope.toml +78 -0
- gatewaysdk/environment/schema/connectors/netsuite/world.json +16243 -0
- gatewaysdk/environment/schema/connectors/salesforce/handlers.py +806 -0
- gatewaysdk/environment/schema/connectors/salesforce/parity.json +46 -0
- gatewaysdk/environment/schema/connectors/salesforce/provenance.json +143 -0
- gatewaysdk/environment/schema/connectors/salesforce/scope.toml +174 -0
- gatewaysdk/environment/schema/connectors/salesforce/world.json +4695 -0
- gatewaysdk/environment/schema/connectors/slack/MODEL.md +236 -0
- gatewaysdk/environment/schema/connectors/slack/capabilities.json +1039 -0
- gatewaysdk/environment/schema/connectors/slack/handlers.py +762 -0
- gatewaysdk/environment/schema/connectors/slack/parity.json +65 -0
- gatewaysdk/environment/schema/connectors/slack/provenance.json +294 -0
- gatewaysdk/environment/schema/connectors/slack/scope.toml +44 -0
- gatewaysdk/environment/schema/connectors/slack/world.json +4993 -0
- gatewaysdk/environment/schema/connectors/workday/handlers.py +75 -0
- gatewaysdk/environment/schema/connectors/workday/parity.json +36 -0
- gatewaysdk/environment/schema/connectors/workday/provenance.json +179 -0
- gatewaysdk/environment/schema/connectors/workday/scope.toml +180 -0
- gatewaysdk/environment/schema/connectors/workday/world.json +806 -0
- gatewaysdk/environment/schema/data.py +593 -0
- gatewaysdk/environment/schema/extract.py +263 -0
- gatewaysdk/environment/schema/host.py +2437 -0
- gatewaysdk/environment/schema/host_surfaces.py +275 -0
- gatewaysdk/environment/schema/platform.py +1272 -0
- gatewaysdk/environment/schema/scaffold.py +250 -0
- gatewaysdk/environment/schema/skill.py +118 -0
- gatewaysdk/environment/schema/skills/agents/connector-template-author.md +202 -0
- gatewaysdk/environment/schema/skills/connector-schema-authoring/CONNECTORS.md +331 -0
- gatewaysdk/environment/schema/skills/connector-schema-authoring/CONVENTIONS.md +100 -0
- gatewaysdk/environment/schema/skills/connector-schema-authoring/SKILL.md +313 -0
- gatewaysdk/environment/schema/skills/world-data-ingestion/ROWS.md +223 -0
- gatewaysdk/environment/schema/skills/world-data-ingestion/SKILL.md +293 -0
- gatewaysdk/environment/schema/skills/worlds-getting-started/SKILL.md +390 -0
- gatewaysdk/environment/schema/slack.py +757 -0
- gatewaysdk/environment/schema/snapshot.py +479 -0
- gatewaysdk/environment/schema/store.py +904 -0
- gatewaysdk/environment/schema/tasks.py +525 -0
- gatewaysdk/environment/schema/tools_world.py +322 -0
- gatewaysdk/environment/schema/validation.py +577 -0
- gatewaysdk/environment/schema/worker.py +78 -0
- gatewaysdk/environment/schema/workers.py +500 -0
- gatewaysdk/environment/schema/world_tests.py +336 -0
- gatewaysdk/environments/__init__.py +24 -0
- gatewaysdk/environments/client.py +486 -0
- gatewaysdk/environments/types.py +318 -0
- gatewaysdk/execution/__init__.py +15 -0
- gatewaysdk/execution/base.py +64 -0
- gatewaysdk/execution/client_server.py +443 -0
- gatewaysdk/execution/events.py +69 -0
- gatewaysdk/execution/inter_process.py +16 -0
- gatewaysdk/execution/shared_memory.py +282 -0
- gatewaysdk/experiments/__init__.py +90 -0
- gatewaysdk/experiments/assignment.py +177 -0
- gatewaysdk/experiments/client.py +877 -0
- gatewaysdk/experiments/exposure.py +222 -0
- gatewaysdk/experiments/types.py +81 -0
- gatewaysdk/importers/__init__.py +49 -0
- gatewaysdk/importers/_normalize.py +91 -0
- gatewaysdk/importers/builder.py +173 -0
- gatewaysdk/importers/client.py +95 -0
- gatewaysdk/importers/langsmith.py +196 -0
- gatewaysdk/importers/recipes.py +249 -0
- gatewaysdk/instrumentation/__init__.py +300 -0
- gatewaysdk/instrumentation/agentops.py +314 -0
- gatewaysdk/instrumentation/agentops_langchain.py +45 -0
- gatewaysdk/instrumentation/base.py +119 -0
- gatewaysdk/instrumentation/litellm.py +83 -0
- gatewaysdk/instrumentation/registry.py +273 -0
- gatewaysdk/instrumentation/vllm.py +81 -0
- gatewaysdk/instrumentation/weave.py +500 -0
- gatewaysdk/integrations/__init__.py +15 -0
- gatewaysdk/integrations/gateway/__init__.py +11 -0
- gatewaysdk/integrations/gateway/client.py +171 -0
- gatewaysdk/integrations/tool_access.py +549 -0
- gatewaysdk/litagent/__init__.py +11 -0
- gatewaysdk/litagent/decorator.py +536 -0
- gatewaysdk/litagent/litagent.py +252 -0
- gatewaysdk/llm_proxy.py +1742 -0
- gatewaysdk/logging.py +370 -0
- gatewaysdk/memory.py +278 -0
- gatewaysdk/personas.py +186 -0
- gatewaysdk/platform/__init__.py +17 -0
- gatewaysdk/platform/builder.py +221 -0
- gatewaysdk/platform/compatibility.py +67 -0
- gatewaysdk/platform/manifest.py +185 -0
- gatewaysdk/platform/orchestrator.py +901 -0
- gatewaysdk/platform/registry.py +122 -0
- gatewaysdk/platform/worker.py +864 -0
- gatewaysdk/replay/__init__.py +1032 -0
- gatewaysdk/replay/pytest.py +56 -0
- gatewaysdk/reward.py +7 -0
- gatewaysdk/run.py +1781 -0
- gatewaysdk/runner/__init__.py +11 -0
- gatewaysdk/runner/agent.py +878 -0
- gatewaysdk/runner/base.py +182 -0
- gatewaysdk/runner/legacy.py +309 -0
- gatewaysdk/security.py +700 -0
- gatewaysdk/semconv.py +170 -0
- gatewaysdk/server.py +399 -0
- gatewaysdk/sessions.py +282 -0
- gatewaysdk/store/__init__.py +45 -0
- gatewaysdk/store/base.py +908 -0
- gatewaysdk/store/client_server.py +2093 -0
- gatewaysdk/store/collection/__init__.py +30 -0
- gatewaysdk/store/collection/base.py +587 -0
- gatewaysdk/store/collection/memory.py +970 -0
- gatewaysdk/store/collection/mongo.py +1412 -0
- gatewaysdk/store/collection_based.py +1823 -0
- gatewaysdk/store/gateway.py +983 -0
- gatewaysdk/store/gateway_listener.py +465 -0
- gatewaysdk/store/listener.py +58 -0
- gatewaysdk/store/memory.py +396 -0
- gatewaysdk/store/mongo.py +165 -0
- gatewaysdk/store/redis_stream.py +517 -0
- gatewaysdk/store/sqlite.py +3 -0
- gatewaysdk/store/threading.py +370 -0
- gatewaysdk/store/utils.py +142 -0
- gatewaysdk/tracer/__init__.py +14 -0
- gatewaysdk/tracer/base.py +286 -0
- gatewaysdk/tracer/dummy.py +106 -0
- gatewaysdk/tracer/otel.py +559 -0
- gatewaysdk/tracing/__init__.py +110 -0
- gatewaysdk/tracing/api.py +808 -0
- gatewaysdk/tracing/attributes.py +9 -0
- gatewaysdk/tracing/context.py +272 -0
- gatewaysdk/tracing/exporters/__init__.py +10 -0
- gatewaysdk/tracing/exporters/gateway.py +228 -0
- gatewaysdk/tracing/identity.py +288 -0
- gatewaysdk/tracing/init.py +620 -0
- gatewaysdk/tracing/instrumentors/__init__.py +15 -0
- gatewaysdk/tracing/instrumentors/claude_agent_sdk.py +766 -0
- gatewaysdk/tracing/instrumentors/instrumentation_principles.md +294 -0
- gatewaysdk/tracing/instrumentors/registry.py +352 -0
- gatewaysdk/tracing/mapping.py +729 -0
- gatewaysdk/tracing/processors.py +393 -0
- gatewaysdk/tracing/push.py +617 -0
- gatewaysdk/tracing/push_models.py +247 -0
- gatewaysdk/tracing/semconv.py +294 -0
- gatewaysdk/tracing/span_builder.py +356 -0
- gatewaysdk/trainer/__init__.py +6 -0
- gatewaysdk/trainer/init_utils.py +263 -0
- gatewaysdk/trainer/legacy.py +359 -0
- gatewaysdk/trainer/registry.py +12 -0
- gatewaysdk/trainer/trainer.py +638 -0
- gatewaysdk/types/__init__.py +63 -0
- gatewaysdk/types/core.py +556 -0
- gatewaysdk/types/resources.py +204 -0
- gatewaysdk/types/tracer.py +515 -0
- gatewaysdk/types/tracing.py +162 -0
- gatewaysdk/users.py +251 -0
- gatewaysdk/utils/__init__.py +1 -0
- gatewaysdk/utils/id.py +18 -0
- gatewaysdk/utils/metrics.py +1025 -0
- gatewaysdk/utils/otel.py +550 -0
- gatewaysdk/utils/otlp.py +556 -0
- gatewaysdk/utils/redact.py +22 -0
- gatewaysdk/utils/server_launcher.py +1045 -0
- gatewaysdk/utils/system_snapshot.py +90 -0
- gatewaysdk/verl/__init__.py +8 -0
- gatewaysdk/verl/__main__.py +6 -0
- gatewaysdk/verl/async_server.py +46 -0
- gatewaysdk/verl/config.yaml +27 -0
- gatewaysdk/verl/daemon.py +1154 -0
- gatewaysdk/verl/dataset.py +44 -0
- gatewaysdk/verl/entrypoint.py +248 -0
- gatewaysdk/verl/trainer.py +549 -0
- gatewaysdk/world_browser.py +748 -0
- gatewaysdk/world_data.py +453 -0
- gatewaysdk/world_sessions.py +978 -0
- gatewaysdk/world_tasks.py +285 -0
- gatewaysdk/world_tools.py +115 -0
- gatewaysdk/worlds.py +639 -0
- gatewaysdk-0.3.2.dist-info/METADATA +236 -0
- gatewaysdk-0.3.2.dist-info/RECORD +376 -0
- gatewaysdk-0.3.2.dist-info/WHEEL +4 -0
- gatewaysdk-0.3.2.dist-info/entry_points.txt +5 -0
- gatewaysdk-0.3.2.dist-info/licenses/LICENSE +19 -0
|
@@ -0,0 +1,4695 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "urn:gateway:connector:salesforce",
|
|
4
|
+
"$comment": "Tenant-shaped standard-object skeleton generated from pinned Winter 27 Object Reference field declarations. Describe-on-bind remains required for the org model, custom fields, enabled-feature fields, and org picklists. See provenance.json.",
|
|
5
|
+
"$defs": {
|
|
6
|
+
"NullableId": {
|
|
7
|
+
"type": [
|
|
8
|
+
"string",
|
|
9
|
+
"null"
|
|
10
|
+
],
|
|
11
|
+
"minLength": 1,
|
|
12
|
+
"maxLength": 128,
|
|
13
|
+
"description": "A Salesforce record ID on a nillable reference field."
|
|
14
|
+
},
|
|
15
|
+
"Address": {
|
|
16
|
+
"type": "object",
|
|
17
|
+
"description": "Salesforce compound address value returned when a compound address field is selected.",
|
|
18
|
+
"properties": {
|
|
19
|
+
"city": {
|
|
20
|
+
"type": [
|
|
21
|
+
"string",
|
|
22
|
+
"null"
|
|
23
|
+
]
|
|
24
|
+
},
|
|
25
|
+
"country": {
|
|
26
|
+
"type": [
|
|
27
|
+
"string",
|
|
28
|
+
"null"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
"geocodeAccuracy": {
|
|
32
|
+
"type": [
|
|
33
|
+
"string",
|
|
34
|
+
"null"
|
|
35
|
+
]
|
|
36
|
+
},
|
|
37
|
+
"latitude": {
|
|
38
|
+
"type": [
|
|
39
|
+
"number",
|
|
40
|
+
"null"
|
|
41
|
+
],
|
|
42
|
+
"minimum": -90,
|
|
43
|
+
"maximum": 90
|
|
44
|
+
},
|
|
45
|
+
"longitude": {
|
|
46
|
+
"type": [
|
|
47
|
+
"number",
|
|
48
|
+
"null"
|
|
49
|
+
],
|
|
50
|
+
"minimum": -180,
|
|
51
|
+
"maximum": 180
|
|
52
|
+
},
|
|
53
|
+
"postalCode": {
|
|
54
|
+
"type": [
|
|
55
|
+
"string",
|
|
56
|
+
"null"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
"state": {
|
|
60
|
+
"type": [
|
|
61
|
+
"string",
|
|
62
|
+
"null"
|
|
63
|
+
]
|
|
64
|
+
},
|
|
65
|
+
"street": {
|
|
66
|
+
"type": [
|
|
67
|
+
"string",
|
|
68
|
+
"null"
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"required": [
|
|
73
|
+
"city",
|
|
74
|
+
"country",
|
|
75
|
+
"geocodeAccuracy",
|
|
76
|
+
"latitude",
|
|
77
|
+
"longitude",
|
|
78
|
+
"postalCode",
|
|
79
|
+
"state",
|
|
80
|
+
"street"
|
|
81
|
+
],
|
|
82
|
+
"additionalProperties": false
|
|
83
|
+
},
|
|
84
|
+
"User": {
|
|
85
|
+
"type": "object",
|
|
86
|
+
"description": "User fields documented by the pinned Winter 27 Object Reference. Properties are the union of documented read/create forms; only Id is universally required by this stored entity so SOQL projections remain ingestible.",
|
|
87
|
+
"properties": {
|
|
88
|
+
"Id": {
|
|
89
|
+
"$ref": "base.json#/$defs/Id",
|
|
90
|
+
"description": "Unique Salesforce record identifier.",
|
|
91
|
+
"readOnly": true
|
|
92
|
+
},
|
|
93
|
+
"AboutMe": {
|
|
94
|
+
"type": [
|
|
95
|
+
"string",
|
|
96
|
+
"null"
|
|
97
|
+
],
|
|
98
|
+
"description": "Information about the user, such as areas of interest or skills. This field is available even if Chatter is disabled."
|
|
99
|
+
},
|
|
100
|
+
"AccountId": {
|
|
101
|
+
"$ref": "#/$defs/NullableId",
|
|
102
|
+
"description": "ID of the Account associated with a Customer Portal user. This field is null for Salesforce users.",
|
|
103
|
+
"readOnly": true
|
|
104
|
+
},
|
|
105
|
+
"Address": {
|
|
106
|
+
"anyOf": [
|
|
107
|
+
{
|
|
108
|
+
"$ref": "#/$defs/Address"
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"type": "null"
|
|
112
|
+
}
|
|
113
|
+
],
|
|
114
|
+
"description": "The compound form of the address. Read-only. See Address Compound Fields for details on compound address fields.",
|
|
115
|
+
"readOnly": true
|
|
116
|
+
},
|
|
117
|
+
"Alias": {
|
|
118
|
+
"type": "string",
|
|
119
|
+
"description": "Required. The user’s alias. For example, jsmith ."
|
|
120
|
+
},
|
|
121
|
+
"BadgeText": {
|
|
122
|
+
"type": [
|
|
123
|
+
"string",
|
|
124
|
+
"null"
|
|
125
|
+
],
|
|
126
|
+
"description": "The Experience Cloud site role, displayed on the user profile page just below the user name.",
|
|
127
|
+
"readOnly": true
|
|
128
|
+
},
|
|
129
|
+
"BannerPhotoUrl": {
|
|
130
|
+
"type": [
|
|
131
|
+
"string",
|
|
132
|
+
"null"
|
|
133
|
+
],
|
|
134
|
+
"description": "The URL for the user's banner photo. This field is available in API version 36.0 and later.",
|
|
135
|
+
"readOnly": true
|
|
136
|
+
},
|
|
137
|
+
"CallCenterId": {
|
|
138
|
+
"$ref": "#/$defs/NullableId",
|
|
139
|
+
"description": "If Salesforce CRM Call Center is enabled, represents the call center that this user is assigned to."
|
|
140
|
+
},
|
|
141
|
+
"City": {
|
|
142
|
+
"type": [
|
|
143
|
+
"string",
|
|
144
|
+
"null"
|
|
145
|
+
],
|
|
146
|
+
"description": "The city associated with the user. Up to 40 characters allowed."
|
|
147
|
+
},
|
|
148
|
+
"CommunityNickname": {
|
|
149
|
+
"type": "string",
|
|
150
|
+
"description": "Unique name used to identify this user in the Experience Cloud site."
|
|
151
|
+
},
|
|
152
|
+
"CompanyName": {
|
|
153
|
+
"type": [
|
|
154
|
+
"string",
|
|
155
|
+
"null"
|
|
156
|
+
],
|
|
157
|
+
"description": "The name of the user’s company."
|
|
158
|
+
},
|
|
159
|
+
"ContactId": {
|
|
160
|
+
"$ref": "#/$defs/NullableId",
|
|
161
|
+
"description": "ID of the Contact associated with this account. The contact must have a value in the AccountId field or an error occurs."
|
|
162
|
+
},
|
|
163
|
+
"Country": {
|
|
164
|
+
"type": [
|
|
165
|
+
"string",
|
|
166
|
+
"null"
|
|
167
|
+
],
|
|
168
|
+
"description": "The country associated with the user. Up to 80 characters allowed."
|
|
169
|
+
},
|
|
170
|
+
"CountryCode": {
|
|
171
|
+
"type": [
|
|
172
|
+
"string",
|
|
173
|
+
"null"
|
|
174
|
+
],
|
|
175
|
+
"description": "The ISO country code associated with the user."
|
|
176
|
+
},
|
|
177
|
+
"CurrentStatus": {
|
|
178
|
+
"type": [
|
|
179
|
+
"string",
|
|
180
|
+
"null"
|
|
181
|
+
],
|
|
182
|
+
"description": "Text that describes what the user is working on. Note If you update this field, the API automatically adds a post of type UserStatus on the user’s profile in Chatter. This field is deprecated in API version 25.0. To achieve similar behavior, post to the user directly by creating a FeedItem with the user’s ParentId."
|
|
183
|
+
},
|
|
184
|
+
"DefaultCurrencyIsoCode": {
|
|
185
|
+
"type": [
|
|
186
|
+
"string",
|
|
187
|
+
"null"
|
|
188
|
+
],
|
|
189
|
+
"description": "The user's default currency setting for new records. For example, if a user in France sets DefaultCurrencyIsoCode to euros, then that’s their default currency. Only applicable for organizations that use multiple currencies."
|
|
190
|
+
},
|
|
191
|
+
"DefaultDivision": {
|
|
192
|
+
"type": "string",
|
|
193
|
+
"description": "This record’s default division. Only applicable if divisions are enabled."
|
|
194
|
+
},
|
|
195
|
+
"DefaultGroupNotificationFrequency": {
|
|
196
|
+
"type": "string",
|
|
197
|
+
"enum": [
|
|
198
|
+
"P",
|
|
199
|
+
"D",
|
|
200
|
+
"W",
|
|
201
|
+
"N"
|
|
202
|
+
],
|
|
203
|
+
"description": "Required. The default frequency for sending the user's Chatter group email notifications when the user joins groups . The valid values are: P — Email on every post D —Daily digests W —Weekly digests N —Never The default value is N . For Professional, Enterprise, Unlimited, and Developer Edition organizations that existed before API version 22.0, the default value remains D . This field is available in API version 21.0 and later."
|
|
204
|
+
},
|
|
205
|
+
"DelegatedApproverId": {
|
|
206
|
+
"$ref": "#/$defs/NullableId",
|
|
207
|
+
"description": "Id of the user who is a delegated approver for this user."
|
|
208
|
+
},
|
|
209
|
+
"Department": {
|
|
210
|
+
"type": [
|
|
211
|
+
"string",
|
|
212
|
+
"null"
|
|
213
|
+
],
|
|
214
|
+
"description": "The company department associated with the user."
|
|
215
|
+
},
|
|
216
|
+
"DigestFrequency": {
|
|
217
|
+
"type": "string",
|
|
218
|
+
"enum": [
|
|
219
|
+
"D",
|
|
220
|
+
"W",
|
|
221
|
+
"N"
|
|
222
|
+
],
|
|
223
|
+
"description": "Required. The send frequency of the user’s Chatter personal email digest. The valid values are: D = Daily W = Weekly N = Never The default value is D ."
|
|
224
|
+
},
|
|
225
|
+
"Division": {
|
|
226
|
+
"type": [
|
|
227
|
+
"string",
|
|
228
|
+
"null"
|
|
229
|
+
],
|
|
230
|
+
"description": "The division associated with this user, similar to Department, and unrelated to DefaultDivision ."
|
|
231
|
+
},
|
|
232
|
+
"Email": {
|
|
233
|
+
"type": "string",
|
|
234
|
+
"description": "Required. The user’s email address."
|
|
235
|
+
},
|
|
236
|
+
"EmailEncodingKey": {
|
|
237
|
+
"type": "string",
|
|
238
|
+
"description": "Required. The email encoding for the user, such as ISO-8859-1 or UTF-8 ."
|
|
239
|
+
},
|
|
240
|
+
"EmailPreferencesAutoBcc": {
|
|
241
|
+
"type": "string",
|
|
242
|
+
"description": "Determines whether the user receives copies of sent emails. This option applies only if compliance BCC emails aren’t enabled."
|
|
243
|
+
},
|
|
244
|
+
"EmployeeNumber": {
|
|
245
|
+
"type": [
|
|
246
|
+
"string",
|
|
247
|
+
"null"
|
|
248
|
+
],
|
|
249
|
+
"description": "The user’s employee number."
|
|
250
|
+
},
|
|
251
|
+
"EndDay": {
|
|
252
|
+
"type": [
|
|
253
|
+
"string",
|
|
254
|
+
"null"
|
|
255
|
+
],
|
|
256
|
+
"description": "The time of day that the user generally stops working. Used to define the times that display in the user’s calendar. This field is available in API version 63.0 and later."
|
|
257
|
+
},
|
|
258
|
+
"Extension": {
|
|
259
|
+
"type": [
|
|
260
|
+
"string",
|
|
261
|
+
"null"
|
|
262
|
+
],
|
|
263
|
+
"description": "The user’s phone extension number."
|
|
264
|
+
},
|
|
265
|
+
"Fax": {
|
|
266
|
+
"type": [
|
|
267
|
+
"string",
|
|
268
|
+
"null"
|
|
269
|
+
],
|
|
270
|
+
"description": "The user’s fax number."
|
|
271
|
+
},
|
|
272
|
+
"FederationIdentifier": {
|
|
273
|
+
"type": [
|
|
274
|
+
"string",
|
|
275
|
+
"null"
|
|
276
|
+
],
|
|
277
|
+
"description": "Indicates the value that must be listed in the Subject element of a Security Assertion Markup Language (SAML) IDP certificate to authenticate the user for a client application using single sign-on. This value must be specified if the SAML User ID Type is Assertion contains Federation ID from the User record. Otherwise, this field can’t be edited."
|
|
278
|
+
},
|
|
279
|
+
"FirstName": {
|
|
280
|
+
"type": [
|
|
281
|
+
"string",
|
|
282
|
+
"null"
|
|
283
|
+
],
|
|
284
|
+
"description": "The user’s first name."
|
|
285
|
+
},
|
|
286
|
+
"ForecastEnabled": {
|
|
287
|
+
"type": "string",
|
|
288
|
+
"description": "Indicates whether the user is enabled for forecasts ( true ) or not ( false ). Forecast user has access to the forecasts page."
|
|
289
|
+
},
|
|
290
|
+
"FullPhotoUrl": {
|
|
291
|
+
"type": [
|
|
292
|
+
"string",
|
|
293
|
+
"null"
|
|
294
|
+
],
|
|
295
|
+
"description": "The URL for the user's profile photo. This field is available even if Chatter is disabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo is uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. This field is available in API version 20.0 and later.",
|
|
296
|
+
"readOnly": true
|
|
297
|
+
},
|
|
298
|
+
"GeocodeAccuracy": {
|
|
299
|
+
"type": [
|
|
300
|
+
"string",
|
|
301
|
+
"null"
|
|
302
|
+
],
|
|
303
|
+
"description": "The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates."
|
|
304
|
+
},
|
|
305
|
+
"HasUserVerifiedEmail": {
|
|
306
|
+
"type": "string",
|
|
307
|
+
"description": "Indicates whether the user's email is verified ( true ) or not ( false ). The default value is false . This field is available in API version 63.0 and later.",
|
|
308
|
+
"readOnly": true
|
|
309
|
+
},
|
|
310
|
+
"HasUserVerifiedPhone": {
|
|
311
|
+
"type": "string",
|
|
312
|
+
"description": "Indicates whether the user's phone number is verified ( true ) or not ( false ). The default value is false. This field is available in API version 63.0 and later.",
|
|
313
|
+
"readOnly": true
|
|
314
|
+
},
|
|
315
|
+
"IndividualId": {
|
|
316
|
+
"$ref": "#/$defs/NullableId",
|
|
317
|
+
"description": "ID of the data privacy record associated with this user. This field is available if Data Protection and Privacy is enabled."
|
|
318
|
+
},
|
|
319
|
+
"IsActive": {
|
|
320
|
+
"type": "string",
|
|
321
|
+
"description": "Indicates whether the user has access to log in ( true ) or not ( false ). You can modify a User's active status from the user interface or via the API."
|
|
322
|
+
},
|
|
323
|
+
"IsPartner": {
|
|
324
|
+
"type": "string",
|
|
325
|
+
"description": "Indicates whether the user is a partner who has access to the partner portal ( true ) or not ( false ). This field isn’t available for release 9.0 and later. Instead, use UserType with the value Partner or Power Partner .",
|
|
326
|
+
"readOnly": true
|
|
327
|
+
},
|
|
328
|
+
"IsPortalEnabled": {
|
|
329
|
+
"type": "string",
|
|
330
|
+
"description": "Indicates whether an active, external, user has access to Experience Cloud sites or portals ( true ) or not ( false ). This field is only available if one of these conditions is true: Digital experiences is enabled and you have community or portal user licenses Portals are enabled Note Users with External Identity licenses can access Experience Cloud sites even if the flag is false."
|
|
331
|
+
},
|
|
332
|
+
"IsPortalSelfRegistered": {
|
|
333
|
+
"type": "string",
|
|
334
|
+
"description": "Indicates whether the user is a Customer Portal user who self-registered for your organization's Customer Portal ( true ) or not ( false ). This field isn’t available for release 9.0 and earlier."
|
|
335
|
+
},
|
|
336
|
+
"IsPrmSuperUser": {
|
|
337
|
+
"type": "string",
|
|
338
|
+
"description": "Available for partner portal users only. Indicates whether the user has super user access in the partner portal ( true ) or not ( false )."
|
|
339
|
+
},
|
|
340
|
+
"IsProfilePhotoActive": {
|
|
341
|
+
"type": "string",
|
|
342
|
+
"description": "Indicates whether a user has a profile photo ( true ) or not ( false ). This field is available in API version 36.0 and later.",
|
|
343
|
+
"readOnly": true
|
|
344
|
+
},
|
|
345
|
+
"JigsawImportLimitOverride": {
|
|
346
|
+
"type": [
|
|
347
|
+
"integer",
|
|
348
|
+
"null"
|
|
349
|
+
],
|
|
350
|
+
"description": "The Data.com user’s monthly addition limit. The value must be between zero and the organization’s monthly addition limit. Label is Data.com Monthly Addition Limit . This field is available in API version 27.0 and later."
|
|
351
|
+
},
|
|
352
|
+
"LanguageLocaleKey": {
|
|
353
|
+
"type": "string",
|
|
354
|
+
"description": "Required. The user’s language, such as French or Chinese (Traditional). Label is Language . Note In API version 47.0 and later, when using the DescribeSObjectResult API to return PicklistEntry values from this picklist, the active value indicates whether the language is in the user’s Displayed Languages ( true ) or the user’s Available Languages ( false ). All other languages aren’t in the returned active value array. In API version 46.0 and earlier, the PicklistEntry active values indicate whether the language is in either the user’s Displayed Languages or Available Languages lists ( true ) or not in either list ( false )."
|
|
355
|
+
},
|
|
356
|
+
"LastLoginDate": {
|
|
357
|
+
"anyOf": [
|
|
358
|
+
{
|
|
359
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
"type": "null"
|
|
363
|
+
}
|
|
364
|
+
],
|
|
365
|
+
"description": "The date and time when the user last successfully logged in. This value is updated if 60 seconds elapses since the user’s last login.",
|
|
366
|
+
"readOnly": true
|
|
367
|
+
},
|
|
368
|
+
"LastName": {
|
|
369
|
+
"type": "string",
|
|
370
|
+
"description": "Required. The user’s last name."
|
|
371
|
+
},
|
|
372
|
+
"LastReferencedDate": {
|
|
373
|
+
"anyOf": [
|
|
374
|
+
{
|
|
375
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"type": "null"
|
|
379
|
+
}
|
|
380
|
+
],
|
|
381
|
+
"description": "The timestamp for when the current user last viewed a record related to this record.",
|
|
382
|
+
"readOnly": true
|
|
383
|
+
},
|
|
384
|
+
"LastViewedDate": {
|
|
385
|
+
"anyOf": [
|
|
386
|
+
{
|
|
387
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
388
|
+
},
|
|
389
|
+
{
|
|
390
|
+
"type": "null"
|
|
391
|
+
}
|
|
392
|
+
],
|
|
393
|
+
"description": "The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced ( LastReferencedDate ) but not viewed.",
|
|
394
|
+
"readOnly": true
|
|
395
|
+
},
|
|
396
|
+
"Latitude": {
|
|
397
|
+
"type": [
|
|
398
|
+
"number",
|
|
399
|
+
"null"
|
|
400
|
+
],
|
|
401
|
+
"description": "Used with Longitude to specify the geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
402
|
+
},
|
|
403
|
+
"LocaleSidKey": {
|
|
404
|
+
"type": "string",
|
|
405
|
+
"description": "Required. This field is a restricted picklist field. The value of the field affects formatting and parsing of values, especially numeric values, in the user interface. It doesn’t affect the API. The field values are named according to the language, and the country if necessary, using two-letter ISO codes. The set of names is based on the ISO standard. You can also manually set a user’s locale in the user interface, and then use that value for inserting or updating other users via the API."
|
|
406
|
+
},
|
|
407
|
+
"Longitude": {
|
|
408
|
+
"type": [
|
|
409
|
+
"number",
|
|
410
|
+
"null"
|
|
411
|
+
],
|
|
412
|
+
"description": "Used with Latitude to specify the geolocation of an address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
413
|
+
},
|
|
414
|
+
"Manager": {
|
|
415
|
+
"type": "string",
|
|
416
|
+
"description": "User lookup field used to select the user's manager. This field establishes a hierarchical relationship, preventing you from selecting a user that directly or indirectly reports to themselves."
|
|
417
|
+
},
|
|
418
|
+
"ManagerId": {
|
|
419
|
+
"$ref": "#/$defs/NullableId",
|
|
420
|
+
"description": "The Id of the user who manages this user."
|
|
421
|
+
},
|
|
422
|
+
"MediumBannerPhotoUrl": {
|
|
423
|
+
"type": [
|
|
424
|
+
"string",
|
|
425
|
+
"null"
|
|
426
|
+
],
|
|
427
|
+
"description": "The URL for the medium-sized user profile banner photo.",
|
|
428
|
+
"readOnly": true
|
|
429
|
+
},
|
|
430
|
+
"MiddleName": {
|
|
431
|
+
"type": [
|
|
432
|
+
"string",
|
|
433
|
+
"null"
|
|
434
|
+
],
|
|
435
|
+
"maxLength": 40,
|
|
436
|
+
"description": "The user’s middle name. Maximum size is 40 characters. To enable this field, contact Salesforce Customer Support."
|
|
437
|
+
},
|
|
438
|
+
"MobilePhone": {
|
|
439
|
+
"type": [
|
|
440
|
+
"string",
|
|
441
|
+
"null"
|
|
442
|
+
],
|
|
443
|
+
"description": "The user’s mobile device number."
|
|
444
|
+
},
|
|
445
|
+
"Name": {
|
|
446
|
+
"type": "string",
|
|
447
|
+
"description": "Concatenation of FirstName and LastName . Limited to 203 characters, including whitespaces.",
|
|
448
|
+
"readOnly": true
|
|
449
|
+
},
|
|
450
|
+
"NumberOfFailedLogins": {
|
|
451
|
+
"type": [
|
|
452
|
+
"integer",
|
|
453
|
+
"null"
|
|
454
|
+
],
|
|
455
|
+
"description": "The number of failed UI login attempts for the user’s account. When the maximum number of failed UI login attempts is reached, the counter resets and the user’s account is locked. If there’s a successful UI login before the maximum number of failed UI login attempts is reached, the counter resets and the user’s account remains unlocked.",
|
|
456
|
+
"readOnly": true
|
|
457
|
+
},
|
|
458
|
+
"OfflineTrialExpirationDate": {
|
|
459
|
+
"anyOf": [
|
|
460
|
+
{
|
|
461
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
462
|
+
},
|
|
463
|
+
{
|
|
464
|
+
"type": "null"
|
|
465
|
+
}
|
|
466
|
+
],
|
|
467
|
+
"description": "The date and time when the user’s Connect Offline trial expires.",
|
|
468
|
+
"readOnly": true
|
|
469
|
+
},
|
|
470
|
+
"PasswordExpirationDate": {
|
|
471
|
+
"anyOf": [
|
|
472
|
+
{
|
|
473
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"type": "null"
|
|
477
|
+
}
|
|
478
|
+
],
|
|
479
|
+
"description": "The date and time when the user’s password expires. This field is available in API version 63.0 and later.",
|
|
480
|
+
"readOnly": true
|
|
481
|
+
},
|
|
482
|
+
"Phone": {
|
|
483
|
+
"type": [
|
|
484
|
+
"string",
|
|
485
|
+
"null"
|
|
486
|
+
],
|
|
487
|
+
"description": "The user’s phone number."
|
|
488
|
+
},
|
|
489
|
+
"PortalRole": {
|
|
490
|
+
"type": [
|
|
491
|
+
"string",
|
|
492
|
+
"null"
|
|
493
|
+
],
|
|
494
|
+
"description": "The role of the user in the Customer Portal (either Executive, Manager, User, or PersonAcount). In API version 15.0 and earlier, if you set this field to null, the system automatically included a portal role. In API version 16.0 and above, when you set this field to null, a portal role is not automatically created. When this field is null and a ContactId is provided, the user is assigned to the User role. The Update property is available in API version 43.0 and later. The field is available if Customer Portal is enabled OR digital experiences is enabled and Experience Cloud sites have available partner portal, Customer Portal, or High-Volume Portal User licenses."
|
|
495
|
+
},
|
|
496
|
+
"PostalCode": {
|
|
497
|
+
"type": [
|
|
498
|
+
"string",
|
|
499
|
+
"null"
|
|
500
|
+
],
|
|
501
|
+
"description": "The user’s postal or ZIP code. Label is Zip/Postal Code ."
|
|
502
|
+
},
|
|
503
|
+
"ProfileId": {
|
|
504
|
+
"$ref": "base.json#/$defs/Id",
|
|
505
|
+
"description": "Required. ID of the user’s Profile. Use this value to cache metadata based on profile. In earlier releases, this was RoleId ."
|
|
506
|
+
},
|
|
507
|
+
"ReceivesAdminInfoEmails": {
|
|
508
|
+
"type": "string",
|
|
509
|
+
"description": "Indicates whether the user receives email for administrators from Salesforce ( true ) or not ( false )."
|
|
510
|
+
},
|
|
511
|
+
"ReceivesInfoEmails": {
|
|
512
|
+
"type": "string",
|
|
513
|
+
"description": "Indicates whether the user receives informational email from Salesforce ( true ) or not ( false )."
|
|
514
|
+
},
|
|
515
|
+
"SenderEmail": {
|
|
516
|
+
"type": [
|
|
517
|
+
"string",
|
|
518
|
+
"null"
|
|
519
|
+
],
|
|
520
|
+
"description": "The email address used as the From address when the user sends emails. This address is the same value shown in Setup on the My Email Settings page."
|
|
521
|
+
},
|
|
522
|
+
"SenderName": {
|
|
523
|
+
"type": [
|
|
524
|
+
"string",
|
|
525
|
+
"null"
|
|
526
|
+
],
|
|
527
|
+
"description": "The name used as the email sender when the user sends emails. This name is the same value shown in Setup on the My Email Settings page."
|
|
528
|
+
},
|
|
529
|
+
"Signature": {
|
|
530
|
+
"type": [
|
|
531
|
+
"string",
|
|
532
|
+
"null"
|
|
533
|
+
],
|
|
534
|
+
"description": "The signature text added to emails. This text is the same value shown in Setup on the My Email Settings page."
|
|
535
|
+
},
|
|
536
|
+
"SmallBannerPhotoUrl": {
|
|
537
|
+
"type": [
|
|
538
|
+
"string",
|
|
539
|
+
"null"
|
|
540
|
+
],
|
|
541
|
+
"description": "The URL for the small user profile banner photo.",
|
|
542
|
+
"readOnly": true
|
|
543
|
+
},
|
|
544
|
+
"SmallPhotoUrl": {
|
|
545
|
+
"type": [
|
|
546
|
+
"string",
|
|
547
|
+
"null"
|
|
548
|
+
],
|
|
549
|
+
"description": "The URL for a thumbnail of the user's profile photo. This field is available even if Chatter is disabled. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo is uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. This field is available in API version 20.0 and later.",
|
|
550
|
+
"readOnly": true
|
|
551
|
+
},
|
|
552
|
+
"StartDay": {
|
|
553
|
+
"type": [
|
|
554
|
+
"string",
|
|
555
|
+
"null"
|
|
556
|
+
],
|
|
557
|
+
"description": "The time of day that the user generally starts working. Used to define the times that display in the user’s calendar. This field is available in API version 63.0 and later."
|
|
558
|
+
},
|
|
559
|
+
"State": {
|
|
560
|
+
"type": [
|
|
561
|
+
"string",
|
|
562
|
+
"null"
|
|
563
|
+
],
|
|
564
|
+
"description": "The state associated with the User. Up to 80 characters allowed."
|
|
565
|
+
},
|
|
566
|
+
"StateCode": {
|
|
567
|
+
"type": [
|
|
568
|
+
"string",
|
|
569
|
+
"null"
|
|
570
|
+
],
|
|
571
|
+
"description": "The ISO state code associated with the user."
|
|
572
|
+
},
|
|
573
|
+
"Street": {
|
|
574
|
+
"type": [
|
|
575
|
+
"string",
|
|
576
|
+
"null"
|
|
577
|
+
],
|
|
578
|
+
"description": "The street address associated with the User."
|
|
579
|
+
},
|
|
580
|
+
"SuAccessExpirationDate": {
|
|
581
|
+
"type": [
|
|
582
|
+
"string",
|
|
583
|
+
"null"
|
|
584
|
+
],
|
|
585
|
+
"minLength": 10,
|
|
586
|
+
"maxLength": 10,
|
|
587
|
+
"format": "date",
|
|
588
|
+
"description": "The expiration date for allowing Salesforce Customer Support to log in as this user with Login As functionality. After this date, the user must grant login access to Salesforce Customer Support again. This field is available in API version 63.0 or later.",
|
|
589
|
+
"readOnly": true
|
|
590
|
+
},
|
|
591
|
+
"Suffix": {
|
|
592
|
+
"type": [
|
|
593
|
+
"string",
|
|
594
|
+
"null"
|
|
595
|
+
],
|
|
596
|
+
"maxLength": 40,
|
|
597
|
+
"description": "The user’s name suffix. Maximum size is 40 characters. To enable this field, contact Salesforce Customer Support."
|
|
598
|
+
},
|
|
599
|
+
"TimeZoneSidKey": {
|
|
600
|
+
"type": "string",
|
|
601
|
+
"description": "Required. This field is a restricted picklist field. A User time zone affects the offset used when displaying or entering times in the user interface. But the API doesn’t use a User time zone when querying or setting values. Values for this field are named using region and key city, according to ISO standards. You can also manually set one User time zone in the user interface, and then use that value for creating or updating other User records via the API."
|
|
602
|
+
},
|
|
603
|
+
"Title": {
|
|
604
|
+
"type": [
|
|
605
|
+
"string",
|
|
606
|
+
"null"
|
|
607
|
+
],
|
|
608
|
+
"description": "The user’s business title, such as Vice President."
|
|
609
|
+
},
|
|
610
|
+
"Username": {
|
|
611
|
+
"type": "string",
|
|
612
|
+
"description": "Required. Contains the name that a user enters to log in to the API or the user interface. The value for this field must be in the form of an email address, using all lowercase characters. It must also be unique across all organizations. If you try to create or update a User with a duplicate value for this field, the operation is rejected. Each inserted User also counts as a license. Every organization has a maximum number of licenses. If you attempt to exceed the maximum number of licenses by inserting User records, the create request is rejected."
|
|
613
|
+
},
|
|
614
|
+
"UserPermissionsCallCenterAutoLogin": {
|
|
615
|
+
"type": "string",
|
|
616
|
+
"description": "Required if Salesforce CRM Call Center is enabled. Indicates whether the user is enabled to use the auto login feature of the call center ( true ) or not ( false )."
|
|
617
|
+
},
|
|
618
|
+
"UserPermissionsChatterAnswersUser": {
|
|
619
|
+
"type": "string",
|
|
620
|
+
"description": "Indicates whether the portal user is enabled to use the Chatter Answers feature ( true ) or not ( false ). This field defaults to false when a Customer Portal user is created from the API."
|
|
621
|
+
},
|
|
622
|
+
"UserPermissionsInteractionUser": {
|
|
623
|
+
"type": "string",
|
|
624
|
+
"description": "Indicates whether the user can run flows or not. Label is Flow User ."
|
|
625
|
+
},
|
|
626
|
+
"UserPermissionsJigsawProspectingUser": {
|
|
627
|
+
"type": "string",
|
|
628
|
+
"description": "Indicates whether the user is allocated one Data.com user license ( true ) or not ( false ). The Data.com user lets the user add Data.com contact and lead records to Salesforce in supported editions. Label is Data.com User ."
|
|
629
|
+
},
|
|
630
|
+
"UserPermissionsKnowledgeUser": {
|
|
631
|
+
"type": "string",
|
|
632
|
+
"description": "Indicates whether the user is enabled to use Salesforce Knowledge ( true ) or not ( false ). Label is Knowledge User ."
|
|
633
|
+
},
|
|
634
|
+
"UserPermissionsLiveAgentUser": {
|
|
635
|
+
"type": "string",
|
|
636
|
+
"description": "Indicates whether the user is enabled to use Chat ( true ) or not ( false ). Label is Live Agent User ."
|
|
637
|
+
},
|
|
638
|
+
"UserPermissionsMarketingUser": {
|
|
639
|
+
"type": "string",
|
|
640
|
+
"description": "Required. Indicates whether the user is enabled to manage campaigns in the user interface ( true ) or not ( false ). Label is Marketing User ."
|
|
641
|
+
},
|
|
642
|
+
"UserPermissionsOfflineUser": {
|
|
643
|
+
"type": "string",
|
|
644
|
+
"description": "Required. Indicates whether the user is enabled to use Offline Edition ( true ) or not ( false ). Label is Offline User ."
|
|
645
|
+
},
|
|
646
|
+
"UserPermissionsSFContentUser": {
|
|
647
|
+
"type": "string",
|
|
648
|
+
"description": "Indicates whether the user is allocated one Salesforce CRM Content User License ( true ) or not ( false ). Label is Salesforce CRM Content User . The Salesforce CRM Content User license grants the user access to the Salesforce CRM Content application."
|
|
649
|
+
},
|
|
650
|
+
"UserPermissionsSiteforceContributorUser": {
|
|
651
|
+
"type": "string",
|
|
652
|
+
"description": "Indicates whether the user is allocated one Site.com Contributor feature license ( true ) or not ( false ). Label is Site.com Contributor User . The Site.com Contributor feature license grants the user access to the Site.com application. Users with a Contributor license can use Site.com Studio to edit site content only."
|
|
653
|
+
},
|
|
654
|
+
"UserPermissionsSiteforcePublisherUser": {
|
|
655
|
+
"type": "string",
|
|
656
|
+
"description": "Indicates whether the user is allocated one Site.com Publisher feature license ( true ) or not ( false ). Label is Site.com Publisher User . The Site.com Publisher feature license grants the user access to the Site.com application. Users with a Publisher license can build and style websites, control the layout and functionality of pages and page elements, and add and edit content."
|
|
657
|
+
},
|
|
658
|
+
"UserPermissionsSupportUser": {
|
|
659
|
+
"type": "string",
|
|
660
|
+
"description": "When true , the user can use the Salesforce console."
|
|
661
|
+
},
|
|
662
|
+
"UserPermissionsWirelessUser": {
|
|
663
|
+
"type": "string",
|
|
664
|
+
"description": "Required if the Wireless permission is enabled. Indicates whether the user is enabled to use Wireless Edition ( true ) or not ( false ). Label is Wireless User . Note As of November 2005, Salesforce Wireless Edition is no longer available for purchase. You can continue to use Wireless Edition through the end of your existing contract term if you are: A Professional Edition customer and purchased Wireless Edition before November 7, 2005. An Enterprise Edition customer who signed or renewed their Salesforce contract before November 7, 2005."
|
|
665
|
+
},
|
|
666
|
+
"UserPermissionsWorkDotComUserFeature": {
|
|
667
|
+
"type": "string",
|
|
668
|
+
"description": "Indicates whether the WDC feature is enabled for the user ( true ) or not ( false )."
|
|
669
|
+
},
|
|
670
|
+
"UserPreferencesActivityRemindersPopup": {
|
|
671
|
+
"type": "string",
|
|
672
|
+
"description": "When true , a reminder window automatically opens when an activity reminder is due. Corresponds to the Trigger alert when reminder comes due checkbox at the Reminders page in the personal settings in the user interface."
|
|
673
|
+
},
|
|
674
|
+
"UserPreferencesAgentGdprConsent": {
|
|
675
|
+
"type": "string",
|
|
676
|
+
"description": "When true , indicates that the user has consented that calls may be recorded and transcribed, and such calls, recordings and transcripts may be analyzed for quality or training purposes. When false , the user has not given that consent."
|
|
677
|
+
},
|
|
678
|
+
"UserPreferencesAllowConversationReminders": {
|
|
679
|
+
"type": "string",
|
|
680
|
+
"description": "When true , voice and call reminders are displayed as notification cards in Lightning Experience. Corresponds to the Show conversation reminders in Lightning Experience checkbox in the Activity Reminders page in the personal settings in the user interface. This field is available in API version 55.0 and later."
|
|
681
|
+
},
|
|
682
|
+
"UserPreferencesApexPagesDeveloperMode": {
|
|
683
|
+
"type": "string",
|
|
684
|
+
"description": "When true , indicates that the user has enabled developer mode for editing Visualforce pages and controllers."
|
|
685
|
+
},
|
|
686
|
+
"UserPreferencesAutoForwardCall": {
|
|
687
|
+
"type": "string",
|
|
688
|
+
"description": "When true , the user receives Dialer calls simultaneously in their browser and on their forwarding number."
|
|
689
|
+
},
|
|
690
|
+
"UserPreferencesContentEmailAsAndWhen": {
|
|
691
|
+
"type": "string",
|
|
692
|
+
"description": "When false , a user with Salesforce CRM Content subscriptions receives a once-daily email summary if activity occurs on the subscribed content, libraries, tags, or authors. To receive email, the UserPreferencesContentNoEmail field must also be false . The default value is false . Note This field is only visible when Salesforce CRM Content is enabled."
|
|
693
|
+
},
|
|
694
|
+
"UserPreferencesContentNoEmail": {
|
|
695
|
+
"type": "string",
|
|
696
|
+
"description": "When false , a user with Salesforce CRM Content subscriptions receives email notifications if activity occurs on the subscribed content, libraries, tags, or authors. To receive real-time email alerts, set this field to false and set the UserPreferencesContentEmailAsAndWhen field to true . The default value is false . Note This field is only visible when Salesforce CRM Content is enabled."
|
|
697
|
+
},
|
|
698
|
+
"UserPreferencesEnableAutoSubForFeeds": {
|
|
699
|
+
"type": "string",
|
|
700
|
+
"description": "When true , the user automatically subscribes to feeds for any objects that the user creates. This field is available in API version 25.0 and later."
|
|
701
|
+
},
|
|
702
|
+
"UserPreferencesDisableAllFeedsEmail": {
|
|
703
|
+
"type": "string",
|
|
704
|
+
"description": "When false , the user automatically receives email for all updates to Chatter feeds, based on the types of feed emails and digests the user has enabled. This field is available in API version 24.0 and later."
|
|
705
|
+
},
|
|
706
|
+
"UserPreferencesDisableAutoSubForFeeds": {
|
|
707
|
+
"type": "string",
|
|
708
|
+
"description": "When false , the user automatically subscribes to feeds for any objects that the user creates. This field is deprecated in API version 25.0 and later. Starting with API version 25.0, use UserPreferencesEnableAutoSubForFeeds to enable or disable auto-follow for objects a user creates."
|
|
709
|
+
},
|
|
710
|
+
"UserPreferencesDisableBookmarkEmail": {
|
|
711
|
+
"type": "string",
|
|
712
|
+
"description": "When false , the user automatically receives email every time someone comments on a Chatter feed item after the user has bookmarked it. This field is available in API version 24.0 and later."
|
|
713
|
+
},
|
|
714
|
+
"UserPreferencesDisableChangeCommentEmail": {
|
|
715
|
+
"type": "string",
|
|
716
|
+
"description": "When false , the user automatically receives email every time someone comments on a change the user has made, such as an update to their profile. This field is available in API version 24.0 and later."
|
|
717
|
+
},
|
|
718
|
+
"UserPreferencesDisableEndorsementEmail": {
|
|
719
|
+
"type": "string",
|
|
720
|
+
"description": "When false , the member automatically receives email every time someone endorses them for a topic."
|
|
721
|
+
},
|
|
722
|
+
"UserPreferencesDisableFileShareNotificationsForApi": {
|
|
723
|
+
"type": "string",
|
|
724
|
+
"description": "When false , email notifications are sent from the person who shared the file to the users that the file is shared with. This field is available in API version 25.0 and later."
|
|
725
|
+
},
|
|
726
|
+
"UserPreferencesDisableFollowersEmail": {
|
|
727
|
+
"type": "string",
|
|
728
|
+
"description": "When false , the user automatically receives email every time someone starts following the user in Chatter. This field is available in API version 24.0 and later."
|
|
729
|
+
},
|
|
730
|
+
"UserPreferencesDisableLaterCommentEmail": {
|
|
731
|
+
"type": "string",
|
|
732
|
+
"description": "When false , the user automatically receives email every time someone comments on a feed item after the user has commented on the feed item. This field is available in API version 24.0 and later."
|
|
733
|
+
},
|
|
734
|
+
"UserPreferencesDisableLikeEmail": {
|
|
735
|
+
"type": "string",
|
|
736
|
+
"description": "When false , the user automatically receives email every time someone likes their post or comment. This field is available in API version 24.0 and later."
|
|
737
|
+
},
|
|
738
|
+
"UserPreferencesDisableMentionsPostEmail": {
|
|
739
|
+
"type": "string",
|
|
740
|
+
"description": "When false , the user automatically receives email every time they’re mentioned in posts. This field is available in API version 24.0 and later."
|
|
741
|
+
},
|
|
742
|
+
"UserPreferencesDisableProfilePostEmail": {
|
|
743
|
+
"type": "string",
|
|
744
|
+
"description": "When false , the user automatically receives email every time someone posts to the user’s profile. This field is available in API version 24.0 and later."
|
|
745
|
+
},
|
|
746
|
+
"UserPreferencesDisableSharePostEmail": {
|
|
747
|
+
"type": "string",
|
|
748
|
+
"description": "When false , the user automatically receives email every time their post is shared. This field is available in API version 24.0 and later."
|
|
749
|
+
},
|
|
750
|
+
"UserPreferencesDisableFeedbackEmail": {
|
|
751
|
+
"type": "string",
|
|
752
|
+
"description": "When false , the user automatically receives emails related to WDC feedback. The user receives these emails when someone requests or offers feedback, shares feedback with the user, or reminds the user to answer a feedback request."
|
|
753
|
+
},
|
|
754
|
+
"UserPreferencesDisCommentAfterLikeEmail": {
|
|
755
|
+
"type": "string",
|
|
756
|
+
"description": "When false , the user automatically receives email every time someone comments on a post that the user liked. This field is available in API version 24.0 and later."
|
|
757
|
+
},
|
|
758
|
+
"UserPreferencesDisMentionsCommentEmail": {
|
|
759
|
+
"type": "string",
|
|
760
|
+
"description": "When false , the user automatically receives email every time the user is mentioned in comments. This field is available in API version 24.0 and later."
|
|
761
|
+
},
|
|
762
|
+
"UserPreferencesDisableMessageEmail": {
|
|
763
|
+
"type": "string",
|
|
764
|
+
"description": "When false , the user automatically receives email for Chatter messages sent to the user. This field is available in API version 24.0 and later."
|
|
765
|
+
},
|
|
766
|
+
"UserPreferencesDisableRewardEmail": {
|
|
767
|
+
"type": "string",
|
|
768
|
+
"description": "When false , the user automatically receives emails related to WDC rewards. The user receives these emails when someone gives a reward to the user."
|
|
769
|
+
},
|
|
770
|
+
"UserPreferencesDisableWorkEmail": {
|
|
771
|
+
"type": "string",
|
|
772
|
+
"description": "When false , the user receives emails related to WDC feedback, goals, and coaching. The user must also sign up for individual emails listed on the WDC email settings page. When true , the user doesn’t receive any emails related to WDC feedback, goals, or coaching even if they’re signed up for individual emails."
|
|
773
|
+
},
|
|
774
|
+
"UserPreferencesDisProfPostCommentEmail": {
|
|
775
|
+
"type": "string",
|
|
776
|
+
"description": "When false , the user automatically receives email every time someone comments on posts on the user’s profile. This field is available in API version 24.0 and later."
|
|
777
|
+
},
|
|
778
|
+
"UserPreferencesEnableVoiceCallRecording": {
|
|
779
|
+
"type": "string",
|
|
780
|
+
"description": "When true , voice call recording is enabled for the user."
|
|
781
|
+
},
|
|
782
|
+
"UserPreferencesEnableVoiceLocalPresence": {
|
|
783
|
+
"type": "string",
|
|
784
|
+
"description": "When true , local numbers are shown when the user calls customers with Sales Dialer."
|
|
785
|
+
},
|
|
786
|
+
"UserPreferencesEventRemindersCheckboxDefault": {
|
|
787
|
+
"type": "string",
|
|
788
|
+
"description": "When true , a reminder popup is automatically set on the user's events. Corresponds to the By default, set reminder on Events to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders."
|
|
789
|
+
},
|
|
790
|
+
"UserPreferencesHideBiggerPhotoCallout": {
|
|
791
|
+
"type": "string",
|
|
792
|
+
"description": "When true , users can choose to hide the callout text below the large profile photo."
|
|
793
|
+
},
|
|
794
|
+
"UserPreferencesHideChatterOnboardingSplash": {
|
|
795
|
+
"type": "string",
|
|
796
|
+
"description": "When true , the initial Chatter onboarding prompts don’t appear."
|
|
797
|
+
},
|
|
798
|
+
"UserPreferencesHideCSNDesktopTask": {
|
|
799
|
+
"type": "string",
|
|
800
|
+
"description": "When true , the Chatter recommendations panel never displays the recommendation to install Chatter Desktop. This field is available in API version 26.0 and later."
|
|
801
|
+
},
|
|
802
|
+
"UserPreferencesHideCSNGetChatterMobileTask": {
|
|
803
|
+
"type": "string",
|
|
804
|
+
"description": "When true , the Chatter recommendations panel never displays the recommendation to install Chatter Mobile. This field is available in API version 26.0 and later."
|
|
805
|
+
},
|
|
806
|
+
"UserPreferencesHideEndUserOnboardingAssistantModal": {
|
|
807
|
+
"type": "string",
|
|
808
|
+
"description": "Reserved for future use."
|
|
809
|
+
},
|
|
810
|
+
"UserPreferencesHideLightningMigrationModal": {
|
|
811
|
+
"type": "string",
|
|
812
|
+
"description": "Reserved for future use."
|
|
813
|
+
},
|
|
814
|
+
"UserPreferencesHideSecondChatterOnboardingSplash": {
|
|
815
|
+
"type": "string",
|
|
816
|
+
"description": "When true , the secondary Chatter onboarding prompts don’t appear."
|
|
817
|
+
},
|
|
818
|
+
"UserPreferencesHideS1BrowserUI": {
|
|
819
|
+
"type": "string",
|
|
820
|
+
"description": "Controls the interface that the user sees when logging in to Salesforce from a supported mobile browser. If false , the user is automatically redirected to the Salesforce mobile web. If true , the user sees the full Salesforce site. The default value is false . Label is Salesforce User . This field is available in API version 29.0 or later."
|
|
821
|
+
},
|
|
822
|
+
"UserPreferencesHideSfxWelcomeMat": {
|
|
823
|
+
"type": "string",
|
|
824
|
+
"description": "Controls whether a user sees the Lightning Experience new user message. That message welcomes users to the new interface and provides step-by-step instructions that describe how to return to Salesforce Classic."
|
|
825
|
+
},
|
|
826
|
+
"UserPreferencesJigsawListUser": {
|
|
827
|
+
"type": "string",
|
|
828
|
+
"description": "When true , the user is a Data.com List user so shares record additions from a pool. UserPermissionsJigsawProspectingUser must also be set to true . Label is Data.com List User . This field is available in API version 27.0 and later."
|
|
829
|
+
},
|
|
830
|
+
"UserPreferencesLightningExperiencePreferred": {
|
|
831
|
+
"type": "string",
|
|
832
|
+
"description": "When true , redirects the user to the Lightning Experience interface. Label is Switch to Lightning Experience . This field is available in API version 35.0 and later."
|
|
833
|
+
},
|
|
834
|
+
"UserPreferencesLiveAgentMiawSetupDeflection": {
|
|
835
|
+
"type": "string",
|
|
836
|
+
"description": "When true , disables the pop-up to deflect users on Chat setup nodes to the Messaging setup. The default value is false . This field is available in API version 59.0 and later."
|
|
837
|
+
},
|
|
838
|
+
"UserPreferencesNativeEmailClient": {
|
|
839
|
+
"type": "string",
|
|
840
|
+
"description": "Use this field to set a default email preference for the user’s native email client. This field is available in API version 47.0 and later. The default value is false , corresponding to the Salesforce docked email composer."
|
|
841
|
+
},
|
|
842
|
+
"UserPreferencesOptOutOfTouch": {
|
|
843
|
+
"type": "string",
|
|
844
|
+
"description": "This field is deprecated in API version 29.0. When false , the user automatically accesses the Salesforce Touch app when logging in to Salesforce from an iPad. If true , automatic access to the Salesforce Touch app is turned off and the user’s iPad is directed to the full Salesforce site instead. The default value is false . Note Salesforce Touch must be enabled before this field is visible."
|
|
845
|
+
},
|
|
846
|
+
"UserPreferencesOutboundBridge": {
|
|
847
|
+
"type": "string",
|
|
848
|
+
"description": "When true , outbound calls are made through the user’s phone."
|
|
849
|
+
},
|
|
850
|
+
"UserPreferencesPathAssistantCollapsed": {
|
|
851
|
+
"type": "string",
|
|
852
|
+
"description": "When true , Sales Path appears collapsed or hidden to the user. This field is available in API version 35.0 and later."
|
|
853
|
+
},
|
|
854
|
+
"UserPreferencesProcessAssistantCollapsed": {
|
|
855
|
+
"type": "string",
|
|
856
|
+
"description": "When true , Sales Path appears collapsed or hidden to the user. This field is available in API versions 33.0 and 34.0 only. In API versions 35.0 and later, use UserPreferencesPathAssistantCollapsed ."
|
|
857
|
+
},
|
|
858
|
+
"UserPreferencesReceiveNoNotificationsAsApprover": {
|
|
859
|
+
"type": "string",
|
|
860
|
+
"description": "Controls email notifications from the approval process for approvers . If true , emails are disabled . If false , emails are enabled . The default value is false . Note The Receive Approval Request Emails setting in the UI controls this field and the UserPreferencesReceiveNotificationsAsDelegatedApprover field. Setting: If I’m an approver or delegated approver Result: UserPreferencesReceiveNoNotificationsAsApprover = false UserPreferencesReceiveNotificationsAsDelegatedApprover = true Setting: Only if I’m an approver Result: UserPreferencesReceiveNoNotificationsAsApprover = false UserPreferencesReceiveNotificationsAsDelegatedApprover = false Setting: Only if I’m a delegated approver Result: UserPreferencesReceiveNoNotificationsAsApprover = true UserPreferencesReceiveNotificationsAsDelegatedApprover = true Setting: Never Result: UserPreferencesReceiveNoNotificationsAsApprover = true UserPreferencesReceiveNotificationsAsDelegatedApprover = false"
|
|
861
|
+
},
|
|
862
|
+
"UserPreferencesReceiveNotificationsAsDelegatedApprover": {
|
|
863
|
+
"type": "string",
|
|
864
|
+
"description": "Controls email notifications from the approval process for delegated approvers . If true , emails are enabled . If false , emails are disabled . The default value is false . Note The Receive Approval Request Emails setting in the UI controls this field and the UserPreferencesReceiveNoNotificationsAsApprover field. Setting: If I’m an approver or delegated approver Result: UserPreferencesReceiveNoNotificationsAsApprover = false UserPreferencesReceiveNotificationsAsDelegatedApprover = true Setting: Only if I’m an approver Result: UserPreferencesReceiveNoNotificationsAsApprover = false UserPreferencesReceiveNotificationsAsDelegatedApprover = false Setting: Only if I’m a delegated approver Result: UserPreferencesReceiveNoNotificationsAsApprover = true UserPreferencesReceiveNotificationsAsDelegatedApprover = true Setting: Never Result: UserPreferencesReceiveNoNotificationsAsApprover = true UserPreferencesReceiveNotificationsAsDelegatedApprover = false"
|
|
865
|
+
},
|
|
866
|
+
"UserPreferencesReminderSoundOff": {
|
|
867
|
+
"type": "string",
|
|
868
|
+
"description": "When true , a sound automatically plays when an activity reminder is due. Corresponds to the Play a reminder sound checkbox on the Reminders page in the user interface."
|
|
869
|
+
},
|
|
870
|
+
"UserPreferencesShowCityToExternalUsers": {
|
|
871
|
+
"type": "string",
|
|
872
|
+
"description": "Indicates the visibility of the city field in the user’s contact information. City is visible only to internal members of the user’s organization when: This field is false . When false , this field returns the value #N/A . City is visible to external members in an Experience Cloud site when: This field is true , or This field is false but UserPreferencesShowCityToGuestUsers is true , which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false . This field is available in API version 26.0 and later."
|
|
873
|
+
},
|
|
874
|
+
"UserPreferencesShowCityToGuestUsers": {
|
|
875
|
+
"type": "string",
|
|
876
|
+
"description": "Indicates the visibility of the city field in the user’s contact information. When true , city is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false , this field returns the value #N/A . When true , this field overrides the value false in UserPreferencesShowCityToExternalUsers , making the user’s city visible to external members. The default value is false . This field is available in API version 28.0 and later."
|
|
877
|
+
},
|
|
878
|
+
"UserPreferencesShowCountryToExternalUsers": {
|
|
879
|
+
"type": "string",
|
|
880
|
+
"description": "Indicates the visibility of the country field in the user’s contact information. Country is visible only to internal members of the user’s organization when: This field is false . When false , this field returns the value #N/A . Country is visible to external members in an Experience Cloud site when: This field is true , or This field is false but UserPreferencesShowCountryToGuestUsers is true , which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false . This field is available in API version 26.0 and later."
|
|
881
|
+
},
|
|
882
|
+
"UserPreferencesShowCountryToGuestUsers": {
|
|
883
|
+
"type": "string",
|
|
884
|
+
"description": "Indicates the visibility of the country field in the user’s contact information. When true , country is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false , this field returns the value #N/A . When true , this field overrides the value false in UserPreferencesShowCountryToExternalUsers , making the user’s country visible to external members. The default value is false . This field is available in API version 28.0 and later."
|
|
885
|
+
},
|
|
886
|
+
"UserPreferencesShowEmailToExternalUsers": {
|
|
887
|
+
"type": "string",
|
|
888
|
+
"description": "Indicates the visibility of the email address field in the user’s contact information. Email address is visible only to internal members of the user’s organization when this field is false . Email address is visible to external members in an Experience Cloud site when this field is true . External users are users with Community, Customer Portal, or partner portal licenses. When false , this field returns the value #N/A . The default value is false . This field is available in API version 26.0 and later."
|
|
889
|
+
},
|
|
890
|
+
"UserPreferencesShowEmailToGuestUsers": {
|
|
891
|
+
"type": "string",
|
|
892
|
+
"description": "Indicates the visibility of the email address field in the user’s contact information. When true , the email address is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true , this field overrides the value false in UserPreferencesShowEmailToExternalUsers , making the user’s email address visible to guests. When false , this field returns the value #N/A . The default value is false . This field is available in API version 34.0 and later."
|
|
893
|
+
},
|
|
894
|
+
"UserPreferencesShowFaxToExternalUsers": {
|
|
895
|
+
"type": "string",
|
|
896
|
+
"description": "Indicates the visibility of the fax number field in the user’s contact information. Fax number is visible only to internal members of the user’s organization when this field is false . Fax number is visible to external members in an Experience Cloud site when this field is true . External users are users with Community, Customer Portal, or partner portal licenses. When false , this field returns the value #N/A . The default value is false . This field is available in API version 26.0 and later."
|
|
897
|
+
},
|
|
898
|
+
"UserPreferencesShowFaxToGuestUsers": {
|
|
899
|
+
"type": "string",
|
|
900
|
+
"description": "Indicates the visibility of the fax number field in the user’s contact information. When true , the fax number field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true , this field overrides the value false in UserPreferencesShowFaxToExternalUsers , making the user’s fax number visible to guests. When false , this field returns the value #N/A . The default value is false . This field is available in API version 34.0 and later."
|
|
901
|
+
},
|
|
902
|
+
"UserPreferencesShowManagerToExternalUsers": {
|
|
903
|
+
"type": "string",
|
|
904
|
+
"description": "Indicates the visibility of the manager field in the user’s contact information. Manager is visible only to internal members of the user’s organization when this field is false . Manager is visible to external members in an Experience Cloud site when this field is true . External users are users with Community, Customer Portal, or partner portal licenses. When false , this field returns the value #N/A . The default value is false . This field is available in API version 26.0 and later."
|
|
905
|
+
},
|
|
906
|
+
"UserPreferencesShowManagerToGuestUsers": {
|
|
907
|
+
"type": "string",
|
|
908
|
+
"description": "Indicates the visibility of the manager field in the user’s contact information. When true , the manager field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true , this field overrides the value false in UserPreferencesShowManagerToExternalUsers , making the user’s manager visible to guests. When false , this field returns the value #N/A . The default value is false . This field is available in API version 34.0 and later."
|
|
909
|
+
},
|
|
910
|
+
"UserPreferencesShowMobilePhoneToExternalUsers": {
|
|
911
|
+
"type": "string",
|
|
912
|
+
"description": "Indicates the visibility of the mobile device number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false . The number is visible to external members in an Experience Cloud site when this field is true . External users are users with Community, Customer Portal, or partner portal licenses. When false , this field returns the value #N/A . The default value is false . This field is available in API version 26.0 and later."
|
|
913
|
+
},
|
|
914
|
+
"UserPreferencesShowMobilePhoneToGuestUsers": {
|
|
915
|
+
"type": "string",
|
|
916
|
+
"description": "Indicates the visibility of the mobile phone field in the user’s contact information. When true , the mobile phone field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true , this field overrides the value false in UserPreferencesShowMobilePhoneToExternalUsers , making the user’s mobile phone visible to guests. When false , this field returns the value #N/A . The default value is false . This field is available in API version 34.0 and later."
|
|
917
|
+
},
|
|
918
|
+
"UserPreferencesShowPostalCodeToExternalUsers": {
|
|
919
|
+
"type": "string",
|
|
920
|
+
"description": "Indicates the visibility of the postal or ZIP code field in the user’s contact information. Postal code is visible only to internal members of the user’s organization when: This field is false . When false , this field returns the value #N/A . Postal code is visible to external members in an Experience Cloud site when: This field is true , or This field is false but UserPreferencesShowPostalCodeToGuestUsers is true , which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is false . This field is available in API version 26.0 and later."
|
|
921
|
+
},
|
|
922
|
+
"UserPreferencesShowPostalCodeToGuestUsers": {
|
|
923
|
+
"type": "string",
|
|
924
|
+
"description": "Indicates the visibility of the postal or ZIP code field in the user’s contact information. When true , postal code is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false , this field returns the value #N/A . When true , this field overrides the value false in UserPreferencesShowPostalCodeToExternalUsers , making the user’s postal code visible to external members. The default value is false . This field is available in API version 28.0 and later."
|
|
925
|
+
},
|
|
926
|
+
"UserPreferencesShowProfilePicToGuestUsers": {
|
|
927
|
+
"type": "string",
|
|
928
|
+
"description": "Indicates the visibility of the user’s profile photo. When true , the photo is visible to guest users in an Experience Cloud site. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false , this field returns the stock photo. The default value is false . This field is available in API version 28.0 and later."
|
|
929
|
+
},
|
|
930
|
+
"UserPreferencesShowStateToExternalUsers": {
|
|
931
|
+
"type": "string",
|
|
932
|
+
"description": "Indicates the visibility of the state field in the user’s contact information. State is visible only to internal members of the user’s organization when: This field is false . When false , this field returns the value #N/A . State is visible to external members in an Experience Cloud site when: This field is true , or This field is false but UserPreferencesShowStateToGuestUsers is true , which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. When false , this field returns the value #N/A . The default value is false . This field is available in API version 26.0 and later."
|
|
933
|
+
},
|
|
934
|
+
"UserPreferencesShowStateToGuestUsers": {
|
|
935
|
+
"type": "string",
|
|
936
|
+
"description": "Indicates the visibility of the state field in the user’s contact information. When true , state is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false , this field returns the value #N/A . When true , this field overrides the value false in UserPreferencesShowStateToExternalUsers, making the user’s state visible to external members. The default value is false . This field is available in API version 28.0 and later."
|
|
937
|
+
},
|
|
938
|
+
"UserPreferencesShowStreetAddressToExternalUsers": {
|
|
939
|
+
"type": "string",
|
|
940
|
+
"description": "Indicates the visibility of the street address field in the user’s contact information. The address is visible only to internal members of the user’s organization when this field is false . The address is visible to external members in an Experience Cloud site when this field is true . External users are users with Community, Customer Portal, or partner portal licenses. When false , this field returns the value #N/A . The default value is false . This field is available in API version 26.0 and later."
|
|
941
|
+
},
|
|
942
|
+
"UserPreferencesShowStreetAddressToGuestUsers": {
|
|
943
|
+
"type": "string",
|
|
944
|
+
"description": "Indicates the visibility of the street address field in the user’s contact information. When true , the street address field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true , this field overrides the value false in UserPreferencesShowStreetAddressToExternalUsers , making the user’s street address visible to guests. When false , this field returns the value #N/A . The default value is false . This field is available in API version 34.0 and later."
|
|
945
|
+
},
|
|
946
|
+
"UserPreferencesShowTitleToExternalUsers": {
|
|
947
|
+
"type": "string",
|
|
948
|
+
"description": "Indicates the visibility of the business title field in the user’s contact information. Title is visible only to internal members of the user’s organization when: This field is false . When false , this field returns the value #N/A . Title is visible to external members in an Experience Cloud site when: This field is true , or This field is false but UserPreferencesShowTitleToGuestUsers is true , which overrides this field’s value. External users are users with Community, Customer Portal, or partner portal licenses. The default value is true . This field is available in API version 26.0 and later."
|
|
949
|
+
},
|
|
950
|
+
"UserPreferencesShowTitleToGuestUsers": {
|
|
951
|
+
"type": "string",
|
|
952
|
+
"description": "Indicates the visibility of the business title field in the user’s contact information. When true , title is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When false , this field returns the value #N/A . When true , this field overrides the value false in UserPreferencesShowTitleToExternalUsers, making the user’s title visible to external members. The default value is false . This field is available in API version 28.0 and later."
|
|
953
|
+
},
|
|
954
|
+
"UserPreferencesShowWorkPhoneToExternalUsers": {
|
|
955
|
+
"type": "string",
|
|
956
|
+
"description": "Indicates the visibility of the work phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false . The number is visible to external members in an Experience Cloud site when this field is true . External users are users with Community, Customer Portal, or partner portal licenses. When false , this field returns the value #N/A . The default value is false . This field is available in API version 26.0 and later."
|
|
957
|
+
},
|
|
958
|
+
"UserPreferencesShowWorkPhoneToGuestUsers": {
|
|
959
|
+
"type": "string",
|
|
960
|
+
"description": "Indicates the visibility of the work phone field in the user’s contact information. When true , the work phone field is visible to guest users. Guest users can access public Site.com and Salesforce sites, and public pages in Experience Cloud sites, via the Guest User license associated with each site. When true , this field overrides the value false in UserPreferencesShowWorkPhoneToExternalUsers , making the user’s work phone visible to guests. When false , this field returns the value #N/A . The default value is false . This field is available in API version 34.0 and later."
|
|
961
|
+
},
|
|
962
|
+
"UserPreferencesSortFeedByComment": {
|
|
963
|
+
"type": "string",
|
|
964
|
+
"description": "Specifies the data value used in sorting a user’s feed. When true , the feed is sorted by most recent comment activity. When false , the feed is sorted by post date."
|
|
965
|
+
},
|
|
966
|
+
"UserPreferencesSuppressEventSFXReminders": {
|
|
967
|
+
"type": "string",
|
|
968
|
+
"description": "When true , event reminders don’t appear. Corresponds to the Show event reminders in Lightning Experience checkbox on the Activity Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders."
|
|
969
|
+
},
|
|
970
|
+
"UserPreferencesSuppressTaskSFXReminders": {
|
|
971
|
+
"type": "string",
|
|
972
|
+
"description": "When true , task reminders don’t appear. Corresponds to the Show task reminders in Lightning Experience . checkbox on the Activity Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders."
|
|
973
|
+
},
|
|
974
|
+
"UserPreferencesTaskRemindersCheckboxDefault": {
|
|
975
|
+
"type": "string",
|
|
976
|
+
"description": "When true , a reminder popup is automatically set on the user's tasks. Corresponds to the By default, set reminder on Tasks to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders."
|
|
977
|
+
},
|
|
978
|
+
"UserPreferencesUserDebugModePref": {
|
|
979
|
+
"type": "string",
|
|
980
|
+
"description": "When true , the Lightning Component framework executes in debug mode for the user. Corresponds to the Debug Mode checkbox on the Advanced User Details page of personal settings in the user interface."
|
|
981
|
+
},
|
|
982
|
+
"UserRoleId": {
|
|
983
|
+
"$ref": "#/$defs/NullableId",
|
|
984
|
+
"description": "ID of the user’s UserRole. Label is Role ID ."
|
|
985
|
+
},
|
|
986
|
+
"UserType": {
|
|
987
|
+
"type": [
|
|
988
|
+
"string",
|
|
989
|
+
"null"
|
|
990
|
+
],
|
|
991
|
+
"description": "The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. In API version 10.0 and later, valid values include: Standard: user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses. Label is Standard . PowerPartner: User whose access is limited because they’re a partner and typically access the application through a partner portal or Experience Cloud site. Label is Partner . CspLitePortal: user whose access is limited because they’re an org's customer and access the application through a Customer Portal or Experience Cloud site. Label is High Volume Portal . CustomerSuccess: user whose access is limited because they’re an org's customer and access the application through a Customer Portal. Label is Customer Portal User . PowerCustomerSuccess: user whose access is limited because they’re an org's customer and access the application through a Customer Portal. Label is Customer Portal Manager . Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy. CsnOnly: user whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. Label is Chatter Free . Guest: user whose access is limited because they’re an unauthenticated user without login credentials. Label is Guest .",
|
|
992
|
+
"readOnly": true
|
|
993
|
+
},
|
|
994
|
+
"WirelessEmail": {
|
|
995
|
+
"type": [
|
|
996
|
+
"string",
|
|
997
|
+
"null"
|
|
998
|
+
],
|
|
999
|
+
"description": "Wireless email address associated with this user. For use with Salesforce Wireless Edition. This field is available only if the Wireless and Email permissions are enabled for your organization. As of November 2005, Salesforce Wireless Edition is no longer available for purchase. You can continue to use Wireless Edition through the end of your existing contract term if you are: A Professional Edition customer and purchased Wireless Edition before November 7, 2005. An Enterprise Edition customer who signed or renewed their Salesforce contract before November 7, 2005."
|
|
1000
|
+
}
|
|
1001
|
+
},
|
|
1002
|
+
"required": [
|
|
1003
|
+
"Id"
|
|
1004
|
+
],
|
|
1005
|
+
"additionalProperties": false
|
|
1006
|
+
},
|
|
1007
|
+
"Account": {
|
|
1008
|
+
"type": "object",
|
|
1009
|
+
"description": "Account fields documented by the pinned Winter 27 Object Reference. Properties are the union of documented read/create forms; only Id is universally required by this stored entity so SOQL projections remain ingestible.",
|
|
1010
|
+
"properties": {
|
|
1011
|
+
"Id": {
|
|
1012
|
+
"$ref": "base.json#/$defs/Id",
|
|
1013
|
+
"description": "Unique Salesforce record identifier.",
|
|
1014
|
+
"readOnly": true
|
|
1015
|
+
},
|
|
1016
|
+
"AccountNumber": {
|
|
1017
|
+
"type": [
|
|
1018
|
+
"string",
|
|
1019
|
+
"null"
|
|
1020
|
+
],
|
|
1021
|
+
"maxLength": 40,
|
|
1022
|
+
"description": "Account number assigned to this account (not the unique, system-generated ID assigned during creation). Maximum size is 40 characters."
|
|
1023
|
+
},
|
|
1024
|
+
"AccountSource": {
|
|
1025
|
+
"type": [
|
|
1026
|
+
"string",
|
|
1027
|
+
"null"
|
|
1028
|
+
],
|
|
1029
|
+
"description": "The source of the account record. For example, Advertisement 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."
|
|
1030
|
+
},
|
|
1031
|
+
"ActivityMetricId": {
|
|
1032
|
+
"$ref": "#/$defs/NullableId",
|
|
1033
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric.",
|
|
1034
|
+
"readOnly": true
|
|
1035
|
+
},
|
|
1036
|
+
"ActivityMetricRollupId": {
|
|
1037
|
+
"$ref": "#/$defs/NullableId",
|
|
1038
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup.",
|
|
1039
|
+
"readOnly": true
|
|
1040
|
+
},
|
|
1041
|
+
"AnnualRevenue": {
|
|
1042
|
+
"type": [
|
|
1043
|
+
"number",
|
|
1044
|
+
"null"
|
|
1045
|
+
],
|
|
1046
|
+
"description": "Estimated annual revenue of the account."
|
|
1047
|
+
},
|
|
1048
|
+
"BillingAddress": {
|
|
1049
|
+
"anyOf": [
|
|
1050
|
+
{
|
|
1051
|
+
"$ref": "#/$defs/Address"
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"type": "null"
|
|
1055
|
+
}
|
|
1056
|
+
],
|
|
1057
|
+
"description": "The compound form of the billing address. Read-only. For details on compound address fields, see Address Compound Fields .",
|
|
1058
|
+
"readOnly": true
|
|
1059
|
+
},
|
|
1060
|
+
"BillingCity": {
|
|
1061
|
+
"type": [
|
|
1062
|
+
"string",
|
|
1063
|
+
"null"
|
|
1064
|
+
],
|
|
1065
|
+
"maxLength": 40,
|
|
1066
|
+
"description": "Details for the billing address of this account. Maximum size is 40 characters."
|
|
1067
|
+
},
|
|
1068
|
+
"BillingCountry": {
|
|
1069
|
+
"type": [
|
|
1070
|
+
"string",
|
|
1071
|
+
"null"
|
|
1072
|
+
],
|
|
1073
|
+
"maxLength": 80,
|
|
1074
|
+
"description": "Details for the billing address of this account. Maximum size is 80 characters."
|
|
1075
|
+
},
|
|
1076
|
+
"BillingCountryCode": {
|
|
1077
|
+
"type": [
|
|
1078
|
+
"string",
|
|
1079
|
+
"null"
|
|
1080
|
+
],
|
|
1081
|
+
"description": "The ISO country code for the account’s billing address."
|
|
1082
|
+
},
|
|
1083
|
+
"BillingGeocodeAccuracy": {
|
|
1084
|
+
"type": [
|
|
1085
|
+
"string",
|
|
1086
|
+
"null"
|
|
1087
|
+
],
|
|
1088
|
+
"description": "Accuracy level of the geocode for the billing address. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1089
|
+
},
|
|
1090
|
+
"BillingLatitude": {
|
|
1091
|
+
"type": [
|
|
1092
|
+
"number",
|
|
1093
|
+
"null"
|
|
1094
|
+
],
|
|
1095
|
+
"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. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1096
|
+
},
|
|
1097
|
+
"BillingLongitude": {
|
|
1098
|
+
"type": [
|
|
1099
|
+
"number",
|
|
1100
|
+
"null"
|
|
1101
|
+
],
|
|
1102
|
+
"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."
|
|
1103
|
+
},
|
|
1104
|
+
"BillingPostalCode": {
|
|
1105
|
+
"type": [
|
|
1106
|
+
"string",
|
|
1107
|
+
"null"
|
|
1108
|
+
],
|
|
1109
|
+
"maxLength": 20,
|
|
1110
|
+
"description": "Details for the billing address of this account. Maximum size is 20 characters."
|
|
1111
|
+
},
|
|
1112
|
+
"BillingState": {
|
|
1113
|
+
"type": [
|
|
1114
|
+
"string",
|
|
1115
|
+
"null"
|
|
1116
|
+
],
|
|
1117
|
+
"maxLength": 80,
|
|
1118
|
+
"description": "Details for the billing address of this account. Maximum size is 80 characters."
|
|
1119
|
+
},
|
|
1120
|
+
"BillingStateCode": {
|
|
1121
|
+
"type": [
|
|
1122
|
+
"string",
|
|
1123
|
+
"null"
|
|
1124
|
+
],
|
|
1125
|
+
"description": "The ISO state code for the account’s billing address."
|
|
1126
|
+
},
|
|
1127
|
+
"BillingStreet": {
|
|
1128
|
+
"type": [
|
|
1129
|
+
"string",
|
|
1130
|
+
"null"
|
|
1131
|
+
],
|
|
1132
|
+
"description": "Street address for the billing address of this account."
|
|
1133
|
+
},
|
|
1134
|
+
"ChannelProgramLevelName": {
|
|
1135
|
+
"type": [
|
|
1136
|
+
"string",
|
|
1137
|
+
"null"
|
|
1138
|
+
],
|
|
1139
|
+
"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 is displayed.",
|
|
1140
|
+
"readOnly": true
|
|
1141
|
+
},
|
|
1142
|
+
"ChannelProgramName": {
|
|
1143
|
+
"type": [
|
|
1144
|
+
"string",
|
|
1145
|
+
"null"
|
|
1146
|
+
],
|
|
1147
|
+
"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 is displayed.",
|
|
1148
|
+
"readOnly": true
|
|
1149
|
+
},
|
|
1150
|
+
"CleanStatus": {
|
|
1151
|
+
"anyOf": [
|
|
1152
|
+
{
|
|
1153
|
+
"type": "string",
|
|
1154
|
+
"enum": [
|
|
1155
|
+
"Acknowledged",
|
|
1156
|
+
"Different",
|
|
1157
|
+
"Inactive",
|
|
1158
|
+
"Matched",
|
|
1159
|
+
"NotFound",
|
|
1160
|
+
"Pending",
|
|
1161
|
+
"SelectMatch",
|
|
1162
|
+
"Skipped"
|
|
1163
|
+
]
|
|
1164
|
+
},
|
|
1165
|
+
{
|
|
1166
|
+
"type": "null"
|
|
1167
|
+
}
|
|
1168
|
+
],
|
|
1169
|
+
"description": "Indicates the record’s clean status as compared with Data.com. ."
|
|
1170
|
+
},
|
|
1171
|
+
"CommerceCustomerReference": {
|
|
1172
|
+
"type": [
|
|
1173
|
+
"string",
|
|
1174
|
+
"null"
|
|
1175
|
+
],
|
|
1176
|
+
"description": "The external Commerce ID of the individual. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.",
|
|
1177
|
+
"readOnly": true
|
|
1178
|
+
},
|
|
1179
|
+
"CommerceGroupReference": {
|
|
1180
|
+
"type": [
|
|
1181
|
+
"string",
|
|
1182
|
+
"null"
|
|
1183
|
+
],
|
|
1184
|
+
"description": "The external name of the Commerce customer group. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.",
|
|
1185
|
+
"readOnly": true
|
|
1186
|
+
},
|
|
1187
|
+
"CommerceOrganizationReference": {
|
|
1188
|
+
"type": [
|
|
1189
|
+
"string",
|
|
1190
|
+
"null"
|
|
1191
|
+
],
|
|
1192
|
+
"description": "The external organization ID of the Commerce instance. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.",
|
|
1193
|
+
"readOnly": true
|
|
1194
|
+
},
|
|
1195
|
+
"ConnectionReceivedId": {
|
|
1196
|
+
"$ref": "#/$defs/NullableId",
|
|
1197
|
+
"description": "ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.",
|
|
1198
|
+
"readOnly": true
|
|
1199
|
+
},
|
|
1200
|
+
"ConnectionSentId": {
|
|
1201
|
+
"$ref": "#/$defs/NullableId",
|
|
1202
|
+
"description": "ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.",
|
|
1203
|
+
"readOnly": true
|
|
1204
|
+
},
|
|
1205
|
+
"Description": {
|
|
1206
|
+
"type": [
|
|
1207
|
+
"string",
|
|
1208
|
+
"null"
|
|
1209
|
+
],
|
|
1210
|
+
"description": "Text description of the account. Limited to 32,000 KB."
|
|
1211
|
+
},
|
|
1212
|
+
"DunsNumber": {
|
|
1213
|
+
"type": [
|
|
1214
|
+
"string",
|
|
1215
|
+
"null"
|
|
1216
|
+
],
|
|
1217
|
+
"maxLength": 9,
|
|
1218
|
+
"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. Note This field is only available to organizations that use Data.com Prospector or Data.com Clean."
|
|
1219
|
+
},
|
|
1220
|
+
"Fax": {
|
|
1221
|
+
"type": [
|
|
1222
|
+
"string",
|
|
1223
|
+
"null"
|
|
1224
|
+
],
|
|
1225
|
+
"description": "Fax number for the account."
|
|
1226
|
+
},
|
|
1227
|
+
"Industry": {
|
|
1228
|
+
"type": [
|
|
1229
|
+
"string",
|
|
1230
|
+
"null"
|
|
1231
|
+
],
|
|
1232
|
+
"maxLength": 40,
|
|
1233
|
+
"description": "An industry associated with this account. For example, Biotechnology . Maximum size is 40 characters."
|
|
1234
|
+
},
|
|
1235
|
+
"IsBuyer": {
|
|
1236
|
+
"type": "string",
|
|
1237
|
+
"description": "Indicates that the account is enabled as a buyer for Lightning B2B Commerce. The default value is false . This field is available in API version 48.0 and later. Note This field is only available to organizations that have the B2B Commerce license enabled.",
|
|
1238
|
+
"readOnly": true
|
|
1239
|
+
},
|
|
1240
|
+
"IsCustomerPortal": {
|
|
1241
|
+
"type": "string",
|
|
1242
|
+
"description": "Indicates whether the account has at least one contact enabled to use the org's Experience Cloud site or Customer Portal ( true ) or not ( false ). This field is available if Customer Portal is enabled OR digital experiences is enabled. If your org is enabled to use Content Security Policy (CSP) features, then this field is visible on the Account object even if those features are later disabled. If you change this field's value from true to false , you can disable up to 100 Experience Cloud site or Customer Portal users associated with the account and permanently delete all of the account's site roles and groups. You can't restore deleted site roles and groups. Exclude this field when merging accounts. This field can be updated in API version 16.0 and later. Tip We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for an Experience Cloud site. We also recommend that you make this update after business hours."
|
|
1243
|
+
},
|
|
1244
|
+
"IsPartner": {
|
|
1245
|
+
"type": "string",
|
|
1246
|
+
"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 OR digital 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 doesn’t 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. Exclude this field when merging accounts. This field can be updated in API version 16.0 and later. Tip We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for an Experience Cloud site. We also recommend that you make this update after business hours."
|
|
1247
|
+
},
|
|
1248
|
+
"IsPersonAccount": {
|
|
1249
|
+
"type": "string",
|
|
1250
|
+
"description": "Read only. Label is Is Person Account . Indicates whether this account has a record type of Person Account ( true ) or not ( false ).",
|
|
1251
|
+
"readOnly": true
|
|
1252
|
+
},
|
|
1253
|
+
"IsPriorityRecord": {
|
|
1254
|
+
"type": "string",
|
|
1255
|
+
"description": "Shows whether the user has marked the account as important ( True ) or not ( False ). The default value is false . Available in API version 60.0 and later.",
|
|
1256
|
+
"readOnly": true
|
|
1257
|
+
},
|
|
1258
|
+
"Jigsaw": {
|
|
1259
|
+
"type": [
|
|
1260
|
+
"string",
|
|
1261
|
+
"null"
|
|
1262
|
+
],
|
|
1263
|
+
"maxLength": 20,
|
|
1264
|
+
"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. Important 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."
|
|
1265
|
+
},
|
|
1266
|
+
"JigsawCompanyId": {
|
|
1267
|
+
"type": [
|
|
1268
|
+
"string",
|
|
1269
|
+
"null"
|
|
1270
|
+
],
|
|
1271
|
+
"description": "The ID of the company in reference to Jigsaw . Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field.",
|
|
1272
|
+
"readOnly": true
|
|
1273
|
+
},
|
|
1274
|
+
"LastActivityDate": {
|
|
1275
|
+
"type": [
|
|
1276
|
+
"string",
|
|
1277
|
+
"null"
|
|
1278
|
+
],
|
|
1279
|
+
"minLength": 10,
|
|
1280
|
+
"maxLength": 10,
|
|
1281
|
+
"format": "date",
|
|
1282
|
+
"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.",
|
|
1283
|
+
"readOnly": true
|
|
1284
|
+
},
|
|
1285
|
+
"LastReferencedDate": {
|
|
1286
|
+
"anyOf": [
|
|
1287
|
+
{
|
|
1288
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
1289
|
+
},
|
|
1290
|
+
{
|
|
1291
|
+
"type": "null"
|
|
1292
|
+
}
|
|
1293
|
+
],
|
|
1294
|
+
"description": "The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.",
|
|
1295
|
+
"readOnly": true
|
|
1296
|
+
},
|
|
1297
|
+
"LastViewedDate": {
|
|
1298
|
+
"anyOf": [
|
|
1299
|
+
{
|
|
1300
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
1301
|
+
},
|
|
1302
|
+
{
|
|
1303
|
+
"type": "null"
|
|
1304
|
+
}
|
|
1305
|
+
],
|
|
1306
|
+
"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.",
|
|
1307
|
+
"readOnly": true
|
|
1308
|
+
},
|
|
1309
|
+
"MasterRecordId": {
|
|
1310
|
+
"$ref": "#/$defs/NullableId",
|
|
1311
|
+
"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 .",
|
|
1312
|
+
"readOnly": true
|
|
1313
|
+
},
|
|
1314
|
+
"NaicsCode": {
|
|
1315
|
+
"type": [
|
|
1316
|
+
"string",
|
|
1317
|
+
"null"
|
|
1318
|
+
],
|
|
1319
|
+
"maxLength": 8,
|
|
1320
|
+
"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. Note This field is only available to organizations that use Data.com Prospector or Data.com Clean."
|
|
1321
|
+
},
|
|
1322
|
+
"NaicsDesc": {
|
|
1323
|
+
"type": [
|
|
1324
|
+
"string",
|
|
1325
|
+
"null"
|
|
1326
|
+
],
|
|
1327
|
+
"maxLength": 120,
|
|
1328
|
+
"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. Note This field is only available to organizations that use Data.com Prospector or Data.com Clean."
|
|
1329
|
+
},
|
|
1330
|
+
"Name": {
|
|
1331
|
+
"type": "string",
|
|
1332
|
+
"maxLength": 255,
|
|
1333
|
+
"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."
|
|
1334
|
+
},
|
|
1335
|
+
"NumberOfEmployees": {
|
|
1336
|
+
"type": [
|
|
1337
|
+
"integer",
|
|
1338
|
+
"null"
|
|
1339
|
+
],
|
|
1340
|
+
"description": "Label is Employees . Number of employees working at the company represented by this account. Maximum size is eight digits."
|
|
1341
|
+
},
|
|
1342
|
+
"OperatingHoursId": {
|
|
1343
|
+
"$ref": "#/$defs/NullableId",
|
|
1344
|
+
"description": "The operating hours associated with the account. Available only if Field Service is enabled."
|
|
1345
|
+
},
|
|
1346
|
+
"OwnerId": {
|
|
1347
|
+
"$ref": "base.json#/$defs/Id",
|
|
1348
|
+
"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."
|
|
1349
|
+
},
|
|
1350
|
+
"Ownership": {
|
|
1351
|
+
"type": [
|
|
1352
|
+
"string",
|
|
1353
|
+
"null"
|
|
1354
|
+
],
|
|
1355
|
+
"description": "Ownership type for the account, for example Private, Public, or Subsidiary."
|
|
1356
|
+
},
|
|
1357
|
+
"ParentId": {
|
|
1358
|
+
"$ref": "#/$defs/NullableId",
|
|
1359
|
+
"description": "ID of the parent object, if any."
|
|
1360
|
+
},
|
|
1361
|
+
"PersonActionCadenceAssigneeId": {
|
|
1362
|
+
"$ref": "#/$defs/NullableId",
|
|
1363
|
+
"description": "The ID of the sales rep designated to work the lead through their assigned cadence. This field is available in API version 47.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1364
|
+
"readOnly": true
|
|
1365
|
+
},
|
|
1366
|
+
"PersonActionCadenceId": {
|
|
1367
|
+
"$ref": "#/$defs/NullableId",
|
|
1368
|
+
"description": "The ID of the lead’s assigned cadence. This field is available in API version 46.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1369
|
+
"readOnly": true
|
|
1370
|
+
},
|
|
1371
|
+
"PersonActionCadenceState": {
|
|
1372
|
+
"anyOf": [
|
|
1373
|
+
{
|
|
1374
|
+
"type": "string",
|
|
1375
|
+
"enum": [
|
|
1376
|
+
"Complete",
|
|
1377
|
+
"Error",
|
|
1378
|
+
"Initializing",
|
|
1379
|
+
"Paused",
|
|
1380
|
+
"Processing",
|
|
1381
|
+
"Running"
|
|
1382
|
+
]
|
|
1383
|
+
},
|
|
1384
|
+
{
|
|
1385
|
+
"type": "null"
|
|
1386
|
+
}
|
|
1387
|
+
],
|
|
1388
|
+
"description": "The state of the current action cadence tracker. This field is available in API version 50.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1389
|
+
"readOnly": true
|
|
1390
|
+
},
|
|
1391
|
+
"PersonIndividualId": {
|
|
1392
|
+
"$ref": "#/$defs/NullableId",
|
|
1393
|
+
"description": "ID of the data privacy record associated with this person’s account. This field is available if you enabled Data Protection and Privacy in Setup."
|
|
1394
|
+
},
|
|
1395
|
+
"PersonScheduledResumeDateTime": {
|
|
1396
|
+
"anyOf": [
|
|
1397
|
+
{
|
|
1398
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
1399
|
+
},
|
|
1400
|
+
{
|
|
1401
|
+
"type": "null"
|
|
1402
|
+
}
|
|
1403
|
+
],
|
|
1404
|
+
"description": "The date and time when the action cadence tracker is going to resume after it’s paused or on a wait step. This field is available in API version 54.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1405
|
+
"readOnly": true
|
|
1406
|
+
},
|
|
1407
|
+
"Phone": {
|
|
1408
|
+
"type": [
|
|
1409
|
+
"string",
|
|
1410
|
+
"null"
|
|
1411
|
+
],
|
|
1412
|
+
"maxLength": 40,
|
|
1413
|
+
"description": "Phone number for this account. Maximum size is 40 characters."
|
|
1414
|
+
},
|
|
1415
|
+
"PhotoUrl": {
|
|
1416
|
+
"type": [
|
|
1417
|
+
"string",
|
|
1418
|
+
"null"
|
|
1419
|
+
],
|
|
1420
|
+
"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.",
|
|
1421
|
+
"readOnly": true
|
|
1422
|
+
},
|
|
1423
|
+
"Rating": {
|
|
1424
|
+
"type": [
|
|
1425
|
+
"string",
|
|
1426
|
+
"null"
|
|
1427
|
+
],
|
|
1428
|
+
"description": "The account’s prospect rating, for example Hot, Warm, or Cold."
|
|
1429
|
+
},
|
|
1430
|
+
"RecordTypeId": {
|
|
1431
|
+
"$ref": "#/$defs/NullableId",
|
|
1432
|
+
"description": "ID of the record type assigned to this object."
|
|
1433
|
+
},
|
|
1434
|
+
"Salutation": {
|
|
1435
|
+
"type": [
|
|
1436
|
+
"string",
|
|
1437
|
+
"null"
|
|
1438
|
+
],
|
|
1439
|
+
"description": "Honorific added to the name for use in letters, etc. This field is available on person accounts."
|
|
1440
|
+
},
|
|
1441
|
+
"ShippingAddress": {
|
|
1442
|
+
"anyOf": [
|
|
1443
|
+
{
|
|
1444
|
+
"$ref": "#/$defs/Address"
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"type": "null"
|
|
1448
|
+
}
|
|
1449
|
+
],
|
|
1450
|
+
"description": "The compound form of the shipping address. Read-only. See Address Compound Fields for details on compound address fields.",
|
|
1451
|
+
"readOnly": true
|
|
1452
|
+
},
|
|
1453
|
+
"ShippingCity": {
|
|
1454
|
+
"type": [
|
|
1455
|
+
"string",
|
|
1456
|
+
"null"
|
|
1457
|
+
],
|
|
1458
|
+
"maxLength": 40,
|
|
1459
|
+
"description": "Details of the shipping address for this account. City maximum size is 40 characters"
|
|
1460
|
+
},
|
|
1461
|
+
"ShippingCountry": {
|
|
1462
|
+
"type": [
|
|
1463
|
+
"string",
|
|
1464
|
+
"null"
|
|
1465
|
+
],
|
|
1466
|
+
"maxLength": 80,
|
|
1467
|
+
"description": "Details of the shipping address for this account. Country maximum size is 80 characters."
|
|
1468
|
+
},
|
|
1469
|
+
"ShippingCountryCode": {
|
|
1470
|
+
"type": [
|
|
1471
|
+
"string",
|
|
1472
|
+
"null"
|
|
1473
|
+
],
|
|
1474
|
+
"description": "The ISO country code for the account’s shipping address."
|
|
1475
|
+
},
|
|
1476
|
+
"ShippingGeocodeAccuracy": {
|
|
1477
|
+
"type": [
|
|
1478
|
+
"string",
|
|
1479
|
+
"null"
|
|
1480
|
+
],
|
|
1481
|
+
"description": "Accuracy level of the geocode for the shipping address. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1482
|
+
},
|
|
1483
|
+
"ShippingLatitude": {
|
|
1484
|
+
"type": [
|
|
1485
|
+
"number",
|
|
1486
|
+
"null"
|
|
1487
|
+
],
|
|
1488
|
+
"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. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1489
|
+
},
|
|
1490
|
+
"ShippingLongitude": {
|
|
1491
|
+
"type": [
|
|
1492
|
+
"number",
|
|
1493
|
+
"null"
|
|
1494
|
+
],
|
|
1495
|
+
"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. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1496
|
+
},
|
|
1497
|
+
"ShippingPostalCode": {
|
|
1498
|
+
"type": [
|
|
1499
|
+
"string",
|
|
1500
|
+
"null"
|
|
1501
|
+
],
|
|
1502
|
+
"maxLength": 20,
|
|
1503
|
+
"description": "Details of the shipping address for this account. Postal code maximum size is 20 characters."
|
|
1504
|
+
},
|
|
1505
|
+
"ShippingState": {
|
|
1506
|
+
"type": [
|
|
1507
|
+
"string",
|
|
1508
|
+
"null"
|
|
1509
|
+
],
|
|
1510
|
+
"maxLength": 80,
|
|
1511
|
+
"description": "Details of the shipping address for this account. State maximum size is 80 characters."
|
|
1512
|
+
},
|
|
1513
|
+
"ShippingStateCode": {
|
|
1514
|
+
"type": [
|
|
1515
|
+
"string",
|
|
1516
|
+
"null"
|
|
1517
|
+
],
|
|
1518
|
+
"description": "The ISO state code for the account’s shipping address."
|
|
1519
|
+
},
|
|
1520
|
+
"ShippingStreet": {
|
|
1521
|
+
"type": [
|
|
1522
|
+
"string",
|
|
1523
|
+
"null"
|
|
1524
|
+
],
|
|
1525
|
+
"description": "The street address of the shipping address for this account. Maximum of 255 characters."
|
|
1526
|
+
},
|
|
1527
|
+
"Sic": {
|
|
1528
|
+
"type": [
|
|
1529
|
+
"string",
|
|
1530
|
+
"null"
|
|
1531
|
+
],
|
|
1532
|
+
"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."
|
|
1533
|
+
},
|
|
1534
|
+
"SicDesc": {
|
|
1535
|
+
"type": [
|
|
1536
|
+
"string",
|
|
1537
|
+
"null"
|
|
1538
|
+
],
|
|
1539
|
+
"maxLength": 80,
|
|
1540
|
+
"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."
|
|
1541
|
+
},
|
|
1542
|
+
"Site": {
|
|
1543
|
+
"type": [
|
|
1544
|
+
"string",
|
|
1545
|
+
"null"
|
|
1546
|
+
],
|
|
1547
|
+
"description": "Name of the account’s location, for example Headquarters or London . Label is Account Site . Maximum of 80 characters."
|
|
1548
|
+
},
|
|
1549
|
+
"TickerSymbol": {
|
|
1550
|
+
"type": [
|
|
1551
|
+
"string",
|
|
1552
|
+
"null"
|
|
1553
|
+
],
|
|
1554
|
+
"description": "The stock market symbol for this account. Maximum of 20 characters. This field is available on business accounts, not person accounts."
|
|
1555
|
+
},
|
|
1556
|
+
"Tradestyle": {
|
|
1557
|
+
"type": [
|
|
1558
|
+
"string",
|
|
1559
|
+
"null"
|
|
1560
|
+
],
|
|
1561
|
+
"maxLength": 255,
|
|
1562
|
+
"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. Note This field is only available to organizations that use Data.com Prospector or Data.com Clean."
|
|
1563
|
+
},
|
|
1564
|
+
"Type": {
|
|
1565
|
+
"type": [
|
|
1566
|
+
"string",
|
|
1567
|
+
"null"
|
|
1568
|
+
],
|
|
1569
|
+
"description": "Type of account, for example, Customer, Competitor, or Partner."
|
|
1570
|
+
},
|
|
1571
|
+
"Website": {
|
|
1572
|
+
"type": [
|
|
1573
|
+
"string",
|
|
1574
|
+
"null"
|
|
1575
|
+
],
|
|
1576
|
+
"description": "The website of this account. Maximum of 255 characters."
|
|
1577
|
+
},
|
|
1578
|
+
"YearStarted": {
|
|
1579
|
+
"type": [
|
|
1580
|
+
"string",
|
|
1581
|
+
"null"
|
|
1582
|
+
],
|
|
1583
|
+
"maxLength": 4,
|
|
1584
|
+
"description": "The date when an org was legally established. Maximum length is 4 characters. This field is available on business accounts, not person accounts. Note This field is only available to organizations that use Data.com Prospector or Data.com Clean."
|
|
1585
|
+
},
|
|
1586
|
+
"FirstName": {
|
|
1587
|
+
"type": [
|
|
1588
|
+
"string",
|
|
1589
|
+
"null"
|
|
1590
|
+
],
|
|
1591
|
+
"maxLength": 40,
|
|
1592
|
+
"description": "First name of the person for a person account. Maximum size is 40 characters."
|
|
1593
|
+
},
|
|
1594
|
+
"LastName": {
|
|
1595
|
+
"type": [
|
|
1596
|
+
"string",
|
|
1597
|
+
"null"
|
|
1598
|
+
],
|
|
1599
|
+
"maxLength": 80,
|
|
1600
|
+
"description": "Last name of the person for a person account. Required if the record type is a person account record type. Maximum size is 80 characters."
|
|
1601
|
+
},
|
|
1602
|
+
"MiddleName": {
|
|
1603
|
+
"type": [
|
|
1604
|
+
"string",
|
|
1605
|
+
"null"
|
|
1606
|
+
],
|
|
1607
|
+
"maxLength": 40,
|
|
1608
|
+
"description": "Middle name of the person for a person account. Maximum size is 40 characters."
|
|
1609
|
+
},
|
|
1610
|
+
"PersonAssistantName": {
|
|
1611
|
+
"type": [
|
|
1612
|
+
"string",
|
|
1613
|
+
"null"
|
|
1614
|
+
],
|
|
1615
|
+
"maxLength": 40,
|
|
1616
|
+
"description": "The person account’s assistant name. Label is Assistant . Maximum size is 40 characters."
|
|
1617
|
+
},
|
|
1618
|
+
"PersonAssistantPhone": {
|
|
1619
|
+
"type": [
|
|
1620
|
+
"string",
|
|
1621
|
+
"null"
|
|
1622
|
+
],
|
|
1623
|
+
"maxLength": 40,
|
|
1624
|
+
"description": "The person account’s assistant phone. Label is Asst. Phone . Maximum size is 40 characters."
|
|
1625
|
+
},
|
|
1626
|
+
"PersonBirthDate": {
|
|
1627
|
+
"type": [
|
|
1628
|
+
"string",
|
|
1629
|
+
"null"
|
|
1630
|
+
],
|
|
1631
|
+
"minLength": 10,
|
|
1632
|
+
"maxLength": 10,
|
|
1633
|
+
"format": "date",
|
|
1634
|
+
"description": "The birthday of the contact associated with this person account. Label is Birthdate . The year portion of the PersonBirthDate field is ignored in filter criteria, including report filters, list view filters, and SOQL queries. For example, the following SOQL query returns person accounts with birthdays later in the year than today: SELECT FirstName, LastName, PersonBirthDate FROM Account WHERE Birthdate > TODAY"
|
|
1635
|
+
},
|
|
1636
|
+
"PersonContactId": {
|
|
1637
|
+
"$ref": "#/$defs/NullableId",
|
|
1638
|
+
"description": "The ID for the contact associated with this person account. Label is Contact ID ."
|
|
1639
|
+
},
|
|
1640
|
+
"PersonDepartment": {
|
|
1641
|
+
"type": [
|
|
1642
|
+
"string",
|
|
1643
|
+
"null"
|
|
1644
|
+
],
|
|
1645
|
+
"maxLength": 80,
|
|
1646
|
+
"description": "The department. Label is Department . Maximum size is 80 characters."
|
|
1647
|
+
},
|
|
1648
|
+
"PersonEmail": {
|
|
1649
|
+
"type": [
|
|
1650
|
+
"string",
|
|
1651
|
+
"null"
|
|
1652
|
+
],
|
|
1653
|
+
"description": "Email address for this person account. Label is Email ."
|
|
1654
|
+
},
|
|
1655
|
+
"PersonEmailBouncedDate": {
|
|
1656
|
+
"anyOf": [
|
|
1657
|
+
{
|
|
1658
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
1659
|
+
},
|
|
1660
|
+
{
|
|
1661
|
+
"type": "null"
|
|
1662
|
+
}
|
|
1663
|
+
],
|
|
1664
|
+
"description": "If bounce management is activated and an email sent to the person account bounces, the date and time the bounce occurred."
|
|
1665
|
+
},
|
|
1666
|
+
"PersonEmailBouncedReason": {
|
|
1667
|
+
"type": [
|
|
1668
|
+
"string",
|
|
1669
|
+
"null"
|
|
1670
|
+
],
|
|
1671
|
+
"description": "If bounce management is activated and an email sent to the person account bounces, the reason the bounce occurred"
|
|
1672
|
+
},
|
|
1673
|
+
"PersonGenderIdentity": {
|
|
1674
|
+
"type": [
|
|
1675
|
+
"string",
|
|
1676
|
+
"null"
|
|
1677
|
+
],
|
|
1678
|
+
"description": "The person’s internal experience of their gender, which may or may not correspond to the person’s designated sex at birth. Label is Gender Identity ."
|
|
1679
|
+
},
|
|
1680
|
+
"PersonHasOptedOutOfEmail": {
|
|
1681
|
+
"type": [
|
|
1682
|
+
"string",
|
|
1683
|
+
"null"
|
|
1684
|
+
],
|
|
1685
|
+
"description": "Indicates whether the person account has opted out of email ( true ) or not ( false ). Label is Email Opt Out ."
|
|
1686
|
+
},
|
|
1687
|
+
"PersonHomePhone": {
|
|
1688
|
+
"type": [
|
|
1689
|
+
"string",
|
|
1690
|
+
"null"
|
|
1691
|
+
],
|
|
1692
|
+
"description": "The home phone number for this person account. Label is Home Phone ."
|
|
1693
|
+
},
|
|
1694
|
+
"PersonLeadSource": {
|
|
1695
|
+
"type": [
|
|
1696
|
+
"string",
|
|
1697
|
+
"null"
|
|
1698
|
+
],
|
|
1699
|
+
"description": "The person account’s lead source. Label is Lead Source ."
|
|
1700
|
+
},
|
|
1701
|
+
"PersonMailingAddress": {
|
|
1702
|
+
"anyOf": [
|
|
1703
|
+
{
|
|
1704
|
+
"$ref": "#/$defs/Address"
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"type": "null"
|
|
1708
|
+
}
|
|
1709
|
+
],
|
|
1710
|
+
"description": "The compound form of the person account mailing address. Read-only. For details on compound address fields, see Address Compound Fields .",
|
|
1711
|
+
"readOnly": true
|
|
1712
|
+
},
|
|
1713
|
+
"PersonMailingCity": {
|
|
1714
|
+
"type": [
|
|
1715
|
+
"string",
|
|
1716
|
+
"null"
|
|
1717
|
+
],
|
|
1718
|
+
"description": "Details about the mailing address for this person account. Labels are Mailing City , Mailing Country , Postal Code , and State . Maximum size for city and country is 40 characters. Maximum size for postal code and state is 20 characters."
|
|
1719
|
+
},
|
|
1720
|
+
"PersonMailingCountry": {
|
|
1721
|
+
"type": [
|
|
1722
|
+
"string",
|
|
1723
|
+
"null"
|
|
1724
|
+
],
|
|
1725
|
+
"description": "Details about the mailing address for this person account. Labels are Mailing City , Mailing Country , Postal Code , and State . Maximum size for city and country is 40 characters. Maximum size for postal code and state is 20 characters."
|
|
1726
|
+
},
|
|
1727
|
+
"PersonMailingPostalCode": {
|
|
1728
|
+
"type": [
|
|
1729
|
+
"string",
|
|
1730
|
+
"null"
|
|
1731
|
+
],
|
|
1732
|
+
"description": "Details about the mailing address for this person account. Labels are Mailing City , Mailing Country , Postal Code , and State . Maximum size for city and country is 40 characters. Maximum size for postal code and state is 20 characters."
|
|
1733
|
+
},
|
|
1734
|
+
"PersonMailingState": {
|
|
1735
|
+
"type": [
|
|
1736
|
+
"string",
|
|
1737
|
+
"null"
|
|
1738
|
+
],
|
|
1739
|
+
"description": "Details about the mailing address for this person account. Labels are Mailing City , Mailing Country , Postal Code , and State . Maximum size for city and country is 40 characters. Maximum size for postal code and state is 20 characters."
|
|
1740
|
+
},
|
|
1741
|
+
"PersonMailingCountryCode": {
|
|
1742
|
+
"type": [
|
|
1743
|
+
"string",
|
|
1744
|
+
"null"
|
|
1745
|
+
],
|
|
1746
|
+
"description": "The ISO country or state code for the mailing address of the person account."
|
|
1747
|
+
},
|
|
1748
|
+
"PersonMailingStateCode": {
|
|
1749
|
+
"type": [
|
|
1750
|
+
"string",
|
|
1751
|
+
"null"
|
|
1752
|
+
],
|
|
1753
|
+
"description": "The ISO country or state code for the mailing address of the person account."
|
|
1754
|
+
},
|
|
1755
|
+
"PersonMailingGeocodeAccuracy": {
|
|
1756
|
+
"type": [
|
|
1757
|
+
"string",
|
|
1758
|
+
"null"
|
|
1759
|
+
],
|
|
1760
|
+
"description": "Accuracy level of the geocode for the person’s mailing address. For details on geolocation compound fields, see Compound Field Considerations and Limitations .",
|
|
1761
|
+
"readOnly": true
|
|
1762
|
+
},
|
|
1763
|
+
"PersonMailingLatitude": {
|
|
1764
|
+
"type": [
|
|
1765
|
+
"number",
|
|
1766
|
+
"null"
|
|
1767
|
+
],
|
|
1768
|
+
"description": "Used with PersonMailingLongitude to specify the precise geolocation of a person account’s mailing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1769
|
+
},
|
|
1770
|
+
"PersonMailingLongitude": {
|
|
1771
|
+
"type": [
|
|
1772
|
+
"number",
|
|
1773
|
+
"null"
|
|
1774
|
+
],
|
|
1775
|
+
"description": "Used with PersonMailingLatitude to specify the precise geolocation of a person account’s mailing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1776
|
+
},
|
|
1777
|
+
"PersonMailingStreet": {
|
|
1778
|
+
"type": [
|
|
1779
|
+
"string",
|
|
1780
|
+
"null"
|
|
1781
|
+
],
|
|
1782
|
+
"maxLength": 255,
|
|
1783
|
+
"description": "The mailing street address for this person account. Label is Mailing Street . Maximum size is 255 characters."
|
|
1784
|
+
},
|
|
1785
|
+
"PersonMobilePhone": {
|
|
1786
|
+
"type": [
|
|
1787
|
+
"string",
|
|
1788
|
+
"null"
|
|
1789
|
+
],
|
|
1790
|
+
"description": "The mobile phone number for this person account. Label is Mobile ."
|
|
1791
|
+
},
|
|
1792
|
+
"PersonOtherCity": {
|
|
1793
|
+
"type": [
|
|
1794
|
+
"string",
|
|
1795
|
+
"null"
|
|
1796
|
+
],
|
|
1797
|
+
"description": "Details about the alternate address for this person account. Labels are Other City , Other Country , Other Zip/Postal Code , and Other State ."
|
|
1798
|
+
},
|
|
1799
|
+
"PersonOtherCountry": {
|
|
1800
|
+
"type": [
|
|
1801
|
+
"string",
|
|
1802
|
+
"null"
|
|
1803
|
+
],
|
|
1804
|
+
"description": "Details about the alternate address for this person account. Labels are Other City , Other Country , Other Zip/Postal Code , and Other State ."
|
|
1805
|
+
},
|
|
1806
|
+
"PersonOtherPostalCode": {
|
|
1807
|
+
"type": [
|
|
1808
|
+
"string",
|
|
1809
|
+
"null"
|
|
1810
|
+
],
|
|
1811
|
+
"description": "Details about the alternate address for this person account. Labels are Other City , Other Country , Other Zip/Postal Code , and Other State ."
|
|
1812
|
+
},
|
|
1813
|
+
"PersonOtherState": {
|
|
1814
|
+
"type": [
|
|
1815
|
+
"string",
|
|
1816
|
+
"null"
|
|
1817
|
+
],
|
|
1818
|
+
"description": "Details about the alternate address for this person account. Labels are Other City , Other Country , Other Zip/Postal Code , and Other State ."
|
|
1819
|
+
},
|
|
1820
|
+
"PersonOtherCountryCode": {
|
|
1821
|
+
"type": [
|
|
1822
|
+
"string",
|
|
1823
|
+
"null"
|
|
1824
|
+
],
|
|
1825
|
+
"description": "The ISO country or state code for the alternate address of the person account."
|
|
1826
|
+
},
|
|
1827
|
+
"PersonOtherStateCode": {
|
|
1828
|
+
"type": [
|
|
1829
|
+
"string",
|
|
1830
|
+
"null"
|
|
1831
|
+
],
|
|
1832
|
+
"description": "The ISO country or state code for the alternate address of the person account."
|
|
1833
|
+
},
|
|
1834
|
+
"PersonOtherLatitude": {
|
|
1835
|
+
"type": [
|
|
1836
|
+
"number",
|
|
1837
|
+
"null"
|
|
1838
|
+
],
|
|
1839
|
+
"description": "Used with PersonOtherLongitude to specify the precise geolocation of a person account’s alternate address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1840
|
+
},
|
|
1841
|
+
"PersonOtherLongitude": {
|
|
1842
|
+
"type": [
|
|
1843
|
+
"number",
|
|
1844
|
+
"null"
|
|
1845
|
+
],
|
|
1846
|
+
"description": "Used with PersonOtherLatitude to specify the precise geolocation of a person account’s alternate address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
1847
|
+
},
|
|
1848
|
+
"PersonOtherPhone": {
|
|
1849
|
+
"type": [
|
|
1850
|
+
"string",
|
|
1851
|
+
"null"
|
|
1852
|
+
],
|
|
1853
|
+
"description": "The alternate phone number for this person account. Label is Other Phone ."
|
|
1854
|
+
},
|
|
1855
|
+
"PersonOtherStreet": {
|
|
1856
|
+
"type": [
|
|
1857
|
+
"string",
|
|
1858
|
+
"null"
|
|
1859
|
+
],
|
|
1860
|
+
"description": "The person account’s alternate street address. Label is Other Street ."
|
|
1861
|
+
},
|
|
1862
|
+
"PersonPronouns": {
|
|
1863
|
+
"anyOf": [
|
|
1864
|
+
{
|
|
1865
|
+
"type": "string",
|
|
1866
|
+
"enum": [
|
|
1867
|
+
"He/Him",
|
|
1868
|
+
"He/They",
|
|
1869
|
+
"Not Listed",
|
|
1870
|
+
"She/Her",
|
|
1871
|
+
"She/They",
|
|
1872
|
+
"They/Them"
|
|
1873
|
+
]
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"type": "null"
|
|
1877
|
+
}
|
|
1878
|
+
],
|
|
1879
|
+
"description": "The individual’s personal pronouns, reflecting their gender identity. Others can use these pronouns to refer to the individual in the third person. The entry is selected from a picklist of available values, which the administrator sets. Maximum 40 characters. Label is Pronouns ."
|
|
1880
|
+
},
|
|
1881
|
+
"PersonReportsToId": {
|
|
1882
|
+
"$ref": "#/$defs/NullableId",
|
|
1883
|
+
"description": "ID of the person account or contact that this person account reports to."
|
|
1884
|
+
},
|
|
1885
|
+
"PersonTitle": {
|
|
1886
|
+
"type": [
|
|
1887
|
+
"string",
|
|
1888
|
+
"null"
|
|
1889
|
+
],
|
|
1890
|
+
"maxLength": 80,
|
|
1891
|
+
"description": "The person account’s title. Label is Title . Maximum size is 80 characters. When converting a lead to a person account, the conversion fails if the lead’s Title field contains more than 80 characters."
|
|
1892
|
+
},
|
|
1893
|
+
"Suffix": {
|
|
1894
|
+
"type": [
|
|
1895
|
+
"string",
|
|
1896
|
+
"null"
|
|
1897
|
+
],
|
|
1898
|
+
"maxLength": 40,
|
|
1899
|
+
"description": "Name suffix of the person for a person account. Maximum size is 40 characters."
|
|
1900
|
+
}
|
|
1901
|
+
},
|
|
1902
|
+
"required": [
|
|
1903
|
+
"Id"
|
|
1904
|
+
],
|
|
1905
|
+
"additionalProperties": false
|
|
1906
|
+
},
|
|
1907
|
+
"Contact": {
|
|
1908
|
+
"type": "object",
|
|
1909
|
+
"description": "Contact fields documented by the pinned Winter 27 Object Reference. Properties are the union of documented read/create forms; only Id is universally required by this stored entity so SOQL projections remain ingestible.",
|
|
1910
|
+
"properties": {
|
|
1911
|
+
"Id": {
|
|
1912
|
+
"$ref": "base.json#/$defs/Id",
|
|
1913
|
+
"description": "Unique Salesforce record identifier.",
|
|
1914
|
+
"readOnly": true
|
|
1915
|
+
},
|
|
1916
|
+
"AccountId": {
|
|
1917
|
+
"$ref": "#/$defs/NullableId",
|
|
1918
|
+
"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."
|
|
1919
|
+
},
|
|
1920
|
+
"ActionCadenceAssigneeId": {
|
|
1921
|
+
"$ref": "#/$defs/NullableId",
|
|
1922
|
+
"description": "The ID of the sales rep designated to work the lead through their assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1923
|
+
"readOnly": true
|
|
1924
|
+
},
|
|
1925
|
+
"ActionCadenceId": {
|
|
1926
|
+
"$ref": "#/$defs/NullableId",
|
|
1927
|
+
"description": "The ID of the lead’s assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1928
|
+
"readOnly": true
|
|
1929
|
+
},
|
|
1930
|
+
"ActionCadenceState": {
|
|
1931
|
+
"anyOf": [
|
|
1932
|
+
{
|
|
1933
|
+
"type": "string",
|
|
1934
|
+
"enum": [
|
|
1935
|
+
"Complete",
|
|
1936
|
+
"Error",
|
|
1937
|
+
"Initializing",
|
|
1938
|
+
"Paused",
|
|
1939
|
+
"Processing",
|
|
1940
|
+
"Running"
|
|
1941
|
+
]
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"type": "null"
|
|
1945
|
+
}
|
|
1946
|
+
],
|
|
1947
|
+
"description": "The state of the current action cadence tracker. This field is available in API version 50.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1948
|
+
"readOnly": true
|
|
1949
|
+
},
|
|
1950
|
+
"ActiveTrackerCount": {
|
|
1951
|
+
"type": [
|
|
1952
|
+
"integer",
|
|
1953
|
+
"null"
|
|
1954
|
+
],
|
|
1955
|
+
"description": "The number of cadences that are actively running on this contact. This field is available in API version 57.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
1956
|
+
"readOnly": true
|
|
1957
|
+
},
|
|
1958
|
+
"ActivityMetricId": {
|
|
1959
|
+
"$ref": "#/$defs/NullableId",
|
|
1960
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric.",
|
|
1961
|
+
"readOnly": true
|
|
1962
|
+
},
|
|
1963
|
+
"ActivityMetricRollupId": {
|
|
1964
|
+
"$ref": "#/$defs/NullableId",
|
|
1965
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup.",
|
|
1966
|
+
"readOnly": true
|
|
1967
|
+
},
|
|
1968
|
+
"AssistantName": {
|
|
1969
|
+
"type": [
|
|
1970
|
+
"string",
|
|
1971
|
+
"null"
|
|
1972
|
+
],
|
|
1973
|
+
"description": "The assistant’s name."
|
|
1974
|
+
},
|
|
1975
|
+
"AssistantPhone": {
|
|
1976
|
+
"type": [
|
|
1977
|
+
"string",
|
|
1978
|
+
"null"
|
|
1979
|
+
],
|
|
1980
|
+
"description": "The assistant’s phone number. Label is Asst. Phone ."
|
|
1981
|
+
},
|
|
1982
|
+
"Birthdate": {
|
|
1983
|
+
"type": [
|
|
1984
|
+
"string",
|
|
1985
|
+
"null"
|
|
1986
|
+
],
|
|
1987
|
+
"minLength": 10,
|
|
1988
|
+
"maxLength": 10,
|
|
1989
|
+
"format": "date",
|
|
1990
|
+
"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"
|
|
1991
|
+
},
|
|
1992
|
+
"BuyerAttributes": {
|
|
1993
|
+
"type": [
|
|
1994
|
+
"string",
|
|
1995
|
+
"null"
|
|
1996
|
+
],
|
|
1997
|
+
"description": "If Automatic Contact Enhancements or Buyer Relationship Map is enabled, this field contains the role of the contact in the opportunity or account. Possible values are: BusinessUser —For example, an end user. Key value. Buyer —Key value Champion —Key value DecisionMaker —Shown in green on a contact in the buyer relationship map UI. Key value. Detractor —Shown in red on a contact in the buyer relationship map UI. Key value. Evaluator ExecutiveSponsor —Key value TechnicalExpert Key values represent key contacts on an opportunity or account. If a buyer relationship map doesn’t have contacts with key values, then Salesforce prompts you to add them. Having all key values represented on the map provides a full view of the deal or account, increasing sales success. Warning To ensure that the buyer relationship map feature works as expected, don't modify field values. For example, if you change Detractor to Detract , the value isn’t shown in red in a buyer relationship map. This field is available with all profiles except custom and minimum-access. To provide access, use field-level security in Object Manager."
|
|
1998
|
+
},
|
|
1999
|
+
"CanAllowPortalSelfReg": {
|
|
2000
|
+
"type": "string",
|
|
2001
|
+
"description": "Indicates whether this contact can self-register for your Customer Portal ( true ) or not ( false )."
|
|
2002
|
+
},
|
|
2003
|
+
"CleanStatus": {
|
|
2004
|
+
"type": [
|
|
2005
|
+
"string",
|
|
2006
|
+
"null"
|
|
2007
|
+
],
|
|
2008
|
+
"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"
|
|
2009
|
+
},
|
|
2010
|
+
"CommerceCustomerReference": {
|
|
2011
|
+
"type": [
|
|
2012
|
+
"string",
|
|
2013
|
+
"null"
|
|
2014
|
+
],
|
|
2015
|
+
"description": "The external Commerce ID of the individual. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.",
|
|
2016
|
+
"readOnly": true
|
|
2017
|
+
},
|
|
2018
|
+
"CommerceGroupReference": {
|
|
2019
|
+
"type": [
|
|
2020
|
+
"string",
|
|
2021
|
+
"null"
|
|
2022
|
+
],
|
|
2023
|
+
"description": "The external name of the Commerce customer group. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.",
|
|
2024
|
+
"readOnly": true
|
|
2025
|
+
},
|
|
2026
|
+
"CommerceOrganizationReference": {
|
|
2027
|
+
"type": [
|
|
2028
|
+
"string",
|
|
2029
|
+
"null"
|
|
2030
|
+
],
|
|
2031
|
+
"description": "The external organization ID of the Commerce instance. To update or create field values, you need the Manage Shopper Profile Sync System Fields user permission. Available in API version 67.0 and later.",
|
|
2032
|
+
"readOnly": true
|
|
2033
|
+
},
|
|
2034
|
+
"ConnectionReceivedId": {
|
|
2035
|
+
"$ref": "#/$defs/NullableId",
|
|
2036
|
+
"description": "ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.",
|
|
2037
|
+
"readOnly": true
|
|
2038
|
+
},
|
|
2039
|
+
"ConnectionSentId": {
|
|
2040
|
+
"$ref": "#/$defs/NullableId",
|
|
2041
|
+
"description": "ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.",
|
|
2042
|
+
"readOnly": true
|
|
2043
|
+
},
|
|
2044
|
+
"ContactSource": {
|
|
2045
|
+
"anyOf": [
|
|
2046
|
+
{
|
|
2047
|
+
"type": "string",
|
|
2048
|
+
"enum": [
|
|
2049
|
+
"Auto Create",
|
|
2050
|
+
"Email Message",
|
|
2051
|
+
"Meeting Digest",
|
|
2052
|
+
"Seller Home"
|
|
2053
|
+
]
|
|
2054
|
+
},
|
|
2055
|
+
{
|
|
2056
|
+
"type": "null"
|
|
2057
|
+
}
|
|
2058
|
+
],
|
|
2059
|
+
"description": "If Automatic Contact Creation is enabled, this field indicates whether the contact was created automatically and identifies the source. Possible values are: Auto Create Email Message Meeting Digest Seller Home"
|
|
2060
|
+
},
|
|
2061
|
+
"Department": {
|
|
2062
|
+
"type": [
|
|
2063
|
+
"string",
|
|
2064
|
+
"null"
|
|
2065
|
+
],
|
|
2066
|
+
"description": "The contact’s department."
|
|
2067
|
+
},
|
|
2068
|
+
"DepartmentGroup": {
|
|
2069
|
+
"anyOf": [
|
|
2070
|
+
{
|
|
2071
|
+
"type": "string",
|
|
2072
|
+
"enum": [
|
|
2073
|
+
"chiefExecutive",
|
|
2074
|
+
"customerSuccess",
|
|
2075
|
+
"finance",
|
|
2076
|
+
"humanResources",
|
|
2077
|
+
"legal",
|
|
2078
|
+
"marketing",
|
|
2079
|
+
"other",
|
|
2080
|
+
"sales",
|
|
2081
|
+
"support",
|
|
2082
|
+
"tech"
|
|
2083
|
+
]
|
|
2084
|
+
},
|
|
2085
|
+
{
|
|
2086
|
+
"type": "null"
|
|
2087
|
+
}
|
|
2088
|
+
],
|
|
2089
|
+
"description": "If Automatic Contact Enhancements or Buyer Relationship Map is enabled, this field contains the business unit, function, or department that the contact belongs to in the organization. Possible values are: chiefExecutive —Key value customerSuccess —For example, wealth management, consumer banking, subject matter experts, or healthcare research experts. finance —Includes pricing and procurement. Key value. humanResources legal —Key value marketing other sales support —For example, tech support or customer support. tech —For example, IT or engineering. Key value. Key values represent key contacts on an opportunity or account. If a buyer relationship map doesn’t have contacts with key values, then Salesforce prompts you to add them. Having all key values represented on the map provides a full view of the deal or account, increasing sales success. This field is available with all profiles except custom and minimum-access. To provide access, use field-level security in Object Manager."
|
|
2090
|
+
},
|
|
2091
|
+
"Description": {
|
|
2092
|
+
"type": [
|
|
2093
|
+
"string",
|
|
2094
|
+
"null"
|
|
2095
|
+
],
|
|
2096
|
+
"description": "A description of the contact. Label is Contact Description up to 32 KB."
|
|
2097
|
+
},
|
|
2098
|
+
"DoNotCall": {
|
|
2099
|
+
"type": "string",
|
|
2100
|
+
"description": "Indicates that the contact doesn’t want to receive calls."
|
|
2101
|
+
},
|
|
2102
|
+
"Email": {
|
|
2103
|
+
"type": [
|
|
2104
|
+
"string",
|
|
2105
|
+
"null"
|
|
2106
|
+
],
|
|
2107
|
+
"description": "The contact’s email address."
|
|
2108
|
+
},
|
|
2109
|
+
"EmailBouncedDate": {
|
|
2110
|
+
"anyOf": [
|
|
2111
|
+
{
|
|
2112
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2113
|
+
},
|
|
2114
|
+
{
|
|
2115
|
+
"type": "null"
|
|
2116
|
+
}
|
|
2117
|
+
],
|
|
2118
|
+
"description": "If bounce management is activated and an email sent to the contact results in a hard bounce, the date and time of the bounce."
|
|
2119
|
+
},
|
|
2120
|
+
"EmailBouncedReason": {
|
|
2121
|
+
"type": [
|
|
2122
|
+
"string",
|
|
2123
|
+
"null"
|
|
2124
|
+
],
|
|
2125
|
+
"description": "If bounce management is activated and an email sent to the contact results in a hard bounce, the reason for the bounce."
|
|
2126
|
+
},
|
|
2127
|
+
"Fax": {
|
|
2128
|
+
"type": [
|
|
2129
|
+
"string",
|
|
2130
|
+
"null"
|
|
2131
|
+
],
|
|
2132
|
+
"description": "The contact’s fax number. Label is Business Fax ."
|
|
2133
|
+
},
|
|
2134
|
+
"FirstCallDateTime": {
|
|
2135
|
+
"anyOf": [
|
|
2136
|
+
{
|
|
2137
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"type": "null"
|
|
2141
|
+
}
|
|
2142
|
+
],
|
|
2143
|
+
"description": "The date and time of the first call placed to the contact. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2144
|
+
"readOnly": true
|
|
2145
|
+
},
|
|
2146
|
+
"FirstEmailDateTime": {
|
|
2147
|
+
"anyOf": [
|
|
2148
|
+
{
|
|
2149
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2150
|
+
},
|
|
2151
|
+
{
|
|
2152
|
+
"type": "null"
|
|
2153
|
+
}
|
|
2154
|
+
],
|
|
2155
|
+
"description": "The date and time of the first email sent to the contact. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2156
|
+
"readOnly": true
|
|
2157
|
+
},
|
|
2158
|
+
"FirstName": {
|
|
2159
|
+
"type": [
|
|
2160
|
+
"string",
|
|
2161
|
+
"null"
|
|
2162
|
+
],
|
|
2163
|
+
"description": "The contact’s first name up to 40 characters."
|
|
2164
|
+
},
|
|
2165
|
+
"GenderIdentity": {
|
|
2166
|
+
"type": [
|
|
2167
|
+
"string",
|
|
2168
|
+
"null"
|
|
2169
|
+
],
|
|
2170
|
+
"description": "The contact’s internal experience of their gender, which may or may not correspond to their designated sex at birth."
|
|
2171
|
+
},
|
|
2172
|
+
"HasOptedOutOfEmail": {
|
|
2173
|
+
"type": "string",
|
|
2174
|
+
"description": "Indicates whether the contact doesn’t want to receive email from Salesforce ( true ) or does ( false ). Label is Email Opt Out ."
|
|
2175
|
+
},
|
|
2176
|
+
"HasOptedOutOfFax": {
|
|
2177
|
+
"type": "string",
|
|
2178
|
+
"description": "Indicates whether the contact prohibits receiving faxes."
|
|
2179
|
+
},
|
|
2180
|
+
"HomePhone": {
|
|
2181
|
+
"type": [
|
|
2182
|
+
"string",
|
|
2183
|
+
"null"
|
|
2184
|
+
],
|
|
2185
|
+
"description": "The contact’s home phone number. Label is Home Phone ."
|
|
2186
|
+
},
|
|
2187
|
+
"IndividualId": {
|
|
2188
|
+
"$ref": "#/$defs/NullableId",
|
|
2189
|
+
"description": "ID of the data privacy record associated with this contact. This field is available if Data Protection and Privacy is enabled."
|
|
2190
|
+
},
|
|
2191
|
+
"IsDeleted": {
|
|
2192
|
+
"type": "string",
|
|
2193
|
+
"description": "Indicates whether the object has been moved to the Recycle Bin ( true ) or not ( false ). Label is Deleted .",
|
|
2194
|
+
"readOnly": true
|
|
2195
|
+
},
|
|
2196
|
+
"IsEmailBounced": {
|
|
2197
|
+
"type": "string",
|
|
2198
|
+
"description": "If bounce management is activated and an email is sent to a contact, indicates whether the email results in a soft or hard bounce ( true ) or not ( false ).",
|
|
2199
|
+
"readOnly": true
|
|
2200
|
+
},
|
|
2201
|
+
"IsPersonAccount": {
|
|
2202
|
+
"type": "string",
|
|
2203
|
+
"description": "Read only. Indicates whether this account has a record type of Person Account ( true ) or not ( false ). Label is Is Person Account .",
|
|
2204
|
+
"readOnly": true
|
|
2205
|
+
},
|
|
2206
|
+
"IsPriorityRecord": {
|
|
2207
|
+
"type": "string",
|
|
2208
|
+
"description": "Shows whether the user has marked the contact as important ( True ) or not ( False ). The default value is false . Available in API version 59.0 and later.",
|
|
2209
|
+
"readOnly": true
|
|
2210
|
+
},
|
|
2211
|
+
"Jigsaw": {
|
|
2212
|
+
"type": [
|
|
2213
|
+
"string",
|
|
2214
|
+
"null"
|
|
2215
|
+
],
|
|
2216
|
+
"maxLength": 20,
|
|
2217
|
+
"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 wasn’t imported from Data.com. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key . Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Do not modify this value."
|
|
2218
|
+
},
|
|
2219
|
+
"JigsawContactId": {
|
|
2220
|
+
"type": [
|
|
2221
|
+
"string",
|
|
2222
|
+
"null"
|
|
2223
|
+
],
|
|
2224
|
+
"description": "The ID of the contact in reference to Jigsaw . Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field.",
|
|
2225
|
+
"readOnly": true
|
|
2226
|
+
},
|
|
2227
|
+
"LastActivityDate": {
|
|
2228
|
+
"type": [
|
|
2229
|
+
"string",
|
|
2230
|
+
"null"
|
|
2231
|
+
],
|
|
2232
|
+
"minLength": 10,
|
|
2233
|
+
"maxLength": 10,
|
|
2234
|
+
"format": "date",
|
|
2235
|
+
"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.",
|
|
2236
|
+
"readOnly": true
|
|
2237
|
+
},
|
|
2238
|
+
"LastName": {
|
|
2239
|
+
"type": "string",
|
|
2240
|
+
"description": "Required. Last name of the contact up to 80 characters."
|
|
2241
|
+
},
|
|
2242
|
+
"LastReferencedDate": {
|
|
2243
|
+
"anyOf": [
|
|
2244
|
+
{
|
|
2245
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2246
|
+
},
|
|
2247
|
+
{
|
|
2248
|
+
"type": "null"
|
|
2249
|
+
}
|
|
2250
|
+
],
|
|
2251
|
+
"description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view.",
|
|
2252
|
+
"readOnly": true
|
|
2253
|
+
},
|
|
2254
|
+
"LastViewedDate": {
|
|
2255
|
+
"anyOf": [
|
|
2256
|
+
{
|
|
2257
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
"type": "null"
|
|
2261
|
+
}
|
|
2262
|
+
],
|
|
2263
|
+
"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.",
|
|
2264
|
+
"readOnly": true
|
|
2265
|
+
},
|
|
2266
|
+
"LeadSource": {
|
|
2267
|
+
"type": [
|
|
2268
|
+
"string",
|
|
2269
|
+
"null"
|
|
2270
|
+
],
|
|
2271
|
+
"description": "The source of the lead that was converted to this contact."
|
|
2272
|
+
},
|
|
2273
|
+
"MailingAddress": {
|
|
2274
|
+
"anyOf": [
|
|
2275
|
+
{
|
|
2276
|
+
"$ref": "#/$defs/Address"
|
|
2277
|
+
},
|
|
2278
|
+
{
|
|
2279
|
+
"type": "null"
|
|
2280
|
+
}
|
|
2281
|
+
],
|
|
2282
|
+
"description": "The compound form of the mailing address. Read-only. For details on compound address fields, see Address Compound Fields .",
|
|
2283
|
+
"readOnly": true
|
|
2284
|
+
},
|
|
2285
|
+
"MailingCity": {
|
|
2286
|
+
"type": [
|
|
2287
|
+
"string",
|
|
2288
|
+
"null"
|
|
2289
|
+
],
|
|
2290
|
+
"description": "Mailing address details."
|
|
2291
|
+
},
|
|
2292
|
+
"MailingCountry": {
|
|
2293
|
+
"type": [
|
|
2294
|
+
"string",
|
|
2295
|
+
"null"
|
|
2296
|
+
],
|
|
2297
|
+
"description": "Mailing address details."
|
|
2298
|
+
},
|
|
2299
|
+
"MailingCountryCode": {
|
|
2300
|
+
"type": [
|
|
2301
|
+
"string",
|
|
2302
|
+
"null"
|
|
2303
|
+
],
|
|
2304
|
+
"description": "The ISO codes for the mailing address’s state and country."
|
|
2305
|
+
},
|
|
2306
|
+
"MailingGeocodeAccuracy": {
|
|
2307
|
+
"type": [
|
|
2308
|
+
"string",
|
|
2309
|
+
"null"
|
|
2310
|
+
],
|
|
2311
|
+
"description": "Accuracy level of the geocode for the mailing address. For details on geolocation compound field, see Compound Field Considerations and Limitations ."
|
|
2312
|
+
},
|
|
2313
|
+
"MailingLatitude": {
|
|
2314
|
+
"type": [
|
|
2315
|
+
"number",
|
|
2316
|
+
"null"
|
|
2317
|
+
],
|
|
2318
|
+
"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 Compound Field Considerations and Limitations ."
|
|
2319
|
+
},
|
|
2320
|
+
"MailingLongitude": {
|
|
2321
|
+
"type": [
|
|
2322
|
+
"number",
|
|
2323
|
+
"null"
|
|
2324
|
+
],
|
|
2325
|
+
"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 Compound Field Considerations and Limitations ."
|
|
2326
|
+
},
|
|
2327
|
+
"MailingPostalCode": {
|
|
2328
|
+
"type": [
|
|
2329
|
+
"string",
|
|
2330
|
+
"null"
|
|
2331
|
+
],
|
|
2332
|
+
"description": "Mailing address details."
|
|
2333
|
+
},
|
|
2334
|
+
"MailingState": {
|
|
2335
|
+
"type": [
|
|
2336
|
+
"string",
|
|
2337
|
+
"null"
|
|
2338
|
+
],
|
|
2339
|
+
"description": "Mailing address details."
|
|
2340
|
+
},
|
|
2341
|
+
"MailingStateCode": {
|
|
2342
|
+
"type": [
|
|
2343
|
+
"string",
|
|
2344
|
+
"null"
|
|
2345
|
+
],
|
|
2346
|
+
"description": "The ISO codes for the mailing address’s state and country."
|
|
2347
|
+
},
|
|
2348
|
+
"MailingStreet": {
|
|
2349
|
+
"type": [
|
|
2350
|
+
"string",
|
|
2351
|
+
"null"
|
|
2352
|
+
],
|
|
2353
|
+
"description": "Street address for mailing address."
|
|
2354
|
+
},
|
|
2355
|
+
"MasterRecordId": {
|
|
2356
|
+
"$ref": "#/$defs/NullableId",
|
|
2357
|
+
"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 hasn’t been deleted, the value is null .",
|
|
2358
|
+
"readOnly": true
|
|
2359
|
+
},
|
|
2360
|
+
"MiddleName": {
|
|
2361
|
+
"type": [
|
|
2362
|
+
"string",
|
|
2363
|
+
"null"
|
|
2364
|
+
],
|
|
2365
|
+
"maxLength": 40,
|
|
2366
|
+
"description": "The contact’s middle name. Maximum size is 40 characters."
|
|
2367
|
+
},
|
|
2368
|
+
"MobilePhone": {
|
|
2369
|
+
"type": [
|
|
2370
|
+
"string",
|
|
2371
|
+
"null"
|
|
2372
|
+
],
|
|
2373
|
+
"description": "Contact’s mobile phone number. Label is Mobile Phone ."
|
|
2374
|
+
},
|
|
2375
|
+
"Name": {
|
|
2376
|
+
"type": "string",
|
|
2377
|
+
"description": "Concatenation of FirstName , MiddleName , LastName , and Suffix up to 203 characters, including whitespaces.",
|
|
2378
|
+
"readOnly": true
|
|
2379
|
+
},
|
|
2380
|
+
"OtherAddress": {
|
|
2381
|
+
"anyOf": [
|
|
2382
|
+
{
|
|
2383
|
+
"$ref": "#/$defs/Address"
|
|
2384
|
+
},
|
|
2385
|
+
{
|
|
2386
|
+
"type": "null"
|
|
2387
|
+
}
|
|
2388
|
+
],
|
|
2389
|
+
"description": "The compound form of the other address. Read-only. For details on compound address fields, see Address Compound Fields .",
|
|
2390
|
+
"readOnly": true
|
|
2391
|
+
},
|
|
2392
|
+
"OtherCity": {
|
|
2393
|
+
"type": [
|
|
2394
|
+
"string",
|
|
2395
|
+
"null"
|
|
2396
|
+
],
|
|
2397
|
+
"description": "Alternate address details."
|
|
2398
|
+
},
|
|
2399
|
+
"OtherCountry": {
|
|
2400
|
+
"type": [
|
|
2401
|
+
"string",
|
|
2402
|
+
"null"
|
|
2403
|
+
],
|
|
2404
|
+
"description": "Alternate address details."
|
|
2405
|
+
},
|
|
2406
|
+
"OtherCountryCode": {
|
|
2407
|
+
"type": [
|
|
2408
|
+
"string",
|
|
2409
|
+
"null"
|
|
2410
|
+
],
|
|
2411
|
+
"description": "The ISO codes for the alternate address’s state and country."
|
|
2412
|
+
},
|
|
2413
|
+
"OtherGeocodeAccuracy": {
|
|
2414
|
+
"type": [
|
|
2415
|
+
"string",
|
|
2416
|
+
"null"
|
|
2417
|
+
],
|
|
2418
|
+
"description": "Accuracy level of the geocode for the other address. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
2419
|
+
},
|
|
2420
|
+
"OtherLatitude": {
|
|
2421
|
+
"type": [
|
|
2422
|
+
"number",
|
|
2423
|
+
"null"
|
|
2424
|
+
],
|
|
2425
|
+
"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 Compound Field Considerations and Limitations ."
|
|
2426
|
+
},
|
|
2427
|
+
"OtherLongitude": {
|
|
2428
|
+
"type": [
|
|
2429
|
+
"number",
|
|
2430
|
+
"null"
|
|
2431
|
+
],
|
|
2432
|
+
"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 Compound Field Considerations and Limitations ."
|
|
2433
|
+
},
|
|
2434
|
+
"OtherPhone": {
|
|
2435
|
+
"type": [
|
|
2436
|
+
"string",
|
|
2437
|
+
"null"
|
|
2438
|
+
],
|
|
2439
|
+
"description": "Phone for alternate address."
|
|
2440
|
+
},
|
|
2441
|
+
"OtherPostalCode": {
|
|
2442
|
+
"type": [
|
|
2443
|
+
"string",
|
|
2444
|
+
"null"
|
|
2445
|
+
],
|
|
2446
|
+
"description": "Alternate address details."
|
|
2447
|
+
},
|
|
2448
|
+
"OtherState": {
|
|
2449
|
+
"type": [
|
|
2450
|
+
"string",
|
|
2451
|
+
"null"
|
|
2452
|
+
],
|
|
2453
|
+
"description": "Alternate address details."
|
|
2454
|
+
},
|
|
2455
|
+
"OtherStateCode": {
|
|
2456
|
+
"type": [
|
|
2457
|
+
"string",
|
|
2458
|
+
"null"
|
|
2459
|
+
],
|
|
2460
|
+
"description": "The ISO codes for the alternate address’s state and country."
|
|
2461
|
+
},
|
|
2462
|
+
"OtherStreet": {
|
|
2463
|
+
"type": [
|
|
2464
|
+
"string",
|
|
2465
|
+
"null"
|
|
2466
|
+
],
|
|
2467
|
+
"description": "Street for alternate address."
|
|
2468
|
+
},
|
|
2469
|
+
"OwnerId": {
|
|
2470
|
+
"$ref": "base.json#/$defs/Id",
|
|
2471
|
+
"description": "The ID of the owner of the account associated with this contact."
|
|
2472
|
+
},
|
|
2473
|
+
"Phone": {
|
|
2474
|
+
"type": [
|
|
2475
|
+
"string",
|
|
2476
|
+
"null"
|
|
2477
|
+
],
|
|
2478
|
+
"description": "Phone number for the contact. Label is Business Phone ."
|
|
2479
|
+
},
|
|
2480
|
+
"PhotoUrl": {
|
|
2481
|
+
"type": [
|
|
2482
|
+
"string",
|
|
2483
|
+
"null"
|
|
2484
|
+
],
|
|
2485
|
+
"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.",
|
|
2486
|
+
"readOnly": true
|
|
2487
|
+
},
|
|
2488
|
+
"Pronouns": {
|
|
2489
|
+
"anyOf": [
|
|
2490
|
+
{
|
|
2491
|
+
"type": "string",
|
|
2492
|
+
"enum": [
|
|
2493
|
+
"He/Him",
|
|
2494
|
+
"He/They",
|
|
2495
|
+
"Not Listed",
|
|
2496
|
+
"She/Her",
|
|
2497
|
+
"She/They",
|
|
2498
|
+
"They/Them"
|
|
2499
|
+
]
|
|
2500
|
+
},
|
|
2501
|
+
{
|
|
2502
|
+
"type": "null"
|
|
2503
|
+
}
|
|
2504
|
+
],
|
|
2505
|
+
"description": "The contact’s personal pronouns, reflecting their gender identity. Others can use these pronouns to refer to the contact in the third person. The entry is selected from a picklist of available values, which the administrator sets. Maximum 40 characters."
|
|
2506
|
+
},
|
|
2507
|
+
"RecordTypeId": {
|
|
2508
|
+
"$ref": "#/$defs/NullableId",
|
|
2509
|
+
"description": "ID of the record type assigned to this object."
|
|
2510
|
+
},
|
|
2511
|
+
"ReportsToId": {
|
|
2512
|
+
"$ref": "#/$defs/NullableId",
|
|
2513
|
+
"description": "ID of the contact that this contact reports to."
|
|
2514
|
+
},
|
|
2515
|
+
"Salutation": {
|
|
2516
|
+
"type": [
|
|
2517
|
+
"string",
|
|
2518
|
+
"null"
|
|
2519
|
+
],
|
|
2520
|
+
"description": "Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs."
|
|
2521
|
+
},
|
|
2522
|
+
"ScheduledResumeDateTime": {
|
|
2523
|
+
"anyOf": [
|
|
2524
|
+
{
|
|
2525
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2526
|
+
},
|
|
2527
|
+
{
|
|
2528
|
+
"type": "null"
|
|
2529
|
+
}
|
|
2530
|
+
],
|
|
2531
|
+
"description": "The date and time when the action cadence tracker is going to resume after it’s paused or on a wait step. This field is available in API version 54.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2532
|
+
"readOnly": true
|
|
2533
|
+
},
|
|
2534
|
+
"Suffix": {
|
|
2535
|
+
"type": [
|
|
2536
|
+
"string",
|
|
2537
|
+
"null"
|
|
2538
|
+
],
|
|
2539
|
+
"maxLength": 40,
|
|
2540
|
+
"description": "Name suffix of the contact. Maximum size is 40 characters."
|
|
2541
|
+
},
|
|
2542
|
+
"Title": {
|
|
2543
|
+
"type": [
|
|
2544
|
+
"string",
|
|
2545
|
+
"null"
|
|
2546
|
+
],
|
|
2547
|
+
"description": "Title of the contact, such as CEO or Vice President."
|
|
2548
|
+
},
|
|
2549
|
+
"TitleType": {
|
|
2550
|
+
"anyOf": [
|
|
2551
|
+
{
|
|
2552
|
+
"type": "string",
|
|
2553
|
+
"enum": [
|
|
2554
|
+
"ceo",
|
|
2555
|
+
"directorOrManager",
|
|
2556
|
+
"executive",
|
|
2557
|
+
"individualContributor",
|
|
2558
|
+
"vp"
|
|
2559
|
+
]
|
|
2560
|
+
},
|
|
2561
|
+
{
|
|
2562
|
+
"type": "null"
|
|
2563
|
+
}
|
|
2564
|
+
],
|
|
2565
|
+
"description": "If Automatic Contact Enhancements or Buyer Relationship Map is enabled, this field contains the hierarchical position that the contact holds in the organization. In the UI, this field is shown as Seniority Level. Possible values are: ceo —Key value directorOrManager —Key value executive —Key value individualContributor vp —VP or Head of Department. Key value. Key values represent key contacts on an opportunity or account. If a buyer relationship map doesn’t show contacts with key values, then Salesforce prompts you to add them. Having all key values represented on the map provides a complete picture of the deal or account, increasing sales success. This field is available with all profiles except custom and minimum-access. To provide access, use field-level security in Object Manager."
|
|
2566
|
+
}
|
|
2567
|
+
},
|
|
2568
|
+
"required": [
|
|
2569
|
+
"Id"
|
|
2570
|
+
],
|
|
2571
|
+
"additionalProperties": false
|
|
2572
|
+
},
|
|
2573
|
+
"Lead": {
|
|
2574
|
+
"type": "object",
|
|
2575
|
+
"description": "Lead fields documented by the pinned Winter 27 Object Reference. Properties are the union of documented read/create forms; only Id is universally required by this stored entity so SOQL projections remain ingestible.",
|
|
2576
|
+
"properties": {
|
|
2577
|
+
"Id": {
|
|
2578
|
+
"$ref": "base.json#/$defs/Id",
|
|
2579
|
+
"description": "Unique Salesforce record identifier.",
|
|
2580
|
+
"readOnly": true
|
|
2581
|
+
},
|
|
2582
|
+
"ActionCadenceAssigneeId": {
|
|
2583
|
+
"$ref": "#/$defs/NullableId",
|
|
2584
|
+
"description": "The ID of the sales rep designated to work the lead through their assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2585
|
+
"readOnly": true
|
|
2586
|
+
},
|
|
2587
|
+
"ActionCadenceId": {
|
|
2588
|
+
"$ref": "#/$defs/NullableId",
|
|
2589
|
+
"description": "The ID of the lead’s assigned cadence. This field is available in API version 48.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2590
|
+
"readOnly": true
|
|
2591
|
+
},
|
|
2592
|
+
"ActionCadenceState": {
|
|
2593
|
+
"anyOf": [
|
|
2594
|
+
{
|
|
2595
|
+
"type": "string",
|
|
2596
|
+
"enum": [
|
|
2597
|
+
"Complete",
|
|
2598
|
+
"Error",
|
|
2599
|
+
"Initializing",
|
|
2600
|
+
"Paused",
|
|
2601
|
+
"Processing",
|
|
2602
|
+
"Running"
|
|
2603
|
+
]
|
|
2604
|
+
},
|
|
2605
|
+
{
|
|
2606
|
+
"type": "null"
|
|
2607
|
+
}
|
|
2608
|
+
],
|
|
2609
|
+
"description": "The state of the current action cadence tracker. This field is available in API version 50.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2610
|
+
"readOnly": true
|
|
2611
|
+
},
|
|
2612
|
+
"ActiveTrackerCount": {
|
|
2613
|
+
"type": [
|
|
2614
|
+
"integer",
|
|
2615
|
+
"null"
|
|
2616
|
+
],
|
|
2617
|
+
"description": "The number of cadences that are actively running on this lead. This field is available in API version 57.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2618
|
+
"readOnly": true
|
|
2619
|
+
},
|
|
2620
|
+
"ActivityMetricId": {
|
|
2621
|
+
"$ref": "#/$defs/NullableId",
|
|
2622
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric.",
|
|
2623
|
+
"readOnly": true
|
|
2624
|
+
},
|
|
2625
|
+
"ActivityMetricRollupId": {
|
|
2626
|
+
"$ref": "#/$defs/NullableId",
|
|
2627
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup.",
|
|
2628
|
+
"readOnly": true
|
|
2629
|
+
},
|
|
2630
|
+
"Address": {
|
|
2631
|
+
"anyOf": [
|
|
2632
|
+
{
|
|
2633
|
+
"$ref": "#/$defs/Address"
|
|
2634
|
+
},
|
|
2635
|
+
{
|
|
2636
|
+
"type": "null"
|
|
2637
|
+
}
|
|
2638
|
+
],
|
|
2639
|
+
"description": "The compound form of the address. Read-only. For details on compound address fields, see Address Compound Fields .",
|
|
2640
|
+
"readOnly": true
|
|
2641
|
+
},
|
|
2642
|
+
"AnnualRevenue": {
|
|
2643
|
+
"type": [
|
|
2644
|
+
"number",
|
|
2645
|
+
"null"
|
|
2646
|
+
],
|
|
2647
|
+
"description": "Annual revenue for the lead’s company."
|
|
2648
|
+
},
|
|
2649
|
+
"City": {
|
|
2650
|
+
"type": [
|
|
2651
|
+
"string",
|
|
2652
|
+
"null"
|
|
2653
|
+
],
|
|
2654
|
+
"description": "City for the lead’s address."
|
|
2655
|
+
},
|
|
2656
|
+
"CleanStatus": {
|
|
2657
|
+
"anyOf": [
|
|
2658
|
+
{
|
|
2659
|
+
"type": "string",
|
|
2660
|
+
"enum": [
|
|
2661
|
+
"Acknowledged",
|
|
2662
|
+
"Different",
|
|
2663
|
+
"Inactive",
|
|
2664
|
+
"Matched",
|
|
2665
|
+
"NotFound",
|
|
2666
|
+
"Pending",
|
|
2667
|
+
"SelectMatch",
|
|
2668
|
+
"Skipped"
|
|
2669
|
+
]
|
|
2670
|
+
},
|
|
2671
|
+
{
|
|
2672
|
+
"type": "null"
|
|
2673
|
+
}
|
|
2674
|
+
],
|
|
2675
|
+
"description": "Indicates the record's clean status compared with Data.com. . Several values for CleanStatus appear with different labels on the lead record. Values include: Acknowledged - Reviewed Different Inactive Matched - In Sync NotFound - Not Found Pending - Not Compared SelectMatch - Select Match Skipped"
|
|
2676
|
+
},
|
|
2677
|
+
"Company": {
|
|
2678
|
+
"type": [
|
|
2679
|
+
"string",
|
|
2680
|
+
"null"
|
|
2681
|
+
],
|
|
2682
|
+
"description": "Required. The lead’s company. If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account."
|
|
2683
|
+
},
|
|
2684
|
+
"CompanyDunsNumber": {
|
|
2685
|
+
"type": [
|
|
2686
|
+
"string",
|
|
2687
|
+
"null"
|
|
2688
|
+
],
|
|
2689
|
+
"maxLength": 9,
|
|
2690
|
+
"description": "The Data Universal Numbering System (D-U-N-S) number, which is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. Industries and companies use D-U-N-S numbers as a global standard for business identification and tracking. Maximum size is 9 characters. This field is only available to organizations that use Data.com Prospector or Data.com Clean."
|
|
2691
|
+
},
|
|
2692
|
+
"ConvertedAccountId": {
|
|
2693
|
+
"$ref": "#/$defs/NullableId",
|
|
2694
|
+
"description": "Object reference ID that points to the account into which the lead converted."
|
|
2695
|
+
},
|
|
2696
|
+
"ConvertedContactId": {
|
|
2697
|
+
"$ref": "#/$defs/NullableId",
|
|
2698
|
+
"description": "Object reference ID that points to the contact into which the lead converted."
|
|
2699
|
+
},
|
|
2700
|
+
"ConvertedDate": {
|
|
2701
|
+
"type": [
|
|
2702
|
+
"string",
|
|
2703
|
+
"null"
|
|
2704
|
+
],
|
|
2705
|
+
"minLength": 10,
|
|
2706
|
+
"maxLength": 10,
|
|
2707
|
+
"format": "date",
|
|
2708
|
+
"description": "Date on which this lead was converted."
|
|
2709
|
+
},
|
|
2710
|
+
"ConvertedOpportunityId": {
|
|
2711
|
+
"$ref": "#/$defs/NullableId",
|
|
2712
|
+
"description": "Object reference ID that points to the opportunity into which the lead has been converted."
|
|
2713
|
+
},
|
|
2714
|
+
"ConnectionReceivedId": {
|
|
2715
|
+
"$ref": "#/$defs/NullableId",
|
|
2716
|
+
"description": "ID of the PartnerNetworkConnection that shared this record with your org. This field is available when Salesforce to Salesforce is enabled.",
|
|
2717
|
+
"readOnly": true
|
|
2718
|
+
},
|
|
2719
|
+
"ConnectionSentId": {
|
|
2720
|
+
"$ref": "#/$defs/NullableId",
|
|
2721
|
+
"description": "ID of the PartnerNetworkConnection that this record is shared with. This field is available Salesforce to Salesforce is enabled. In API version 16.0 and later, this value is null . Use PartnerNetworkRecordConnection object to forward records to connections.",
|
|
2722
|
+
"readOnly": true
|
|
2723
|
+
},
|
|
2724
|
+
"Country": {
|
|
2725
|
+
"type": [
|
|
2726
|
+
"string",
|
|
2727
|
+
"null"
|
|
2728
|
+
],
|
|
2729
|
+
"description": "The lead’s country."
|
|
2730
|
+
},
|
|
2731
|
+
"CountryCode": {
|
|
2732
|
+
"type": [
|
|
2733
|
+
"string",
|
|
2734
|
+
"null"
|
|
2735
|
+
],
|
|
2736
|
+
"description": "The ISO country code for the lead’s address."
|
|
2737
|
+
},
|
|
2738
|
+
"CurrencyIsoCode": {
|
|
2739
|
+
"type": [
|
|
2740
|
+
"string",
|
|
2741
|
+
"null"
|
|
2742
|
+
],
|
|
2743
|
+
"description": "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
|
|
2744
|
+
},
|
|
2745
|
+
"DandBCompanyId": {
|
|
2746
|
+
"$ref": "#/$defs/NullableId",
|
|
2747
|
+
"description": "Reference ID to a Dun & Bradstreet® company record, associated with an account added from Data.com."
|
|
2748
|
+
},
|
|
2749
|
+
"Description": {
|
|
2750
|
+
"type": [
|
|
2751
|
+
"string",
|
|
2752
|
+
"null"
|
|
2753
|
+
],
|
|
2754
|
+
"description": "The lead’s description."
|
|
2755
|
+
},
|
|
2756
|
+
"Division": {
|
|
2757
|
+
"type": "string",
|
|
2758
|
+
"description": "A logical segment of your organization's data. For example, if your company is organized into different business units, you could create a division for each business unit, such as North America, Healthcare, or Consulting. Available only when the Division permission is enabled."
|
|
2759
|
+
},
|
|
2760
|
+
"Email": {
|
|
2761
|
+
"type": [
|
|
2762
|
+
"string",
|
|
2763
|
+
"null"
|
|
2764
|
+
],
|
|
2765
|
+
"description": "The lead’s email address."
|
|
2766
|
+
},
|
|
2767
|
+
"EmailBouncedDate": {
|
|
2768
|
+
"anyOf": [
|
|
2769
|
+
{
|
|
2770
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2771
|
+
},
|
|
2772
|
+
{
|
|
2773
|
+
"type": "null"
|
|
2774
|
+
}
|
|
2775
|
+
],
|
|
2776
|
+
"description": "If bounce management is activated and an email sent to the lead bounced, the date and time of the bounce. Email bounce functionality isn't triggered by record updates, including updates to this field."
|
|
2777
|
+
},
|
|
2778
|
+
"EmailBouncedReason": {
|
|
2779
|
+
"type": [
|
|
2780
|
+
"string",
|
|
2781
|
+
"null"
|
|
2782
|
+
],
|
|
2783
|
+
"description": "If bounce management is activated and an email sent to the lead bounced, the reason for the bounce. Email bounce functionality isn't triggered by record updates, including updates to this field."
|
|
2784
|
+
},
|
|
2785
|
+
"ExportStatus": {
|
|
2786
|
+
"type": "string",
|
|
2787
|
+
"description": "Derived field for the record map for Partner Connect. The export status of this opportunity to the partner’s connected org. To see this field, enable Partner Connect and add the Export Vendor Records to an Authorized Partner Org user permission to the cosell export user. See Set Up Partner Connect as a Vendor in Salesforce Help . Available in API version 62.0 and later.",
|
|
2788
|
+
"readOnly": true
|
|
2789
|
+
},
|
|
2790
|
+
"Fax": {
|
|
2791
|
+
"type": [
|
|
2792
|
+
"string",
|
|
2793
|
+
"null"
|
|
2794
|
+
],
|
|
2795
|
+
"description": "The lead’s fax number."
|
|
2796
|
+
},
|
|
2797
|
+
"FirstCallDateTime": {
|
|
2798
|
+
"anyOf": [
|
|
2799
|
+
{
|
|
2800
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2801
|
+
},
|
|
2802
|
+
{
|
|
2803
|
+
"type": "null"
|
|
2804
|
+
}
|
|
2805
|
+
],
|
|
2806
|
+
"description": "The date and time of the first call placed to the lead. This field is available in API version 48.0 when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2807
|
+
"readOnly": true
|
|
2808
|
+
},
|
|
2809
|
+
"FirstEmailDateTime": {
|
|
2810
|
+
"anyOf": [
|
|
2811
|
+
{
|
|
2812
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2813
|
+
},
|
|
2814
|
+
{
|
|
2815
|
+
"type": "null"
|
|
2816
|
+
}
|
|
2817
|
+
],
|
|
2818
|
+
"description": "The date and time of the first email sent to the lead. This field is available in API version 48.0 when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
2819
|
+
"readOnly": true
|
|
2820
|
+
},
|
|
2821
|
+
"FirstName": {
|
|
2822
|
+
"type": [
|
|
2823
|
+
"string",
|
|
2824
|
+
"null"
|
|
2825
|
+
],
|
|
2826
|
+
"description": "The lead’s first name up to 40 characters."
|
|
2827
|
+
},
|
|
2828
|
+
"GeocodeAccuracy": {
|
|
2829
|
+
"type": [
|
|
2830
|
+
"string",
|
|
2831
|
+
"null"
|
|
2832
|
+
],
|
|
2833
|
+
"description": "Accuracy level of the geocode for the address. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
2834
|
+
},
|
|
2835
|
+
"GenderIdentity": {
|
|
2836
|
+
"type": [
|
|
2837
|
+
"string",
|
|
2838
|
+
"null"
|
|
2839
|
+
],
|
|
2840
|
+
"description": "The lead’s internal experience of their gender, which may or may not correspond to their designated sex at birth."
|
|
2841
|
+
},
|
|
2842
|
+
"HasOptedOutOfEmail": {
|
|
2843
|
+
"type": "string",
|
|
2844
|
+
"description": "Indicates whether the lead doesn’t want to receive email from Salesforce ( true ) or does ( false ). Label is Email Opt Out ."
|
|
2845
|
+
},
|
|
2846
|
+
"HasOptedOutOfFax": {
|
|
2847
|
+
"type": "string",
|
|
2848
|
+
"description": "Indicates whether the lead doesn’t want to receive faxes from Salesforce ( true ) or does ( false ). Label is FaxOpt Out ."
|
|
2849
|
+
},
|
|
2850
|
+
"IndividualId": {
|
|
2851
|
+
"$ref": "#/$defs/NullableId",
|
|
2852
|
+
"description": "ID of the data privacy record associated with this lead. This field is available if you enabled Data Protection and Privacy in Setup."
|
|
2853
|
+
},
|
|
2854
|
+
"Industry": {
|
|
2855
|
+
"type": [
|
|
2856
|
+
"string",
|
|
2857
|
+
"null"
|
|
2858
|
+
],
|
|
2859
|
+
"description": "Industry in which the lead works."
|
|
2860
|
+
},
|
|
2861
|
+
"IsConverted": {
|
|
2862
|
+
"type": "string",
|
|
2863
|
+
"description": "Indicates whether the lead has been converted ( true ) or not ( false ). Label is Converted ."
|
|
2864
|
+
},
|
|
2865
|
+
"IsDeleted": {
|
|
2866
|
+
"type": "string",
|
|
2867
|
+
"description": "Indicates whether the object has been moved to the Recycle Bin ( true ) or not ( false ). Label is Deleted .",
|
|
2868
|
+
"readOnly": true
|
|
2869
|
+
},
|
|
2870
|
+
"IsPriorityRecord": {
|
|
2871
|
+
"type": "string",
|
|
2872
|
+
"description": "Shows whether the user has marked the lead as important ( True ) or not ( False ). The default value is false . Available in API version 59.0 and later.",
|
|
2873
|
+
"readOnly": true
|
|
2874
|
+
},
|
|
2875
|
+
"IsUnreadByOwner": {
|
|
2876
|
+
"type": "string",
|
|
2877
|
+
"description": "If true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is Unread By Owner ."
|
|
2878
|
+
},
|
|
2879
|
+
"Jigsaw": {
|
|
2880
|
+
"type": [
|
|
2881
|
+
"string",
|
|
2882
|
+
"null"
|
|
2883
|
+
],
|
|
2884
|
+
"maxLength": 20,
|
|
2885
|
+
"description": "References the ID of a contact in Data.com. If a lead has a value in this field, it means that a contact was imported as a lead from Data.com. If the contact (converted to a lead) wasn’t imported from Data.com, the field value is null. Maximum size is 20 characters. Available in API version 22.0 and later. Label is Data.com Key . Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field."
|
|
2886
|
+
},
|
|
2887
|
+
"JigsawContactId": {
|
|
2888
|
+
"type": [
|
|
2889
|
+
"string",
|
|
2890
|
+
"null"
|
|
2891
|
+
],
|
|
2892
|
+
"description": "The ID of the contact in reference to Jigsaw . Important The Jigsaw field is exposed in the API to support troubleshooting for import errors and reimporting of corrected data. Don’t modify the value in the Jigsaw field.",
|
|
2893
|
+
"readOnly": true
|
|
2894
|
+
},
|
|
2895
|
+
"LastActivityDate": {
|
|
2896
|
+
"type": [
|
|
2897
|
+
"string",
|
|
2898
|
+
"null"
|
|
2899
|
+
],
|
|
2900
|
+
"minLength": 10,
|
|
2901
|
+
"maxLength": 10,
|
|
2902
|
+
"format": "date",
|
|
2903
|
+
"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.",
|
|
2904
|
+
"readOnly": true
|
|
2905
|
+
},
|
|
2906
|
+
"LastName": {
|
|
2907
|
+
"type": "string",
|
|
2908
|
+
"description": "Required. Last name of the lead up to 80 characters."
|
|
2909
|
+
},
|
|
2910
|
+
"LastReferencedDate": {
|
|
2911
|
+
"anyOf": [
|
|
2912
|
+
{
|
|
2913
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2914
|
+
},
|
|
2915
|
+
{
|
|
2916
|
+
"type": "null"
|
|
2917
|
+
}
|
|
2918
|
+
],
|
|
2919
|
+
"description": "The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.",
|
|
2920
|
+
"readOnly": true
|
|
2921
|
+
},
|
|
2922
|
+
"LastViewedDate": {
|
|
2923
|
+
"anyOf": [
|
|
2924
|
+
{
|
|
2925
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
2926
|
+
},
|
|
2927
|
+
{
|
|
2928
|
+
"type": "null"
|
|
2929
|
+
}
|
|
2930
|
+
],
|
|
2931
|
+
"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.",
|
|
2932
|
+
"readOnly": true
|
|
2933
|
+
},
|
|
2934
|
+
"Latitude": {
|
|
2935
|
+
"type": [
|
|
2936
|
+
"number",
|
|
2937
|
+
"null"
|
|
2938
|
+
],
|
|
2939
|
+
"description": "Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations"
|
|
2940
|
+
},
|
|
2941
|
+
"LeadSource": {
|
|
2942
|
+
"type": [
|
|
2943
|
+
"string",
|
|
2944
|
+
"null"
|
|
2945
|
+
],
|
|
2946
|
+
"description": "The origin or source of the lead."
|
|
2947
|
+
},
|
|
2948
|
+
"Longitude": {
|
|
2949
|
+
"type": [
|
|
2950
|
+
"number",
|
|
2951
|
+
"null"
|
|
2952
|
+
],
|
|
2953
|
+
"description": "Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 up to 15 decimal places. For details on geolocation compound fields, see Compound Field Considerations and Limitations ."
|
|
2954
|
+
},
|
|
2955
|
+
"MasterRecordId": {
|
|
2956
|
+
"$ref": "#/$defs/NullableId",
|
|
2957
|
+
"description": "If this record was deleted as the result of a merge, this field contains the ID of the record that was kept. If this record was deleted for any other reason, or hasn’t been deleted, the value is null . When using Apex triggers to determine which record was deleted in a merge event, this field’s value is the ID of the record that remains in Trigger.old . In Trigger. new , the value is null .",
|
|
2958
|
+
"readOnly": true
|
|
2959
|
+
},
|
|
2960
|
+
"MiddleName": {
|
|
2961
|
+
"type": [
|
|
2962
|
+
"string",
|
|
2963
|
+
"null"
|
|
2964
|
+
],
|
|
2965
|
+
"maxLength": 40,
|
|
2966
|
+
"description": "The lead’s middle name. Maximum size is 40 characters."
|
|
2967
|
+
},
|
|
2968
|
+
"MobilePhone": {
|
|
2969
|
+
"type": [
|
|
2970
|
+
"string",
|
|
2971
|
+
"null"
|
|
2972
|
+
],
|
|
2973
|
+
"description": "The lead’s mobile phone number."
|
|
2974
|
+
},
|
|
2975
|
+
"Name": {
|
|
2976
|
+
"type": "string",
|
|
2977
|
+
"description": "Concatenation of FirstName , MiddleName , LastName , and Suffix up to 203 characters, including whitespaces.",
|
|
2978
|
+
"readOnly": true
|
|
2979
|
+
},
|
|
2980
|
+
"NumberOfEmployees": {
|
|
2981
|
+
"type": [
|
|
2982
|
+
"integer",
|
|
2983
|
+
"null"
|
|
2984
|
+
],
|
|
2985
|
+
"description": "Number of employees at the lead’s company. Label is Employees ."
|
|
2986
|
+
},
|
|
2987
|
+
"OwnerId": {
|
|
2988
|
+
"$ref": "base.json#/$defs/Id",
|
|
2989
|
+
"description": "ID of the lead’s owner."
|
|
2990
|
+
},
|
|
2991
|
+
"PartnerAccountId": {
|
|
2992
|
+
"$ref": "#/$defs/NullableId",
|
|
2993
|
+
"description": "ID of the partner account for the partner user that owns this lead. Available if Partner Relationship Management is enabled or if digital experiences is enabled and you have partner portal licenses. In API version 16.0 and later, the Partner Account field is set to the appropriate account for the partner user that owns the lead. If the owner of the lead isn’t a partner user, this field has no value.",
|
|
2994
|
+
"readOnly": true
|
|
2995
|
+
},
|
|
2996
|
+
"Phone": {
|
|
2997
|
+
"type": [
|
|
2998
|
+
"string",
|
|
2999
|
+
"null"
|
|
3000
|
+
],
|
|
3001
|
+
"description": "The lead’s phone number."
|
|
3002
|
+
},
|
|
3003
|
+
"PhotoUrl": {
|
|
3004
|
+
"type": [
|
|
3005
|
+
"string",
|
|
3006
|
+
"null"
|
|
3007
|
+
],
|
|
3008
|
+
"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 lead. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the lead.",
|
|
3009
|
+
"readOnly": true
|
|
3010
|
+
},
|
|
3011
|
+
"PostalCode": {
|
|
3012
|
+
"type": [
|
|
3013
|
+
"string",
|
|
3014
|
+
"null"
|
|
3015
|
+
],
|
|
3016
|
+
"description": "Postal code for the address of the lead. Label is Zip/Postal Code ."
|
|
3017
|
+
},
|
|
3018
|
+
"Pronouns": {
|
|
3019
|
+
"anyOf": [
|
|
3020
|
+
{
|
|
3021
|
+
"type": "string",
|
|
3022
|
+
"enum": [
|
|
3023
|
+
"He/Him",
|
|
3024
|
+
"He/They",
|
|
3025
|
+
"Not Listed",
|
|
3026
|
+
"She/Her",
|
|
3027
|
+
"She/They",
|
|
3028
|
+
"They/Them"
|
|
3029
|
+
]
|
|
3030
|
+
},
|
|
3031
|
+
{
|
|
3032
|
+
"type": "null"
|
|
3033
|
+
}
|
|
3034
|
+
],
|
|
3035
|
+
"description": "The lead’s personal pronouns, reflecting their gender identity. Others can use these pronouns to refer to the lead in the third person. The entry is selected from a picklist of available values, which the administrator sets. Maximum 40 characters."
|
|
3036
|
+
},
|
|
3037
|
+
"Rating": {
|
|
3038
|
+
"type": [
|
|
3039
|
+
"string",
|
|
3040
|
+
"null"
|
|
3041
|
+
],
|
|
3042
|
+
"description": "Rating of the lead."
|
|
3043
|
+
},
|
|
3044
|
+
"RecordTypeId": {
|
|
3045
|
+
"$ref": "#/$defs/NullableId",
|
|
3046
|
+
"description": "ID of the record type assigned to this object."
|
|
3047
|
+
},
|
|
3048
|
+
"Salutation": {
|
|
3049
|
+
"type": [
|
|
3050
|
+
"string",
|
|
3051
|
+
"null"
|
|
3052
|
+
],
|
|
3053
|
+
"description": "Salutation for the lead."
|
|
3054
|
+
},
|
|
3055
|
+
"ScheduledResumeDateTime": {
|
|
3056
|
+
"anyOf": [
|
|
3057
|
+
{
|
|
3058
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3059
|
+
},
|
|
3060
|
+
{
|
|
3061
|
+
"type": "null"
|
|
3062
|
+
}
|
|
3063
|
+
],
|
|
3064
|
+
"description": "The date and time when the action cadence tracker is going to resume after it’s paused or on a wait step. This field is available in API version 54.0 and later when the Sales Engagement license is enabled. To see this field, the user also needs the Sales Engagement User or Sales Engagement Quick Cadence Creator user permission set.",
|
|
3065
|
+
"readOnly": true
|
|
3066
|
+
},
|
|
3067
|
+
"ScoreIntelligenceId": {
|
|
3068
|
+
"$ref": "#/$defs/NullableId",
|
|
3069
|
+
"description": "The ID of the intelligent field record that contains lead score.",
|
|
3070
|
+
"readOnly": true
|
|
3071
|
+
},
|
|
3072
|
+
"State": {
|
|
3073
|
+
"type": [
|
|
3074
|
+
"string",
|
|
3075
|
+
"null"
|
|
3076
|
+
],
|
|
3077
|
+
"description": "State for the address of the lead."
|
|
3078
|
+
},
|
|
3079
|
+
"StateCode": {
|
|
3080
|
+
"type": [
|
|
3081
|
+
"string",
|
|
3082
|
+
"null"
|
|
3083
|
+
],
|
|
3084
|
+
"description": "The ISO state code for the lead’s address."
|
|
3085
|
+
},
|
|
3086
|
+
"Status": {
|
|
3087
|
+
"type": "string",
|
|
3088
|
+
"description": "Status code for this converted lead. Status codes are defined in Status and represented in the API by the LeadStatus object."
|
|
3089
|
+
},
|
|
3090
|
+
"Street": {
|
|
3091
|
+
"type": [
|
|
3092
|
+
"string",
|
|
3093
|
+
"null"
|
|
3094
|
+
],
|
|
3095
|
+
"description": "Street number and name for the address of the lead."
|
|
3096
|
+
},
|
|
3097
|
+
"Suffix": {
|
|
3098
|
+
"type": [
|
|
3099
|
+
"string",
|
|
3100
|
+
"null"
|
|
3101
|
+
],
|
|
3102
|
+
"maxLength": 40,
|
|
3103
|
+
"description": "The lead’s name suffix. Maximum size is 40 characters."
|
|
3104
|
+
},
|
|
3105
|
+
"Title": {
|
|
3106
|
+
"type": [
|
|
3107
|
+
"string",
|
|
3108
|
+
"null"
|
|
3109
|
+
],
|
|
3110
|
+
"maxLength": 128,
|
|
3111
|
+
"description": "Title for the lead, such as CFO or CEO. The maximum size is 128 characters. When converting a lead to a person account, the conversion fails if the lead Title field contains more than 80 characters."
|
|
3112
|
+
},
|
|
3113
|
+
"Website": {
|
|
3114
|
+
"type": [
|
|
3115
|
+
"string",
|
|
3116
|
+
"null"
|
|
3117
|
+
],
|
|
3118
|
+
"description": "Website for the lead."
|
|
3119
|
+
}
|
|
3120
|
+
},
|
|
3121
|
+
"required": [
|
|
3122
|
+
"Id"
|
|
3123
|
+
],
|
|
3124
|
+
"additionalProperties": false
|
|
3125
|
+
},
|
|
3126
|
+
"Opportunity": {
|
|
3127
|
+
"type": "object",
|
|
3128
|
+
"description": "Opportunity fields documented by the pinned Winter 27 Object Reference. Properties are the union of documented read/create forms; only Id is universally required by this stored entity so SOQL projections remain ingestible.",
|
|
3129
|
+
"properties": {
|
|
3130
|
+
"Id": {
|
|
3131
|
+
"$ref": "base.json#/$defs/Id",
|
|
3132
|
+
"description": "Unique Salesforce record identifier.",
|
|
3133
|
+
"readOnly": true
|
|
3134
|
+
},
|
|
3135
|
+
"AccountId": {
|
|
3136
|
+
"$ref": "#/$defs/NullableId",
|
|
3137
|
+
"description": "ID of the account associated with this opportunity."
|
|
3138
|
+
},
|
|
3139
|
+
"ActivityMetricId": {
|
|
3140
|
+
"$ref": "#/$defs/NullableId",
|
|
3141
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric.",
|
|
3142
|
+
"readOnly": true
|
|
3143
|
+
},
|
|
3144
|
+
"ActivityMetricRollupId": {
|
|
3145
|
+
"$ref": "#/$defs/NullableId",
|
|
3146
|
+
"description": "When Einstein Activity Capture with Activity Metrics is enabled, the ID of the related activity metric rollup.",
|
|
3147
|
+
"readOnly": true
|
|
3148
|
+
},
|
|
3149
|
+
"AgeInDays": {
|
|
3150
|
+
"type": [
|
|
3151
|
+
"integer",
|
|
3152
|
+
"null"
|
|
3153
|
+
],
|
|
3154
|
+
"description": "The number of days since the opportunity was created, calculated by the current date minus the created_date field. This field is available in API version 52.0 and later if you enabled Pipeline Inspection.",
|
|
3155
|
+
"readOnly": true
|
|
3156
|
+
},
|
|
3157
|
+
"Amount": {
|
|
3158
|
+
"type": [
|
|
3159
|
+
"number",
|
|
3160
|
+
"null"
|
|
3161
|
+
],
|
|
3162
|
+
"description": "Estimated total sale amount. For opportunities with products, the amount is the sum of the related products. Any attempt to update this field, if the record has products, will be ignored. The update call will not be rejected, and other fields will be updated as specified, but the Amount will be unchanged."
|
|
3163
|
+
},
|
|
3164
|
+
"CampaignId": {
|
|
3165
|
+
"$ref": "#/$defs/NullableId",
|
|
3166
|
+
"description": "ID of a related Campaign. This field is defined only for those organizations that have the campaign feature Campaigns enabled. The User must have read access rights to the cross-referenced Campaign object in order to create or update that campaign into this field on the opportunity."
|
|
3167
|
+
},
|
|
3168
|
+
"CloseDate": {
|
|
3169
|
+
"type": "string",
|
|
3170
|
+
"minLength": 10,
|
|
3171
|
+
"maxLength": 10,
|
|
3172
|
+
"format": "date",
|
|
3173
|
+
"description": "Required. Date when the opportunity is expected to close."
|
|
3174
|
+
},
|
|
3175
|
+
"ConnectionReceivedId": {
|
|
3176
|
+
"$ref": "#/$defs/NullableId",
|
|
3177
|
+
"description": "ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.",
|
|
3178
|
+
"readOnly": true
|
|
3179
|
+
},
|
|
3180
|
+
"ConnectionSentId": {
|
|
3181
|
+
"$ref": "#/$defs/NullableId",
|
|
3182
|
+
"description": "ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.",
|
|
3183
|
+
"readOnly": true
|
|
3184
|
+
},
|
|
3185
|
+
"ContactId": {
|
|
3186
|
+
"$ref": "#/$defs/NullableId",
|
|
3187
|
+
"description": "ID of the contact associated with this opportunity, set as the primary contact. Read-only field that is derived from the opportunity contact role, which is created at the same time the opportunity is created. This field can only be populated when it’s created, and can’t be updated. To update the value in this field, change the IsPrimary flag on the OpportunityContactRole associated with this opportunity. Available in API version 46.0 and later."
|
|
3188
|
+
},
|
|
3189
|
+
"ContractId": {
|
|
3190
|
+
"$ref": "#/$defs/NullableId",
|
|
3191
|
+
"description": "ID of the contract that’s associated with this opportunity."
|
|
3192
|
+
},
|
|
3193
|
+
"CurrencyIsoCode": {
|
|
3194
|
+
"type": [
|
|
3195
|
+
"string",
|
|
3196
|
+
"null"
|
|
3197
|
+
],
|
|
3198
|
+
"description": "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
|
|
3199
|
+
},
|
|
3200
|
+
"Description": {
|
|
3201
|
+
"type": [
|
|
3202
|
+
"string",
|
|
3203
|
+
"null"
|
|
3204
|
+
],
|
|
3205
|
+
"maxLength": 32000,
|
|
3206
|
+
"description": "Text description of the opportunity. Limit: 32,000 characters."
|
|
3207
|
+
},
|
|
3208
|
+
"ExpectedRevenue": {
|
|
3209
|
+
"type": [
|
|
3210
|
+
"number",
|
|
3211
|
+
"null"
|
|
3212
|
+
],
|
|
3213
|
+
"description": "Read-only field that is equal to the product of the opportunity Amount field and the Probability . You can’t directly set this field, but you can indirectly set it by setting the Amount or Probability fields.",
|
|
3214
|
+
"readOnly": true
|
|
3215
|
+
},
|
|
3216
|
+
"ExportStatus": {
|
|
3217
|
+
"type": "string",
|
|
3218
|
+
"description": "Derived field for the record map for Partner Connect. The export status of this opportunity to the partner’s connected org. To see this field, enable Partner Connect and add the Export Vendor Records to an Authorized Partner Org user permission to the cosell export user. See Set Up Partner Connect as a Vendor in Salesforce Help . Available in API version 62.0 and later.",
|
|
3219
|
+
"readOnly": true
|
|
3220
|
+
},
|
|
3221
|
+
"Fiscal": {
|
|
3222
|
+
"type": [
|
|
3223
|
+
"string",
|
|
3224
|
+
"null"
|
|
3225
|
+
],
|
|
3226
|
+
"description": "If fiscal years are not enabled, the name of the fiscal quarter or period in which the opportunity CloseDate falls. Use YYYY Q format, for example, '2006 1' for first quarter of 2006.",
|
|
3227
|
+
"readOnly": true
|
|
3228
|
+
},
|
|
3229
|
+
"FiscalQuarter": {
|
|
3230
|
+
"type": [
|
|
3231
|
+
"integer",
|
|
3232
|
+
"null"
|
|
3233
|
+
],
|
|
3234
|
+
"description": "Represents the fiscal quarter. Valid values are 1, 2, 3, or 4.",
|
|
3235
|
+
"readOnly": true
|
|
3236
|
+
},
|
|
3237
|
+
"FiscalYear": {
|
|
3238
|
+
"type": [
|
|
3239
|
+
"integer",
|
|
3240
|
+
"null"
|
|
3241
|
+
],
|
|
3242
|
+
"description": "Represents the fiscal year, for example, 2006.",
|
|
3243
|
+
"readOnly": true
|
|
3244
|
+
},
|
|
3245
|
+
"ForecastCategory": {
|
|
3246
|
+
"type": "string",
|
|
3247
|
+
"enum": [
|
|
3248
|
+
"BestCase",
|
|
3249
|
+
"Closed",
|
|
3250
|
+
"Forecast",
|
|
3251
|
+
"MostLikely",
|
|
3252
|
+
"Omitted",
|
|
3253
|
+
"Pipeline"
|
|
3254
|
+
],
|
|
3255
|
+
"description": "Restricted picklist field. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than is implied by the StageName value. The values of this field are fixed enumerated values. The field labels are localized to the language of the user performing the operation, if localized versions of those labels are available for that language in the user interface. In API version 12.0 and later, the value of this field is automatically set based on the value of the ForecastCategoryName and can’t be updated any other way. The field properties Create, Defaulted on create, Nillable, and Update are not available in version 12.0.",
|
|
3256
|
+
"readOnly": true
|
|
3257
|
+
},
|
|
3258
|
+
"ForecastCategoryName": {
|
|
3259
|
+
"anyOf": [
|
|
3260
|
+
{
|
|
3261
|
+
"type": "string",
|
|
3262
|
+
"enum": [
|
|
3263
|
+
"Best Case",
|
|
3264
|
+
"Closed",
|
|
3265
|
+
"Commit",
|
|
3266
|
+
"Most Likely",
|
|
3267
|
+
"Omitted",
|
|
3268
|
+
"Pipeline"
|
|
3269
|
+
]
|
|
3270
|
+
},
|
|
3271
|
+
{
|
|
3272
|
+
"type": "null"
|
|
3273
|
+
}
|
|
3274
|
+
],
|
|
3275
|
+
"description": "The name of the forecast category. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than is implied by the StageName value. Available in API version 12.0 and later."
|
|
3276
|
+
},
|
|
3277
|
+
"HasOpenActivity": {
|
|
3278
|
+
"type": "string",
|
|
3279
|
+
"description": "Indicates whether an opportunity has an open event or task ( true ) or not ( false ). Available in API version 35.0 and later.",
|
|
3280
|
+
"readOnly": true
|
|
3281
|
+
},
|
|
3282
|
+
"HasOpportunityLineItem": {
|
|
3283
|
+
"type": "string",
|
|
3284
|
+
"description": "Read-only field that indicates whether the opportunity has associated line items. A value of true means that Opportunity line items have been created for the opportunity. An opportunity can have opportunity line items only if the opportunity has a price book. The opportunity line items must correspond to PricebookEntry objects that are listed in the opportunity Pricebook2. However, you can insert opportunity line items on an opportunity that does not have an associated Pricebook2. For the first opportunity line item that you insert on an opportunity without a Pricebook2, the API automatically sets the Pricebook2Id field, if the opportunity line item corresponds to a PricebookEntry in an active Pricebook2 that has a CurrencyIsoCode field that matches the CurrencyIsoCode field of the opportunity. If the Pricebook2 is not active or the CurrencyIsoCode fields do not match, then the API returns an error. You can’t update the Pricebook2Id or PricebookId fields if opportunity line items exist on the Opportunity. You must delete the line items before attempting to update the PricebookId field.",
|
|
3285
|
+
"readOnly": true
|
|
3286
|
+
},
|
|
3287
|
+
"HasOverdueTask": {
|
|
3288
|
+
"type": "string",
|
|
3289
|
+
"description": "Indicates whether an opportunity has an overdue task ( true ) or not ( false ). Available in API version 35.0 and later.",
|
|
3290
|
+
"readOnly": true
|
|
3291
|
+
},
|
|
3292
|
+
"IqScore": {
|
|
3293
|
+
"type": [
|
|
3294
|
+
"integer",
|
|
3295
|
+
"null"
|
|
3296
|
+
],
|
|
3297
|
+
"description": "The likelihood, measured on a scale of 1 to 99, that an opportunity will be won. Einstein Opportunity Scoring must be enabled. Available in API version 41.0 and later. Label is Opportunity Score .",
|
|
3298
|
+
"readOnly": true
|
|
3299
|
+
},
|
|
3300
|
+
"IsClosed": {
|
|
3301
|
+
"type": "boolean",
|
|
3302
|
+
"description": "Directly controlled by StageName . You can query and filter on this field, but you can’t directly set it in a create, upsert, or update request. It can only be set via StageName . Label is Closed .",
|
|
3303
|
+
"readOnly": true
|
|
3304
|
+
},
|
|
3305
|
+
"IsDeleted": {
|
|
3306
|
+
"type": "string",
|
|
3307
|
+
"description": "Indicates whether the object has been moved to the Recycle Bin ( true ) or not ( false ). Label is Deleted .",
|
|
3308
|
+
"readOnly": true
|
|
3309
|
+
},
|
|
3310
|
+
"IsExcludedFromTerritory2Filter": {
|
|
3311
|
+
"type": "string",
|
|
3312
|
+
"description": "Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / API version 33). Indicates whether the opportunity is excluded ( True ) or included ( False ) each time the APEX filter is executed."
|
|
3313
|
+
},
|
|
3314
|
+
"IsPriorityRecord": {
|
|
3315
|
+
"type": "string",
|
|
3316
|
+
"description": "Shows whether the user has marked the opportunity as important ( True ) or not ( False ). The default value is false . Available in API version 53.0 and later.",
|
|
3317
|
+
"readOnly": true
|
|
3318
|
+
},
|
|
3319
|
+
"IsPrivate": {
|
|
3320
|
+
"type": "string",
|
|
3321
|
+
"description": "If true , only the opportunity owner, users above that role in the hierarchy, and admins can view the opportunity or query it via the API. When you mark opportunities as private, opportunity teams, opportunity splits, and sharing are removed. Label is Private . The default value is False ."
|
|
3322
|
+
},
|
|
3323
|
+
"IsSplit": {
|
|
3324
|
+
"type": "string",
|
|
3325
|
+
"description": "Read-only field that indicates whether credit for the opportunity is split between opportunity team members. Label is IsSplit . This field is available in versions 14.0 and later for organizations that enabled Opportunity Splits during the pilot period.",
|
|
3326
|
+
"readOnly": true
|
|
3327
|
+
},
|
|
3328
|
+
"IsWon": {
|
|
3329
|
+
"type": "boolean",
|
|
3330
|
+
"description": "Directly controlled by StageName . You can query and filter on this field, but you can’t directly set the value. It can only be set via StageName . Label is Won .",
|
|
3331
|
+
"readOnly": true
|
|
3332
|
+
},
|
|
3333
|
+
"LastActivityDate": {
|
|
3334
|
+
"type": [
|
|
3335
|
+
"string",
|
|
3336
|
+
"null"
|
|
3337
|
+
],
|
|
3338
|
+
"minLength": 10,
|
|
3339
|
+
"maxLength": 10,
|
|
3340
|
+
"format": "date",
|
|
3341
|
+
"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.",
|
|
3342
|
+
"readOnly": true
|
|
3343
|
+
},
|
|
3344
|
+
"LastActivityInDays": {
|
|
3345
|
+
"type": [
|
|
3346
|
+
"integer",
|
|
3347
|
+
"null"
|
|
3348
|
+
],
|
|
3349
|
+
"description": "The number of days since the last completed event or task for the record, calculated by the current date minus the last_activity field. If the last_activity field is null, this field is null. This field is available in API version 52.0 and later if you enabled Pipeline Inspection.",
|
|
3350
|
+
"readOnly": true
|
|
3351
|
+
},
|
|
3352
|
+
"LastAmountChangedHistoryId": {
|
|
3353
|
+
"$ref": "#/$defs/NullableId",
|
|
3354
|
+
"description": "ID of the OpportunityHistory record that contains information about when the opportunity Amount field was last updated in Winter ’21 or later. Information includes the date and time of the change and the user who made the change. Available in API version 50.0 and later.",
|
|
3355
|
+
"readOnly": true
|
|
3356
|
+
},
|
|
3357
|
+
"LastCloseDateChangedHistoryId": {
|
|
3358
|
+
"$ref": "#/$defs/NullableId",
|
|
3359
|
+
"description": "ID of the OpportunityHistory record that contains information about when the opportunity Close Date field was last updated in Winter ’21 or later. Information includes the date and time of the change and the user who made the change. Available in API version 50.0 and later.",
|
|
3360
|
+
"readOnly": true
|
|
3361
|
+
},
|
|
3362
|
+
"LastReferencedDate": {
|
|
3363
|
+
"anyOf": [
|
|
3364
|
+
{
|
|
3365
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3366
|
+
},
|
|
3367
|
+
{
|
|
3368
|
+
"type": "null"
|
|
3369
|
+
}
|
|
3370
|
+
],
|
|
3371
|
+
"description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view.",
|
|
3372
|
+
"readOnly": true
|
|
3373
|
+
},
|
|
3374
|
+
"LastStageChangeDate": {
|
|
3375
|
+
"anyOf": [
|
|
3376
|
+
{
|
|
3377
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3378
|
+
},
|
|
3379
|
+
{
|
|
3380
|
+
"type": "null"
|
|
3381
|
+
}
|
|
3382
|
+
],
|
|
3383
|
+
"description": "The date of the last change made to the Stage field on this opportunity record. This field is available in API version 52.0 and later.",
|
|
3384
|
+
"readOnly": true
|
|
3385
|
+
},
|
|
3386
|
+
"LastStageChangeInDays": {
|
|
3387
|
+
"type": [
|
|
3388
|
+
"integer",
|
|
3389
|
+
"null"
|
|
3390
|
+
],
|
|
3391
|
+
"description": "The number of days since the last change was made to the Stage field on the opportunity record, calculated by the current date minus the last_stage_change_date field. If the last_stage_change_date is null, then this field contains the value for AgeInDays . This field is available in API version 52.0 and later if you enabled Pipeline Inspection.",
|
|
3392
|
+
"readOnly": true
|
|
3393
|
+
},
|
|
3394
|
+
"LastViewedDate": {
|
|
3395
|
+
"anyOf": [
|
|
3396
|
+
{
|
|
3397
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3398
|
+
},
|
|
3399
|
+
{
|
|
3400
|
+
"type": "null"
|
|
3401
|
+
}
|
|
3402
|
+
],
|
|
3403
|
+
"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.",
|
|
3404
|
+
"readOnly": true
|
|
3405
|
+
},
|
|
3406
|
+
"LeadSource": {
|
|
3407
|
+
"type": [
|
|
3408
|
+
"string",
|
|
3409
|
+
"null"
|
|
3410
|
+
],
|
|
3411
|
+
"description": "Source of this opportunity, such as Advertisement or Trade Show."
|
|
3412
|
+
},
|
|
3413
|
+
"Name": {
|
|
3414
|
+
"type": "string",
|
|
3415
|
+
"maxLength": 120,
|
|
3416
|
+
"description": "Required. A name for this opportunity. Limit: 120 characters."
|
|
3417
|
+
},
|
|
3418
|
+
"NextStep": {
|
|
3419
|
+
"type": [
|
|
3420
|
+
"string",
|
|
3421
|
+
"null"
|
|
3422
|
+
],
|
|
3423
|
+
"maxLength": 255,
|
|
3424
|
+
"description": "Description of next task in closing opportunity. Limit: 255 characters."
|
|
3425
|
+
},
|
|
3426
|
+
"OwnerId": {
|
|
3427
|
+
"$ref": "base.json#/$defs/Id",
|
|
3428
|
+
"description": "ID of the User who has been assigned to work this opportunity. If you update this field, the previous owner's access becomes Read Only or the access specified in your organization-wide default for opportunities, whichever is greater. If you have set up opportunity teams in your organization, 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. (All previous opportunity team members are kept on the opportunity team.) For API version before 12.0, sharing records are deleted. (All previous opportunity team members are removed from the opportunity team.) For API version 16.0 and later, users must have the Transfer Record permission in order to update (transfer) account ownership using this field."
|
|
3429
|
+
},
|
|
3430
|
+
"PartnerAccountId": {
|
|
3431
|
+
"$ref": "#/$defs/NullableId",
|
|
3432
|
+
"description": "ID of the partner account for the partner user that owns this opportunity. Available if Partner Relationship Management is enabled or if digital experiences is enabled and you have partner portal licenses.",
|
|
3433
|
+
"readOnly": true
|
|
3434
|
+
},
|
|
3435
|
+
"Pricebook2Id": {
|
|
3436
|
+
"$ref": "#/$defs/NullableId",
|
|
3437
|
+
"description": "ID of a related Pricebook2 object. The Pricebook2Id field indicates which Pricebook2 applies to this opportunity. The Pricebook2Id field is defined only for those organizations that have products enabled as a feature. You can specify values for only one field ( Pricebook2Id or PricebookId )—not both fields. For this reason, both fields are declared nillable."
|
|
3438
|
+
},
|
|
3439
|
+
"PricebookId": {
|
|
3440
|
+
"$ref": "#/$defs/NullableId",
|
|
3441
|
+
"description": "Unavailable as of version 3.0. As of version 8.0, the Pricebook object is no longer available. Use the Pricebook2Id field instead, specifying the ID of the Pricebook2 record."
|
|
3442
|
+
},
|
|
3443
|
+
"Probability": {
|
|
3444
|
+
"type": [
|
|
3445
|
+
"number",
|
|
3446
|
+
"null"
|
|
3447
|
+
],
|
|
3448
|
+
"minimum": 0,
|
|
3449
|
+
"maximum": 100,
|
|
3450
|
+
"description": "Percentage of estimated confidence in closing the opportunity. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than what is implied by the StageName ."
|
|
3451
|
+
},
|
|
3452
|
+
"PushCount": {
|
|
3453
|
+
"type": [
|
|
3454
|
+
"integer",
|
|
3455
|
+
"null"
|
|
3456
|
+
],
|
|
3457
|
+
"description": "The number of times an opportunity’s close date has been pushed out by one calendar month. For example, moving a close date from April to May counts as one push, but moving from April 1 to April 30 doesn't count. The total is not decreased when the close date is moved in. Available in API version 53.0 and later.",
|
|
3458
|
+
"readOnly": true
|
|
3459
|
+
},
|
|
3460
|
+
"RecordTypeId": {
|
|
3461
|
+
"$ref": "#/$defs/NullableId",
|
|
3462
|
+
"description": "ID of the record type assigned to this object."
|
|
3463
|
+
},
|
|
3464
|
+
"StageName": {
|
|
3465
|
+
"type": "string",
|
|
3466
|
+
"description": "Required. Current stage of this record. The StageName field controls several other fields on an opportunity. Each of the fields can be directly set or implied by changing the StageName field. In addition, the StageName field is a picklist, so it has additional members in the returned describeSObjectResult to indicate how it affects the other fields. To obtain the stage name values in the picklist, query the OpportunityStage object. If the StageName is updated, then the ForecastCategoryName , IsClosed , IsWon , and Probability are automatically updated based on the stage-category mapping."
|
|
3467
|
+
},
|
|
3468
|
+
"SyncedQuoteID": {
|
|
3469
|
+
"$ref": "#/$defs/NullableId",
|
|
3470
|
+
"description": "Read only in an Apex trigger. The ID of the Quote that syncs with the opportunity. Setting this field lets you start and stop syncing between the opportunity and a quote. The ID has to be for a quote that is a child of the opportunity."
|
|
3471
|
+
},
|
|
3472
|
+
"Territory2Id": {
|
|
3473
|
+
"$ref": "#/$defs/NullableId",
|
|
3474
|
+
"description": "The ID of the territory that is assigned to the opportunity. Available only if Enterprise Territory Management has been enabled for your organization. Users who have full access to an opportunity’s account can assign any territory from the active model to the opportunity. Users who do not can assign only a territory that is also assigned to the opportunity’s account. The same restriction applies to territory assignments made via Apex in system mode."
|
|
3475
|
+
},
|
|
3476
|
+
"TotalOpportunityQuantity": {
|
|
3477
|
+
"type": [
|
|
3478
|
+
"number",
|
|
3479
|
+
"null"
|
|
3480
|
+
],
|
|
3481
|
+
"description": "Number of items included in this opportunity. Used in quantity-based forecasting."
|
|
3482
|
+
},
|
|
3483
|
+
"Type": {
|
|
3484
|
+
"type": [
|
|
3485
|
+
"string",
|
|
3486
|
+
"null"
|
|
3487
|
+
],
|
|
3488
|
+
"description": "Type of opportunity. For example, Existing Business or New Business. Label is Opportunity Type ."
|
|
3489
|
+
}
|
|
3490
|
+
},
|
|
3491
|
+
"required": [
|
|
3492
|
+
"Id"
|
|
3493
|
+
],
|
|
3494
|
+
"additionalProperties": false
|
|
3495
|
+
},
|
|
3496
|
+
"Case": {
|
|
3497
|
+
"type": "object",
|
|
3498
|
+
"description": "Case fields documented by the pinned Winter 27 Object Reference. Properties are the union of documented read/create forms; only Id is universally required by this stored entity so SOQL projections remain ingestible.",
|
|
3499
|
+
"properties": {
|
|
3500
|
+
"Id": {
|
|
3501
|
+
"$ref": "base.json#/$defs/Id",
|
|
3502
|
+
"description": "Unique Salesforce record identifier.",
|
|
3503
|
+
"readOnly": true
|
|
3504
|
+
},
|
|
3505
|
+
"AccountId": {
|
|
3506
|
+
"$ref": "#/$defs/NullableId",
|
|
3507
|
+
"description": "ID of the account associated with this case."
|
|
3508
|
+
},
|
|
3509
|
+
"AssetWarrantyID": {
|
|
3510
|
+
"$ref": "#/$defs/NullableId",
|
|
3511
|
+
"description": "ID of the Asset associated with the warranty. Must be a valid asset warranty ID.",
|
|
3512
|
+
"readOnly": true
|
|
3513
|
+
},
|
|
3514
|
+
"BusinessHoursId": {
|
|
3515
|
+
"$ref": "base.json#/$defs/Id",
|
|
3516
|
+
"description": "ID of the business hours associated with this case."
|
|
3517
|
+
},
|
|
3518
|
+
"Comments": {
|
|
3519
|
+
"type": [
|
|
3520
|
+
"string",
|
|
3521
|
+
"null"
|
|
3522
|
+
],
|
|
3523
|
+
"description": "Used to insert a new CaseComment. Email textarea has a length of 4000 chars."
|
|
3524
|
+
},
|
|
3525
|
+
"CaseNumber": {
|
|
3526
|
+
"type": "string",
|
|
3527
|
+
"description": "Assigned automatically when each case is inserted. It can't be set directly, and it can't be modified after the case is created.",
|
|
3528
|
+
"readOnly": true
|
|
3529
|
+
},
|
|
3530
|
+
"ClosedDate": {
|
|
3531
|
+
"anyOf": [
|
|
3532
|
+
{
|
|
3533
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3534
|
+
},
|
|
3535
|
+
{
|
|
3536
|
+
"type": "null"
|
|
3537
|
+
}
|
|
3538
|
+
],
|
|
3539
|
+
"description": "The date and time when the case was closed.",
|
|
3540
|
+
"readOnly": true
|
|
3541
|
+
},
|
|
3542
|
+
"CommunityId": {
|
|
3543
|
+
"$ref": "#/$defs/NullableId",
|
|
3544
|
+
"description": "ID of the zone associated with this case."
|
|
3545
|
+
},
|
|
3546
|
+
"ConnectionReceivedId": {
|
|
3547
|
+
"$ref": "#/$defs/NullableId",
|
|
3548
|
+
"description": "ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.",
|
|
3549
|
+
"readOnly": true
|
|
3550
|
+
},
|
|
3551
|
+
"ConnectionSentId": {
|
|
3552
|
+
"$ref": "#/$defs/NullableId",
|
|
3553
|
+
"description": "ID of the PartnerNetworkConnection that you shared this record with. This field is available if you enabled Salesforce to Salesforce. This field is supported using API versions earlier than 15.0. In all other API versions, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.",
|
|
3554
|
+
"readOnly": true
|
|
3555
|
+
},
|
|
3556
|
+
"ContactEmail": {
|
|
3557
|
+
"type": [
|
|
3558
|
+
"string",
|
|
3559
|
+
"null"
|
|
3560
|
+
],
|
|
3561
|
+
"description": "Email address for the contact. The Case.ContactEmail field displays the Email field on the contact that is referenced by Case.ContactId. Label is Contact Email . This field is available in API version 38.0 and later.",
|
|
3562
|
+
"readOnly": true
|
|
3563
|
+
},
|
|
3564
|
+
"ContactFax": {
|
|
3565
|
+
"type": [
|
|
3566
|
+
"string",
|
|
3567
|
+
"null"
|
|
3568
|
+
],
|
|
3569
|
+
"description": "Fax number for the contact. Label is Contact Fax . This field is available in API version 38.0 and later.",
|
|
3570
|
+
"readOnly": true
|
|
3571
|
+
},
|
|
3572
|
+
"ContactId": {
|
|
3573
|
+
"$ref": "#/$defs/NullableId",
|
|
3574
|
+
"description": "ID of the associated contact."
|
|
3575
|
+
},
|
|
3576
|
+
"ContactMobile": {
|
|
3577
|
+
"type": [
|
|
3578
|
+
"string",
|
|
3579
|
+
"null"
|
|
3580
|
+
],
|
|
3581
|
+
"description": "Mobile telephone number for the contact. Label is Contact Mobile . This field is available in API version 38.0 and later.",
|
|
3582
|
+
"readOnly": true
|
|
3583
|
+
},
|
|
3584
|
+
"ContactPhone": {
|
|
3585
|
+
"type": [
|
|
3586
|
+
"string",
|
|
3587
|
+
"null"
|
|
3588
|
+
],
|
|
3589
|
+
"description": "Telephone number for the contact. Label is Contact Phone . This field is available in API version 38.0 and later.",
|
|
3590
|
+
"readOnly": true
|
|
3591
|
+
},
|
|
3592
|
+
"CreatorFullPhotoUrl": {
|
|
3593
|
+
"type": [
|
|
3594
|
+
"string",
|
|
3595
|
+
"null"
|
|
3596
|
+
],
|
|
3597
|
+
"description": "URL of the user’s profile photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.",
|
|
3598
|
+
"readOnly": true
|
|
3599
|
+
},
|
|
3600
|
+
"CreatorName": {
|
|
3601
|
+
"type": [
|
|
3602
|
+
"string",
|
|
3603
|
+
"null"
|
|
3604
|
+
],
|
|
3605
|
+
"description": "Name of the user who posted the question or reply. Only the first name of internal users (agents) appears to portal users in the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.",
|
|
3606
|
+
"readOnly": true
|
|
3607
|
+
},
|
|
3608
|
+
"CreatorSmallPhotoUrl": {
|
|
3609
|
+
"type": [
|
|
3610
|
+
"string",
|
|
3611
|
+
"null"
|
|
3612
|
+
],
|
|
3613
|
+
"description": "URL of the user’s thumbnail photo from the feed. Chatter Answers must be enabled to view this field. This field is available in API version 26.0 and later.",
|
|
3614
|
+
"readOnly": true
|
|
3615
|
+
},
|
|
3616
|
+
"Description": {
|
|
3617
|
+
"type": [
|
|
3618
|
+
"string",
|
|
3619
|
+
"null"
|
|
3620
|
+
],
|
|
3621
|
+
"description": "A text description of the case. Limit: 32 KB."
|
|
3622
|
+
},
|
|
3623
|
+
"FeedItemId": {
|
|
3624
|
+
"$ref": "#/$defs/NullableId",
|
|
3625
|
+
"description": "ID of the question in Chatter associated with the case. This field is available in API version 33.0 and later, and is only accessible in organizations where Question-to-Case is enabled."
|
|
3626
|
+
},
|
|
3627
|
+
"HasCommentsUnreadByOwner": {
|
|
3628
|
+
"type": "string",
|
|
3629
|
+
"description": "Indicates whether a case contains comments that the case owner hasn’t read ( true ) or not ( false ).",
|
|
3630
|
+
"readOnly": true
|
|
3631
|
+
},
|
|
3632
|
+
"HasSelfServiceComments": {
|
|
3633
|
+
"type": "string",
|
|
3634
|
+
"description": "Indicates whether a case has comments added by a Self-Service user ( true ) or not ( false ). Only visible when Customer Portal is enabled.",
|
|
3635
|
+
"readOnly": true
|
|
3636
|
+
},
|
|
3637
|
+
"IsClosed": {
|
|
3638
|
+
"type": "string",
|
|
3639
|
+
"description": "Indicates whether the case is closed ( true ) or open ( false ). This field is controlled by the Status field; it can't be set directly. Label is Closed .",
|
|
3640
|
+
"readOnly": true
|
|
3641
|
+
},
|
|
3642
|
+
"IsClosedOnCreate": {
|
|
3643
|
+
"type": "string",
|
|
3644
|
+
"description": "Indicates whether the case was closed at the same time that it was created ( true ) or not ( false ). This flag is read-only and is automatically set when a record is created. It can't be set to true unless the IsClosed flag is also true .",
|
|
3645
|
+
"readOnly": true
|
|
3646
|
+
},
|
|
3647
|
+
"IsDeleted": {
|
|
3648
|
+
"type": "string",
|
|
3649
|
+
"description": "Indicates whether the object has been moved to the Recycle Bin ( true ) or not ( false ). Label is Deleted .",
|
|
3650
|
+
"readOnly": true
|
|
3651
|
+
},
|
|
3652
|
+
"IsEscalated": {
|
|
3653
|
+
"type": "string",
|
|
3654
|
+
"description": "Indicates whether the case has been escalated ( true ) or not. A case's escalated state does not affect how you can use a case, or whether you can query, delete, or update it. You can set this flag via the API. Label is Escalated ."
|
|
3655
|
+
},
|
|
3656
|
+
"IsSelfServiceClosed": {
|
|
3657
|
+
"type": "string",
|
|
3658
|
+
"description": "Indicates whether the case is closed for Self-Service users ( true ) or not ( false ).",
|
|
3659
|
+
"readOnly": true
|
|
3660
|
+
},
|
|
3661
|
+
"IsStopped": {
|
|
3662
|
+
"type": "string",
|
|
3663
|
+
"description": "Indicates whether an entitlement process on a case is stopped ( true ) or not ( false )."
|
|
3664
|
+
},
|
|
3665
|
+
"IsVisibleInSelfService": {
|
|
3666
|
+
"type": "string",
|
|
3667
|
+
"description": "Indicates whether the case can be viewed in the Customer Service Portal, Partner Service Portal, and Self-Service Portal ( true ) or not ( false ). This field is applied for case visibility in the Partner Relationship Management, Customer Service Portal, and the earlier version of Self Service Portal. The field does not alter sharing and will not prevent usage of a direct URL to a case if a portal user has read or write access.",
|
|
3668
|
+
"readOnly": true
|
|
3669
|
+
},
|
|
3670
|
+
"Language": {
|
|
3671
|
+
"type": [
|
|
3672
|
+
"string",
|
|
3673
|
+
"null"
|
|
3674
|
+
],
|
|
3675
|
+
"description": "The language of the case. The Language field is available when you enable Einstein Case Classification in Enterprise, Performance, and Unlimited edition orgs with Service Cloud. By default, only Einstein classification apps use this field."
|
|
3676
|
+
},
|
|
3677
|
+
"LastReferencedDate": {
|
|
3678
|
+
"anyOf": [
|
|
3679
|
+
{
|
|
3680
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3681
|
+
},
|
|
3682
|
+
{
|
|
3683
|
+
"type": "null"
|
|
3684
|
+
}
|
|
3685
|
+
],
|
|
3686
|
+
"description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view.",
|
|
3687
|
+
"readOnly": true
|
|
3688
|
+
},
|
|
3689
|
+
"LastViewedDate": {
|
|
3690
|
+
"anyOf": [
|
|
3691
|
+
{
|
|
3692
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3693
|
+
},
|
|
3694
|
+
{
|
|
3695
|
+
"type": "null"
|
|
3696
|
+
}
|
|
3697
|
+
],
|
|
3698
|
+
"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.",
|
|
3699
|
+
"readOnly": true
|
|
3700
|
+
},
|
|
3701
|
+
"MasterRecordId": {
|
|
3702
|
+
"$ref": "#/$defs/NullableId",
|
|
3703
|
+
"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 .",
|
|
3704
|
+
"readOnly": true
|
|
3705
|
+
},
|
|
3706
|
+
"Origin": {
|
|
3707
|
+
"type": [
|
|
3708
|
+
"string",
|
|
3709
|
+
"null"
|
|
3710
|
+
],
|
|
3711
|
+
"description": "The source of the case, such as Email , Phone , or Web . Label is Case Origin ."
|
|
3712
|
+
},
|
|
3713
|
+
"OwnerId": {
|
|
3714
|
+
"$ref": "base.json#/$defs/Id",
|
|
3715
|
+
"description": "ID of the contact who owns the case."
|
|
3716
|
+
},
|
|
3717
|
+
"ParentId": {
|
|
3718
|
+
"$ref": "#/$defs/NullableId",
|
|
3719
|
+
"description": "The ID of the parent case in the hierarchy. The label is Parent Case ."
|
|
3720
|
+
},
|
|
3721
|
+
"Priority": {
|
|
3722
|
+
"type": [
|
|
3723
|
+
"string",
|
|
3724
|
+
"null"
|
|
3725
|
+
],
|
|
3726
|
+
"description": "The importance or urgency of the case, such as High , Medium , or Low ."
|
|
3727
|
+
},
|
|
3728
|
+
"QuestionId": {
|
|
3729
|
+
"$ref": "#/$defs/NullableId",
|
|
3730
|
+
"description": "The question in the answers zone that is associated with the case. This field does not appear if you don't have an answers zone enabled."
|
|
3731
|
+
},
|
|
3732
|
+
"Reason": {
|
|
3733
|
+
"type": [
|
|
3734
|
+
"string",
|
|
3735
|
+
"null"
|
|
3736
|
+
],
|
|
3737
|
+
"description": "The reason why the case was created, such as Instructions not clear , or User didn’t attend training ."
|
|
3738
|
+
},
|
|
3739
|
+
"RecordTypeId": {
|
|
3740
|
+
"$ref": "#/$defs/NullableId",
|
|
3741
|
+
"description": "ID of the record type assigned to this object."
|
|
3742
|
+
},
|
|
3743
|
+
"ServiceContractId": {
|
|
3744
|
+
"$ref": "#/$defs/NullableId",
|
|
3745
|
+
"description": "Required. ID of the ServiceContract associated with the entitlement. Must be a valid ID."
|
|
3746
|
+
},
|
|
3747
|
+
"SlaStartDate": {
|
|
3748
|
+
"anyOf": [
|
|
3749
|
+
{
|
|
3750
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3751
|
+
},
|
|
3752
|
+
{
|
|
3753
|
+
"type": "null"
|
|
3754
|
+
}
|
|
3755
|
+
],
|
|
3756
|
+
"description": "Shows the time that the case entered an entitlement process. If you have the Edit permission on cases, you can update or reset the time."
|
|
3757
|
+
},
|
|
3758
|
+
"SourceId": {
|
|
3759
|
+
"$ref": "#/$defs/NullableId",
|
|
3760
|
+
"description": "The ID of the social post source."
|
|
3761
|
+
},
|
|
3762
|
+
"Status": {
|
|
3763
|
+
"type": [
|
|
3764
|
+
"string",
|
|
3765
|
+
"null"
|
|
3766
|
+
],
|
|
3767
|
+
"description": "The status of the case, such as New, Closed, or Escalated. This field directly controls the IsClosed flag. Each predefined Status value implies an IsClosed flag value. For more information, see CaseStatus."
|
|
3768
|
+
},
|
|
3769
|
+
"StopStartDate": {
|
|
3770
|
+
"anyOf": [
|
|
3771
|
+
{
|
|
3772
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3773
|
+
},
|
|
3774
|
+
{
|
|
3775
|
+
"type": "null"
|
|
3776
|
+
}
|
|
3777
|
+
],
|
|
3778
|
+
"description": "The date and time an entitlement process was stopped on the case. This field is available in API version 18.0 and later.",
|
|
3779
|
+
"readOnly": true
|
|
3780
|
+
},
|
|
3781
|
+
"Subject": {
|
|
3782
|
+
"type": [
|
|
3783
|
+
"string",
|
|
3784
|
+
"null"
|
|
3785
|
+
],
|
|
3786
|
+
"maxLength": 255,
|
|
3787
|
+
"description": "The subject of the case. Limit: 255 characters."
|
|
3788
|
+
},
|
|
3789
|
+
"SuppliedCompany": {
|
|
3790
|
+
"type": [
|
|
3791
|
+
"string",
|
|
3792
|
+
"null"
|
|
3793
|
+
],
|
|
3794
|
+
"description": "The company name that was entered when the case was created. Label is Company ."
|
|
3795
|
+
},
|
|
3796
|
+
"SuppliedEmail": {
|
|
3797
|
+
"type": [
|
|
3798
|
+
"string",
|
|
3799
|
+
"null"
|
|
3800
|
+
],
|
|
3801
|
+
"description": "The email address that was entered when the case was created. Label is Email . If your organization has an active auto-response rule, SuppliedEmail is required when creating a case via the API. Auto-response rules use the email in the contact specified by ContactId . If no email address is in the contact record, the email specified here is used."
|
|
3802
|
+
},
|
|
3803
|
+
"SuppliedName": {
|
|
3804
|
+
"type": [
|
|
3805
|
+
"string",
|
|
3806
|
+
"null"
|
|
3807
|
+
],
|
|
3808
|
+
"description": "The name that was entered when the case was created. Label is Name ."
|
|
3809
|
+
},
|
|
3810
|
+
"SuppliedPhone": {
|
|
3811
|
+
"type": [
|
|
3812
|
+
"string",
|
|
3813
|
+
"null"
|
|
3814
|
+
],
|
|
3815
|
+
"description": "The phone number that was entered when the case was created. Label is Phone ."
|
|
3816
|
+
},
|
|
3817
|
+
"Type": {
|
|
3818
|
+
"type": [
|
|
3819
|
+
"string",
|
|
3820
|
+
"null"
|
|
3821
|
+
],
|
|
3822
|
+
"description": "The type of case, such as Feature Request or Question ."
|
|
3823
|
+
}
|
|
3824
|
+
},
|
|
3825
|
+
"required": [
|
|
3826
|
+
"Id"
|
|
3827
|
+
],
|
|
3828
|
+
"additionalProperties": false
|
|
3829
|
+
},
|
|
3830
|
+
"Task": {
|
|
3831
|
+
"type": "object",
|
|
3832
|
+
"description": "Task fields documented by the pinned Winter 27 Object Reference. Properties are the union of documented read/create forms; only Id is universally required by this stored entity so SOQL projections remain ingestible.",
|
|
3833
|
+
"properties": {
|
|
3834
|
+
"Id": {
|
|
3835
|
+
"$ref": "base.json#/$defs/Id",
|
|
3836
|
+
"description": "Unique Salesforce record identifier.",
|
|
3837
|
+
"readOnly": true
|
|
3838
|
+
},
|
|
3839
|
+
"AccountId": {
|
|
3840
|
+
"$ref": "#/$defs/NullableId",
|
|
3841
|
+
"description": "Represents the ID of the related Account. The AccountId is determined as follows. If the value of WhatId is any of these objects, Salesforce uses that object's AccountId . Account Opportunity Contract Custom object that is a child of Account If the value of the WhatId field is any other object, and the value of the WhoId field is a Contact object, then Salesforce uses that contact’s AccountId . (If your organization uses Shared Activities, then Salesforce uses the AccountId of the primary contact.) Otherwise, Salesforce sets the value of the AccountId field to null . For information on IDs, see ID Field Type.",
|
|
3842
|
+
"readOnly": true
|
|
3843
|
+
},
|
|
3844
|
+
"ActivityDate": {
|
|
3845
|
+
"type": [
|
|
3846
|
+
"string",
|
|
3847
|
+
"null"
|
|
3848
|
+
],
|
|
3849
|
+
"minLength": 10,
|
|
3850
|
+
"maxLength": 10,
|
|
3851
|
+
"format": "date",
|
|
3852
|
+
"description": "Represents the due date of the task. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it to accommodate time zone differences. Label is Due Date . This field can’t be set or updated for a recurring task ( IsRecurrence is true )."
|
|
3853
|
+
},
|
|
3854
|
+
"CallDisposition": {
|
|
3855
|
+
"type": [
|
|
3856
|
+
"string",
|
|
3857
|
+
"null"
|
|
3858
|
+
],
|
|
3859
|
+
"description": "Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."
|
|
3860
|
+
},
|
|
3861
|
+
"CallDurationInSeconds": {
|
|
3862
|
+
"type": [
|
|
3863
|
+
"integer",
|
|
3864
|
+
"null"
|
|
3865
|
+
],
|
|
3866
|
+
"description": "Duration of the call in seconds. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."
|
|
3867
|
+
},
|
|
3868
|
+
"CallObject": {
|
|
3869
|
+
"type": [
|
|
3870
|
+
"string",
|
|
3871
|
+
"null"
|
|
3872
|
+
],
|
|
3873
|
+
"description": "Name of a call center. Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."
|
|
3874
|
+
},
|
|
3875
|
+
"CallType": {
|
|
3876
|
+
"anyOf": [
|
|
3877
|
+
{
|
|
3878
|
+
"type": "string",
|
|
3879
|
+
"enum": [
|
|
3880
|
+
"Inbound",
|
|
3881
|
+
"Internal",
|
|
3882
|
+
"Outbound"
|
|
3883
|
+
]
|
|
3884
|
+
},
|
|
3885
|
+
{
|
|
3886
|
+
"type": "null"
|
|
3887
|
+
}
|
|
3888
|
+
],
|
|
3889
|
+
"description": "The type of call being answered. Possible values are:"
|
|
3890
|
+
},
|
|
3891
|
+
"CompletedDateTime": {
|
|
3892
|
+
"anyOf": [
|
|
3893
|
+
{
|
|
3894
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
3895
|
+
},
|
|
3896
|
+
{
|
|
3897
|
+
"type": "null"
|
|
3898
|
+
}
|
|
3899
|
+
],
|
|
3900
|
+
"description": "The date and time the task was saved with a Closed status. For insert, if the task is saved with a Closed status the field is set. If the task is saved with an Open status the field is set to NULL. For update, if the task is saved with a new Closed status, the field is reset. If the task is saved with a new non-closed status, the field is reset to NULL. If the task is saved with the same closed status (that is, unchanged) there is no change to the field. The status is a dynamic enum. If the Closed mapping is changed it won’t cause an update of existing tasks. Only new insert/update operations are affected.",
|
|
3901
|
+
"readOnly": true
|
|
3902
|
+
},
|
|
3903
|
+
"ConnectionReceivedId": {
|
|
3904
|
+
"$ref": "#/$defs/NullableId",
|
|
3905
|
+
"description": "ID of the PartnerNetworkConnection that shared this record with your organization. This field is available if you enabled Salesforce to Salesforce.",
|
|
3906
|
+
"readOnly": true
|
|
3907
|
+
},
|
|
3908
|
+
"ConnectionSentId": {
|
|
3909
|
+
"$ref": "#/$defs/NullableId",
|
|
3910
|
+
"description": "ID of the PartnerNetworkConnection that you shared this record with. This field is available if Salesforce to Salesforce is enabled. This field is supported in API versions 14.0 and earlier. In API version 15.0 and later, this field’s value is null. You can use the new PartnerNetworkRecordConnection object to forward records to connections.",
|
|
3911
|
+
"readOnly": true
|
|
3912
|
+
},
|
|
3913
|
+
"Description": {
|
|
3914
|
+
"type": [
|
|
3915
|
+
"string",
|
|
3916
|
+
"null"
|
|
3917
|
+
],
|
|
3918
|
+
"description": "Contains a text description of the task. The text provided in the Description field shows in the Comments field on the task record detail page."
|
|
3919
|
+
},
|
|
3920
|
+
"IsArchived": {
|
|
3921
|
+
"type": "string",
|
|
3922
|
+
"description": "Indicates whether the event has been archived. The default value of this field is false .",
|
|
3923
|
+
"readOnly": true
|
|
3924
|
+
},
|
|
3925
|
+
"IsClosed": {
|
|
3926
|
+
"type": "string",
|
|
3927
|
+
"description": "Indicates whether the task has been completed ( true ) or not ( false ). The default value of this field is false . Is only set indirectly via the Status picklist. Label is Closed .",
|
|
3928
|
+
"readOnly": true
|
|
3929
|
+
},
|
|
3930
|
+
"IsHighPriority": {
|
|
3931
|
+
"type": "string",
|
|
3932
|
+
"description": "Indicates a high-priority task. This field is derived from the Priority field. The default value of this field is false .",
|
|
3933
|
+
"readOnly": true
|
|
3934
|
+
},
|
|
3935
|
+
"IsRecurrence": {
|
|
3936
|
+
"type": "string",
|
|
3937
|
+
"description": "Indicates whether the task is scheduled to repeat itself ( true ) or only occurs once ( false ). The default value of this field is false . This field is read-only on update, but not on create. If this field value is true , then RecurrenceStartDateOnly , RecurrenceEndDateOnly , RecurrenceType , and any recurrence fields associated with the given recurrence type must be populated. See Usage section."
|
|
3938
|
+
},
|
|
3939
|
+
"IsReminderSet": {
|
|
3940
|
+
"type": "string",
|
|
3941
|
+
"description": "Indicates whether a popup reminder has been set for the task ( true ) or not ( false ). The default value of this field is false ."
|
|
3942
|
+
},
|
|
3943
|
+
"IsVisibleInSelfService": {
|
|
3944
|
+
"type": "string",
|
|
3945
|
+
"description": "Indicates whether a task associated with an object can be viewed in the Customer Portal ( true ) or not ( false ). If your organization has digital experiences enabled, tasks marked IsVisibleInSelfService are visible to any external user in the Experience Cloud site, as long as the user has access to the record the task was created on."
|
|
3946
|
+
},
|
|
3947
|
+
"OwnerId": {
|
|
3948
|
+
"$ref": "base.json#/$defs/Id",
|
|
3949
|
+
"description": "ID of the User or Group who owns the record. Label is Assigned To ID . This field accepts Groups of type Queue only. In the user interface, Group IDs correspond with the queue’s list view names. To create or update tasks assigned to Group, use v48.0 or later."
|
|
3950
|
+
},
|
|
3951
|
+
"Priority": {
|
|
3952
|
+
"type": "string",
|
|
3953
|
+
"description": "Required. Indicates the importance or urgency of a task, such as high or low. The default value of this field is Normal ."
|
|
3954
|
+
},
|
|
3955
|
+
"RecurrenceActivityId": {
|
|
3956
|
+
"$ref": "#/$defs/NullableId",
|
|
3957
|
+
"description": "Read-only. Not required on create. ID of the main record of the recurring task. Subsequent occurrences have the same value in this field.",
|
|
3958
|
+
"readOnly": true
|
|
3959
|
+
},
|
|
3960
|
+
"RecurrenceDayOfMonth": {
|
|
3961
|
+
"type": [
|
|
3962
|
+
"integer",
|
|
3963
|
+
"null"
|
|
3964
|
+
],
|
|
3965
|
+
"description": "The day of the month in which the task repeats."
|
|
3966
|
+
},
|
|
3967
|
+
"RecurrenceDayOfWeekMask": {
|
|
3968
|
+
"type": [
|
|
3969
|
+
"integer",
|
|
3970
|
+
"null"
|
|
3971
|
+
],
|
|
3972
|
+
"description": "The day or days of the week on which the task repeats. This field contains a bitmask. The values are as follows: Sunday = 1 Monday = 2 Tuesday = 4 Wednesday = 8 Thursday = 16 Friday = 32 Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20."
|
|
3973
|
+
},
|
|
3974
|
+
"RecurrenceEndDateOnly": {
|
|
3975
|
+
"type": [
|
|
3976
|
+
"string",
|
|
3977
|
+
"null"
|
|
3978
|
+
],
|
|
3979
|
+
"minLength": 10,
|
|
3980
|
+
"maxLength": 10,
|
|
3981
|
+
"format": "date",
|
|
3982
|
+
"description": "The last date on which the task repeats. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant; do not attempt to alter it to accommodate time zone differences."
|
|
3983
|
+
},
|
|
3984
|
+
"RecurrenceInstance": {
|
|
3985
|
+
"anyOf": [
|
|
3986
|
+
{
|
|
3987
|
+
"type": "string",
|
|
3988
|
+
"enum": [
|
|
3989
|
+
"First",
|
|
3990
|
+
"Fourth",
|
|
3991
|
+
"Last",
|
|
3992
|
+
"Second",
|
|
3993
|
+
"Third"
|
|
3994
|
+
]
|
|
3995
|
+
},
|
|
3996
|
+
{
|
|
3997
|
+
"type": "null"
|
|
3998
|
+
}
|
|
3999
|
+
],
|
|
4000
|
+
"description": "The frequency of the recurring task."
|
|
4001
|
+
},
|
|
4002
|
+
"RecurrenceInterval": {
|
|
4003
|
+
"type": [
|
|
4004
|
+
"integer",
|
|
4005
|
+
"null"
|
|
4006
|
+
],
|
|
4007
|
+
"description": "The interval between recurring tasks."
|
|
4008
|
+
},
|
|
4009
|
+
"RecurrenceMonthOfYear": {
|
|
4010
|
+
"type": [
|
|
4011
|
+
"string",
|
|
4012
|
+
"null"
|
|
4013
|
+
],
|
|
4014
|
+
"description": "The month of the year in which the task repeats."
|
|
4015
|
+
},
|
|
4016
|
+
"RecurrenceRegeneratedType": {
|
|
4017
|
+
"type": [
|
|
4018
|
+
"string",
|
|
4019
|
+
"null"
|
|
4020
|
+
],
|
|
4021
|
+
"description": "Represents what triggers a repeating task to repeat. Add this field to a page layout together with the RecurrenceInterval field, which determines the number of days between the triggering date (due date or close date) and the due date of the next repeating task in the series. Label is Repeat This Task . This field has the following picklist values: None : The task doesn’t repeat. After due date : The next repeating task will be due the specified number of days after the current task’s due date. After the task is closed : The next repeating task will be due the specified number of days after the current task is closed. (Task closed) : This task, now closed, was opened as part of a repeating series. When tasks in a series are set to repeat after their due date, Salesforce doesn’t create recurrences that would have been due in the past. Instead, Salesforce keeps adding the interval until a repeated task has a due date in the future. For example, suppose that someone sets a task to repeat three days after it’s due. But, that person doesn’t complete the task (mark it Closed) until five days after it’s due. Instead of creating a task that’s already overdue, Salesforce gives the new task a due date of tomorrow. This due date is equivalent to 6 days after the due date; two intervals of three days each. If that person completes the repeating task (marks it Closed) before the due date, the next task is still due three days after the due date."
|
|
4022
|
+
},
|
|
4023
|
+
"RecurrenceStartDateOnly": {
|
|
4024
|
+
"type": [
|
|
4025
|
+
"string",
|
|
4026
|
+
"null"
|
|
4027
|
+
],
|
|
4028
|
+
"minLength": 10,
|
|
4029
|
+
"maxLength": 10,
|
|
4030
|
+
"format": "date",
|
|
4031
|
+
"description": "The date when the recurring task begins. Must be a date and time before RecurrenceEndDateOnly ."
|
|
4032
|
+
},
|
|
4033
|
+
"RecurrenceTimeZoneSidKey": {
|
|
4034
|
+
"type": [
|
|
4035
|
+
"string",
|
|
4036
|
+
"null"
|
|
4037
|
+
],
|
|
4038
|
+
"description": "The time zone associated with the recurring task. For example, “UTC-8:00” for Pacific Standard Time."
|
|
4039
|
+
},
|
|
4040
|
+
"RecurrenceType": {
|
|
4041
|
+
"anyOf": [
|
|
4042
|
+
{
|
|
4043
|
+
"type": "string",
|
|
4044
|
+
"enum": [
|
|
4045
|
+
"RecursDaily",
|
|
4046
|
+
"RecursEveryWeekday",
|
|
4047
|
+
"RecursMonthly",
|
|
4048
|
+
"RecursMonthlyNth",
|
|
4049
|
+
"RecursWeekly",
|
|
4050
|
+
"RecursYearly",
|
|
4051
|
+
"RecursYearlyNth"
|
|
4052
|
+
]
|
|
4053
|
+
},
|
|
4054
|
+
{
|
|
4055
|
+
"type": "null"
|
|
4056
|
+
}
|
|
4057
|
+
],
|
|
4058
|
+
"description": "Indicates how often the task repeats. For example, daily, weekly, or every nth month (where “nth” is defined in RecurrenceInstance )."
|
|
4059
|
+
},
|
|
4060
|
+
"ReminderDateTime": {
|
|
4061
|
+
"anyOf": [
|
|
4062
|
+
{
|
|
4063
|
+
"$ref": "base.json#/$defs/Timestamp"
|
|
4064
|
+
},
|
|
4065
|
+
{
|
|
4066
|
+
"type": "null"
|
|
4067
|
+
}
|
|
4068
|
+
],
|
|
4069
|
+
"description": "Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to true . If IsReminderSet is set to false , then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value."
|
|
4070
|
+
},
|
|
4071
|
+
"Status": {
|
|
4072
|
+
"type": "string",
|
|
4073
|
+
"enum": [
|
|
4074
|
+
"Completed",
|
|
4075
|
+
"Deferred",
|
|
4076
|
+
"In Progress",
|
|
4077
|
+
"Not Started",
|
|
4078
|
+
"Waiting on someone else"
|
|
4079
|
+
],
|
|
4080
|
+
"description": "Required. Indicates the status of the task. The default value of this field is Not Started . Each predefined Status field implies a value for the IsClosed flag. To obtain picklist values, query the TaskStatus object. Possible values are: Completed Deferred In Progress Not Started Waiting on someone else This field can’t be updated for recurring tasks ( IsRecurrence is true )."
|
|
4081
|
+
},
|
|
4082
|
+
"Subject": {
|
|
4083
|
+
"type": [
|
|
4084
|
+
"string",
|
|
4085
|
+
"null"
|
|
4086
|
+
],
|
|
4087
|
+
"maxLength": 255,
|
|
4088
|
+
"description": "The subject line of the task, such as “Call” or “Send Quote.” Limit: 255 characters."
|
|
4089
|
+
},
|
|
4090
|
+
"TaskSubtype": {
|
|
4091
|
+
"anyOf": [
|
|
4092
|
+
{
|
|
4093
|
+
"type": "string",
|
|
4094
|
+
"enum": [
|
|
4095
|
+
"Task",
|
|
4096
|
+
"Email",
|
|
4097
|
+
"LinkedIn",
|
|
4098
|
+
"ListEmail",
|
|
4099
|
+
"Cadence",
|
|
4100
|
+
"Call"
|
|
4101
|
+
]
|
|
4102
|
+
},
|
|
4103
|
+
{
|
|
4104
|
+
"type": "null"
|
|
4105
|
+
}
|
|
4106
|
+
],
|
|
4107
|
+
"description": "Provides standard subtypes to facilitate creating and searching for specific task subtypes. This field can't be updated. TaskSubtype values: Task Email LinkedIn —Available in API version 56.0 and later. ListEmail Cadence Call The Cadence subtype is an internal value used by Sales Engagement, and can’t be set manually."
|
|
4108
|
+
},
|
|
4109
|
+
"TaskWhoIds": {
|
|
4110
|
+
"type": "array",
|
|
4111
|
+
"items": {
|
|
4112
|
+
"$ref": "base.json#/$defs/Id"
|
|
4113
|
+
},
|
|
4114
|
+
"description": "A string array of contact or lead IDs related to this task. This JunctionIdList field is linked to the TaskWhoRelations child relationship. TaskWhoIds is only available when the shared activities setting is enabled. The first contact or lead ID in the list becomes the primary WhoId if you don’t specify a primary WhoId . If you set the EventWhoIds field to null, all entries in the list are deleted and the value of WhoId is added as the first entry. Warning Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can’t be undone."
|
|
4115
|
+
},
|
|
4116
|
+
"Type": {
|
|
4117
|
+
"type": [
|
|
4118
|
+
"string",
|
|
4119
|
+
"null"
|
|
4120
|
+
],
|
|
4121
|
+
"description": "The type of task, such as Call or Meeting."
|
|
4122
|
+
},
|
|
4123
|
+
"WhatCount": {
|
|
4124
|
+
"type": [
|
|
4125
|
+
"integer",
|
|
4126
|
+
"null"
|
|
4127
|
+
],
|
|
4128
|
+
"description": "Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhatId . Count of the WhatId must be 1 or less.",
|
|
4129
|
+
"readOnly": true
|
|
4130
|
+
},
|
|
4131
|
+
"WhatId": {
|
|
4132
|
+
"$ref": "#/$defs/NullableId",
|
|
4133
|
+
"description": "The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatId s are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object. The label is Related To ID ."
|
|
4134
|
+
},
|
|
4135
|
+
"WhoCount": {
|
|
4136
|
+
"type": [
|
|
4137
|
+
"integer",
|
|
4138
|
+
"null"
|
|
4139
|
+
],
|
|
4140
|
+
"description": "Available to organizations that have Shared Activities enabled. Count of related TaskRelations pertaining to WhoId .",
|
|
4141
|
+
"readOnly": true
|
|
4142
|
+
},
|
|
4143
|
+
"WhoId": {
|
|
4144
|
+
"$ref": "#/$defs/NullableId",
|
|
4145
|
+
"description": "The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID. The label is Name ID . If Shared Activities is enabled, the value of this field is the ID of the related lead or primary contact. If you add, update, or remove the WhoId field, you might encounter problems with triggers, workflows, and data validation rules that are associated with the record. The label is Name ID . Beginning in API version 37.0, if the contact or lead ID in the WhoId field is not in the TaskWhoIds list, no error occurs and the ID is added to the TaskWhoIds as the primary WhoId . If WhoId is set to null, an arbitrary ID from the existing TaskWhoIds list is promoted to the primary position."
|
|
4146
|
+
}
|
|
4147
|
+
},
|
|
4148
|
+
"required": [
|
|
4149
|
+
"Id"
|
|
4150
|
+
],
|
|
4151
|
+
"additionalProperties": false
|
|
4152
|
+
},
|
|
4153
|
+
"OpportunityCreate": {
|
|
4154
|
+
"type": "object",
|
|
4155
|
+
"description": "Opportunity create fields from the pinned Object Reference. Id is additionally required by this deterministic world because Salesforce normally generates it server-side.",
|
|
4156
|
+
"properties": {
|
|
4157
|
+
"Id": {
|
|
4158
|
+
"$ref": "base.json#/$defs/Id",
|
|
4159
|
+
"description": "Unique Salesforce record identifier.",
|
|
4160
|
+
"readOnly": true
|
|
4161
|
+
},
|
|
4162
|
+
"AccountId": {
|
|
4163
|
+
"$ref": "#/$defs/NullableId",
|
|
4164
|
+
"description": "ID of the account associated with this opportunity."
|
|
4165
|
+
},
|
|
4166
|
+
"Amount": {
|
|
4167
|
+
"type": [
|
|
4168
|
+
"number",
|
|
4169
|
+
"null"
|
|
4170
|
+
],
|
|
4171
|
+
"description": "Estimated total sale amount. For opportunities with products, the amount is the sum of the related products. Any attempt to update this field, if the record has products, will be ignored. The update call will not be rejected, and other fields will be updated as specified, but the Amount will be unchanged."
|
|
4172
|
+
},
|
|
4173
|
+
"CampaignId": {
|
|
4174
|
+
"$ref": "#/$defs/NullableId",
|
|
4175
|
+
"description": "ID of a related Campaign. This field is defined only for those organizations that have the campaign feature Campaigns enabled. The User must have read access rights to the cross-referenced Campaign object in order to create or update that campaign into this field on the opportunity."
|
|
4176
|
+
},
|
|
4177
|
+
"CloseDate": {
|
|
4178
|
+
"type": "string",
|
|
4179
|
+
"minLength": 10,
|
|
4180
|
+
"maxLength": 10,
|
|
4181
|
+
"format": "date",
|
|
4182
|
+
"description": "Required. Date when the opportunity is expected to close."
|
|
4183
|
+
},
|
|
4184
|
+
"ContactId": {
|
|
4185
|
+
"$ref": "#/$defs/NullableId",
|
|
4186
|
+
"description": "ID of the contact associated with this opportunity, set as the primary contact. Read-only field that is derived from the opportunity contact role, which is created at the same time the opportunity is created. This field can only be populated when it’s created, and can’t be updated. To update the value in this field, change the IsPrimary flag on the OpportunityContactRole associated with this opportunity. Available in API version 46.0 and later."
|
|
4187
|
+
},
|
|
4188
|
+
"ContractId": {
|
|
4189
|
+
"$ref": "#/$defs/NullableId",
|
|
4190
|
+
"description": "ID of the contract that’s associated with this opportunity."
|
|
4191
|
+
},
|
|
4192
|
+
"CurrencyIsoCode": {
|
|
4193
|
+
"type": [
|
|
4194
|
+
"string",
|
|
4195
|
+
"null"
|
|
4196
|
+
],
|
|
4197
|
+
"description": "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
|
|
4198
|
+
},
|
|
4199
|
+
"Description": {
|
|
4200
|
+
"type": [
|
|
4201
|
+
"string",
|
|
4202
|
+
"null"
|
|
4203
|
+
],
|
|
4204
|
+
"maxLength": 32000,
|
|
4205
|
+
"description": "Text description of the opportunity. Limit: 32,000 characters."
|
|
4206
|
+
},
|
|
4207
|
+
"ForecastCategoryName": {
|
|
4208
|
+
"anyOf": [
|
|
4209
|
+
{
|
|
4210
|
+
"type": "string",
|
|
4211
|
+
"enum": [
|
|
4212
|
+
"Best Case",
|
|
4213
|
+
"Closed",
|
|
4214
|
+
"Commit",
|
|
4215
|
+
"Most Likely",
|
|
4216
|
+
"Omitted",
|
|
4217
|
+
"Pipeline"
|
|
4218
|
+
]
|
|
4219
|
+
},
|
|
4220
|
+
{
|
|
4221
|
+
"type": "null"
|
|
4222
|
+
}
|
|
4223
|
+
],
|
|
4224
|
+
"description": "The name of the forecast category. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than is implied by the StageName value. Available in API version 12.0 and later."
|
|
4225
|
+
},
|
|
4226
|
+
"IsExcludedFromTerritory2Filter": {
|
|
4227
|
+
"type": "string",
|
|
4228
|
+
"description": "Used for Filter-Based Opportunity Territory Assignment (Pilot in Spring ’15 / API version 33). Indicates whether the opportunity is excluded ( True ) or included ( False ) each time the APEX filter is executed."
|
|
4229
|
+
},
|
|
4230
|
+
"IsPrivate": {
|
|
4231
|
+
"type": "string",
|
|
4232
|
+
"description": "If true , only the opportunity owner, users above that role in the hierarchy, and admins can view the opportunity or query it via the API. When you mark opportunities as private, opportunity teams, opportunity splits, and sharing are removed. Label is Private . The default value is False ."
|
|
4233
|
+
},
|
|
4234
|
+
"LeadSource": {
|
|
4235
|
+
"type": [
|
|
4236
|
+
"string",
|
|
4237
|
+
"null"
|
|
4238
|
+
],
|
|
4239
|
+
"description": "Source of this opportunity, such as Advertisement or Trade Show."
|
|
4240
|
+
},
|
|
4241
|
+
"Name": {
|
|
4242
|
+
"type": "string",
|
|
4243
|
+
"maxLength": 120,
|
|
4244
|
+
"description": "Required. A name for this opportunity. Limit: 120 characters."
|
|
4245
|
+
},
|
|
4246
|
+
"NextStep": {
|
|
4247
|
+
"type": [
|
|
4248
|
+
"string",
|
|
4249
|
+
"null"
|
|
4250
|
+
],
|
|
4251
|
+
"maxLength": 255,
|
|
4252
|
+
"description": "Description of next task in closing opportunity. Limit: 255 characters."
|
|
4253
|
+
},
|
|
4254
|
+
"OwnerId": {
|
|
4255
|
+
"$ref": "base.json#/$defs/Id",
|
|
4256
|
+
"description": "ID of the User who has been assigned to work this opportunity. If you update this field, the previous owner's access becomes Read Only or the access specified in your organization-wide default for opportunities, whichever is greater. If you have set up opportunity teams in your organization, 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. (All previous opportunity team members are kept on the opportunity team.) For API version before 12.0, sharing records are deleted. (All previous opportunity team members are removed from the opportunity team.) For API version 16.0 and later, users must have the Transfer Record permission in order to update (transfer) account ownership using this field."
|
|
4257
|
+
},
|
|
4258
|
+
"Pricebook2Id": {
|
|
4259
|
+
"$ref": "#/$defs/NullableId",
|
|
4260
|
+
"description": "ID of a related Pricebook2 object. The Pricebook2Id field indicates which Pricebook2 applies to this opportunity. The Pricebook2Id field is defined only for those organizations that have products enabled as a feature. You can specify values for only one field ( Pricebook2Id or PricebookId )—not both fields. For this reason, both fields are declared nillable."
|
|
4261
|
+
},
|
|
4262
|
+
"PricebookId": {
|
|
4263
|
+
"$ref": "#/$defs/NullableId",
|
|
4264
|
+
"description": "Unavailable as of version 3.0. As of version 8.0, the Pricebook object is no longer available. Use the Pricebook2Id field instead, specifying the ID of the Pricebook2 record."
|
|
4265
|
+
},
|
|
4266
|
+
"Probability": {
|
|
4267
|
+
"type": [
|
|
4268
|
+
"number",
|
|
4269
|
+
"null"
|
|
4270
|
+
],
|
|
4271
|
+
"minimum": 0,
|
|
4272
|
+
"maximum": 100,
|
|
4273
|
+
"description": "Percentage of estimated confidence in closing the opportunity. It is implied, but not directly controlled, by the StageName field. You can override this field to a different value than what is implied by the StageName ."
|
|
4274
|
+
},
|
|
4275
|
+
"RecordTypeId": {
|
|
4276
|
+
"$ref": "#/$defs/NullableId",
|
|
4277
|
+
"description": "ID of the record type assigned to this object."
|
|
4278
|
+
},
|
|
4279
|
+
"StageName": {
|
|
4280
|
+
"type": "string",
|
|
4281
|
+
"description": "Required. Current stage of this record. The StageName field controls several other fields on an opportunity. Each of the fields can be directly set or implied by changing the StageName field. In addition, the StageName field is a picklist, so it has additional members in the returned describeSObjectResult to indicate how it affects the other fields. To obtain the stage name values in the picklist, query the OpportunityStage object. If the StageName is updated, then the ForecastCategoryName , IsClosed , IsWon , and Probability are automatically updated based on the stage-category mapping."
|
|
4282
|
+
},
|
|
4283
|
+
"SyncedQuoteID": {
|
|
4284
|
+
"$ref": "#/$defs/NullableId",
|
|
4285
|
+
"description": "Read only in an Apex trigger. The ID of the Quote that syncs with the opportunity. Setting this field lets you start and stop syncing between the opportunity and a quote. The ID has to be for a quote that is a child of the opportunity."
|
|
4286
|
+
},
|
|
4287
|
+
"Territory2Id": {
|
|
4288
|
+
"$ref": "#/$defs/NullableId",
|
|
4289
|
+
"description": "The ID of the territory that is assigned to the opportunity. Available only if Enterprise Territory Management has been enabled for your organization. Users who have full access to an opportunity’s account can assign any territory from the active model to the opportunity. Users who do not can assign only a territory that is also assigned to the opportunity’s account. The same restriction applies to territory assignments made via Apex in system mode."
|
|
4290
|
+
},
|
|
4291
|
+
"TotalOpportunityQuantity": {
|
|
4292
|
+
"type": [
|
|
4293
|
+
"number",
|
|
4294
|
+
"null"
|
|
4295
|
+
],
|
|
4296
|
+
"description": "Number of items included in this opportunity. Used in quantity-based forecasting."
|
|
4297
|
+
},
|
|
4298
|
+
"Type": {
|
|
4299
|
+
"type": [
|
|
4300
|
+
"string",
|
|
4301
|
+
"null"
|
|
4302
|
+
],
|
|
4303
|
+
"description": "Type of opportunity. For example, Existing Business or New Business. Label is Opportunity Type ."
|
|
4304
|
+
}
|
|
4305
|
+
},
|
|
4306
|
+
"required": [
|
|
4307
|
+
"Id",
|
|
4308
|
+
"CloseDate",
|
|
4309
|
+
"Name",
|
|
4310
|
+
"StageName"
|
|
4311
|
+
],
|
|
4312
|
+
"additionalProperties": false
|
|
4313
|
+
},
|
|
4314
|
+
"QueryRecordAttributes": {
|
|
4315
|
+
"type": "object",
|
|
4316
|
+
"properties": {
|
|
4317
|
+
"type": {
|
|
4318
|
+
"type": "string",
|
|
4319
|
+
"minLength": 1
|
|
4320
|
+
},
|
|
4321
|
+
"url": {
|
|
4322
|
+
"type": "string",
|
|
4323
|
+
"minLength": 1
|
|
4324
|
+
}
|
|
4325
|
+
},
|
|
4326
|
+
"required": [
|
|
4327
|
+
"type",
|
|
4328
|
+
"url"
|
|
4329
|
+
],
|
|
4330
|
+
"additionalProperties": false
|
|
4331
|
+
},
|
|
4332
|
+
"QueryRecord": {
|
|
4333
|
+
"type": "object",
|
|
4334
|
+
"properties": {
|
|
4335
|
+
"attributes": {
|
|
4336
|
+
"$ref": "#/$defs/QueryRecordAttributes"
|
|
4337
|
+
}
|
|
4338
|
+
},
|
|
4339
|
+
"required": [
|
|
4340
|
+
"attributes"
|
|
4341
|
+
],
|
|
4342
|
+
"additionalProperties": true
|
|
4343
|
+
},
|
|
4344
|
+
"QueryResult": {
|
|
4345
|
+
"type": "object",
|
|
4346
|
+
"properties": {
|
|
4347
|
+
"totalSize": {
|
|
4348
|
+
"type": "integer",
|
|
4349
|
+
"minimum": 0
|
|
4350
|
+
},
|
|
4351
|
+
"done": {
|
|
4352
|
+
"type": "boolean"
|
|
4353
|
+
},
|
|
4354
|
+
"records": {
|
|
4355
|
+
"type": "array",
|
|
4356
|
+
"items": {
|
|
4357
|
+
"$ref": "#/$defs/QueryRecord"
|
|
4358
|
+
}
|
|
4359
|
+
}
|
|
4360
|
+
},
|
|
4361
|
+
"required": [
|
|
4362
|
+
"totalSize",
|
|
4363
|
+
"done",
|
|
4364
|
+
"records"
|
|
4365
|
+
],
|
|
4366
|
+
"additionalProperties": false
|
|
4367
|
+
}
|
|
4368
|
+
},
|
|
4369
|
+
"x-gateway": {
|
|
4370
|
+
"version": 1,
|
|
4371
|
+
"domain_version": "3.0.1",
|
|
4372
|
+
"package": {
|
|
4373
|
+
"id": "gateway-connector-salesforce",
|
|
4374
|
+
"version": "3.0.0"
|
|
4375
|
+
},
|
|
4376
|
+
"entities": {
|
|
4377
|
+
"sf_users": {
|
|
4378
|
+
"schema": {
|
|
4379
|
+
"$ref": "#/$defs/User"
|
|
4380
|
+
},
|
|
4381
|
+
"primary_key": [
|
|
4382
|
+
"Id"
|
|
4383
|
+
],
|
|
4384
|
+
"unique": [
|
|
4385
|
+
[
|
|
4386
|
+
"Username"
|
|
4387
|
+
]
|
|
4388
|
+
],
|
|
4389
|
+
"relationships": [
|
|
4390
|
+
{
|
|
4391
|
+
"fields": [
|
|
4392
|
+
"AccountId"
|
|
4393
|
+
],
|
|
4394
|
+
"target": "sf_accounts",
|
|
4395
|
+
"on_delete": "restrict"
|
|
4396
|
+
},
|
|
4397
|
+
{
|
|
4398
|
+
"fields": [
|
|
4399
|
+
"ContactId"
|
|
4400
|
+
],
|
|
4401
|
+
"target": "sf_contacts",
|
|
4402
|
+
"on_delete": "restrict"
|
|
4403
|
+
},
|
|
4404
|
+
{
|
|
4405
|
+
"fields": [
|
|
4406
|
+
"ManagerId"
|
|
4407
|
+
],
|
|
4408
|
+
"target": "sf_users",
|
|
4409
|
+
"on_delete": "restrict"
|
|
4410
|
+
}
|
|
4411
|
+
]
|
|
4412
|
+
},
|
|
4413
|
+
"sf_accounts": {
|
|
4414
|
+
"schema": {
|
|
4415
|
+
"$ref": "#/$defs/Account"
|
|
4416
|
+
},
|
|
4417
|
+
"primary_key": [
|
|
4418
|
+
"Id"
|
|
4419
|
+
],
|
|
4420
|
+
"unique": [],
|
|
4421
|
+
"relationships": [
|
|
4422
|
+
{
|
|
4423
|
+
"fields": [
|
|
4424
|
+
"MasterRecordId"
|
|
4425
|
+
],
|
|
4426
|
+
"target": "sf_accounts",
|
|
4427
|
+
"on_delete": "restrict"
|
|
4428
|
+
},
|
|
4429
|
+
{
|
|
4430
|
+
"fields": [
|
|
4431
|
+
"OwnerId"
|
|
4432
|
+
],
|
|
4433
|
+
"target": "sf_users",
|
|
4434
|
+
"on_delete": "restrict"
|
|
4435
|
+
},
|
|
4436
|
+
{
|
|
4437
|
+
"fields": [
|
|
4438
|
+
"ParentId"
|
|
4439
|
+
],
|
|
4440
|
+
"target": "sf_accounts",
|
|
4441
|
+
"on_delete": "restrict"
|
|
4442
|
+
},
|
|
4443
|
+
{
|
|
4444
|
+
"fields": [
|
|
4445
|
+
"PersonReportsToId"
|
|
4446
|
+
],
|
|
4447
|
+
"target": "sf_contacts",
|
|
4448
|
+
"on_delete": "restrict"
|
|
4449
|
+
}
|
|
4450
|
+
]
|
|
4451
|
+
},
|
|
4452
|
+
"sf_contacts": {
|
|
4453
|
+
"schema": {
|
|
4454
|
+
"$ref": "#/$defs/Contact"
|
|
4455
|
+
},
|
|
4456
|
+
"primary_key": [
|
|
4457
|
+
"Id"
|
|
4458
|
+
],
|
|
4459
|
+
"unique": [],
|
|
4460
|
+
"relationships": [
|
|
4461
|
+
{
|
|
4462
|
+
"fields": [
|
|
4463
|
+
"AccountId"
|
|
4464
|
+
],
|
|
4465
|
+
"target": "sf_accounts",
|
|
4466
|
+
"on_delete": "restrict"
|
|
4467
|
+
},
|
|
4468
|
+
{
|
|
4469
|
+
"fields": [
|
|
4470
|
+
"MasterRecordId"
|
|
4471
|
+
],
|
|
4472
|
+
"target": "sf_contacts",
|
|
4473
|
+
"on_delete": "restrict"
|
|
4474
|
+
},
|
|
4475
|
+
{
|
|
4476
|
+
"fields": [
|
|
4477
|
+
"OwnerId"
|
|
4478
|
+
],
|
|
4479
|
+
"target": "sf_users",
|
|
4480
|
+
"on_delete": "restrict"
|
|
4481
|
+
},
|
|
4482
|
+
{
|
|
4483
|
+
"fields": [
|
|
4484
|
+
"ReportsToId"
|
|
4485
|
+
],
|
|
4486
|
+
"target": "sf_contacts",
|
|
4487
|
+
"on_delete": "restrict"
|
|
4488
|
+
}
|
|
4489
|
+
]
|
|
4490
|
+
},
|
|
4491
|
+
"sf_leads": {
|
|
4492
|
+
"schema": {
|
|
4493
|
+
"$ref": "#/$defs/Lead"
|
|
4494
|
+
},
|
|
4495
|
+
"primary_key": [
|
|
4496
|
+
"Id"
|
|
4497
|
+
],
|
|
4498
|
+
"unique": [],
|
|
4499
|
+
"relationships": [
|
|
4500
|
+
{
|
|
4501
|
+
"fields": [
|
|
4502
|
+
"ConvertedAccountId"
|
|
4503
|
+
],
|
|
4504
|
+
"target": "sf_accounts",
|
|
4505
|
+
"on_delete": "restrict"
|
|
4506
|
+
},
|
|
4507
|
+
{
|
|
4508
|
+
"fields": [
|
|
4509
|
+
"ConvertedContactId"
|
|
4510
|
+
],
|
|
4511
|
+
"target": "sf_contacts",
|
|
4512
|
+
"on_delete": "restrict"
|
|
4513
|
+
},
|
|
4514
|
+
{
|
|
4515
|
+
"fields": [
|
|
4516
|
+
"ConvertedOpportunityId"
|
|
4517
|
+
],
|
|
4518
|
+
"target": "sf_opportunities",
|
|
4519
|
+
"on_delete": "restrict"
|
|
4520
|
+
},
|
|
4521
|
+
{
|
|
4522
|
+
"fields": [
|
|
4523
|
+
"MasterRecordId"
|
|
4524
|
+
],
|
|
4525
|
+
"target": "sf_leads",
|
|
4526
|
+
"on_delete": "restrict"
|
|
4527
|
+
}
|
|
4528
|
+
]
|
|
4529
|
+
},
|
|
4530
|
+
"sf_opportunities": {
|
|
4531
|
+
"schema": {
|
|
4532
|
+
"$ref": "#/$defs/Opportunity"
|
|
4533
|
+
},
|
|
4534
|
+
"primary_key": [
|
|
4535
|
+
"Id"
|
|
4536
|
+
],
|
|
4537
|
+
"unique": [],
|
|
4538
|
+
"relationships": [
|
|
4539
|
+
{
|
|
4540
|
+
"fields": [
|
|
4541
|
+
"AccountId"
|
|
4542
|
+
],
|
|
4543
|
+
"target": "sf_accounts",
|
|
4544
|
+
"on_delete": "restrict"
|
|
4545
|
+
},
|
|
4546
|
+
{
|
|
4547
|
+
"fields": [
|
|
4548
|
+
"OwnerId"
|
|
4549
|
+
],
|
|
4550
|
+
"target": "sf_users",
|
|
4551
|
+
"on_delete": "restrict"
|
|
4552
|
+
}
|
|
4553
|
+
]
|
|
4554
|
+
},
|
|
4555
|
+
"sf_cases": {
|
|
4556
|
+
"schema": {
|
|
4557
|
+
"$ref": "#/$defs/Case"
|
|
4558
|
+
},
|
|
4559
|
+
"primary_key": [
|
|
4560
|
+
"Id"
|
|
4561
|
+
],
|
|
4562
|
+
"unique": [],
|
|
4563
|
+
"relationships": [
|
|
4564
|
+
{
|
|
4565
|
+
"fields": [
|
|
4566
|
+
"AccountId"
|
|
4567
|
+
],
|
|
4568
|
+
"target": "sf_accounts",
|
|
4569
|
+
"on_delete": "restrict"
|
|
4570
|
+
},
|
|
4571
|
+
{
|
|
4572
|
+
"fields": [
|
|
4573
|
+
"ContactId"
|
|
4574
|
+
],
|
|
4575
|
+
"target": "sf_contacts",
|
|
4576
|
+
"on_delete": "restrict"
|
|
4577
|
+
},
|
|
4578
|
+
{
|
|
4579
|
+
"fields": [
|
|
4580
|
+
"MasterRecordId"
|
|
4581
|
+
],
|
|
4582
|
+
"target": "sf_cases",
|
|
4583
|
+
"on_delete": "restrict"
|
|
4584
|
+
},
|
|
4585
|
+
{
|
|
4586
|
+
"fields": [
|
|
4587
|
+
"ParentId"
|
|
4588
|
+
],
|
|
4589
|
+
"target": "sf_cases",
|
|
4590
|
+
"on_delete": "restrict"
|
|
4591
|
+
}
|
|
4592
|
+
]
|
|
4593
|
+
},
|
|
4594
|
+
"sf_tasks": {
|
|
4595
|
+
"schema": {
|
|
4596
|
+
"$ref": "#/$defs/Task"
|
|
4597
|
+
},
|
|
4598
|
+
"primary_key": [
|
|
4599
|
+
"Id"
|
|
4600
|
+
],
|
|
4601
|
+
"unique": [],
|
|
4602
|
+
"relationships": [
|
|
4603
|
+
{
|
|
4604
|
+
"fields": [
|
|
4605
|
+
"AccountId"
|
|
4606
|
+
],
|
|
4607
|
+
"target": "sf_accounts",
|
|
4608
|
+
"on_delete": "restrict"
|
|
4609
|
+
}
|
|
4610
|
+
]
|
|
4611
|
+
}
|
|
4612
|
+
},
|
|
4613
|
+
"tools": {
|
|
4614
|
+
"list_opportunities": {
|
|
4615
|
+
"input": {
|
|
4616
|
+
"type": "object",
|
|
4617
|
+
"properties": {
|
|
4618
|
+
"AccountId": {
|
|
4619
|
+
"$ref": "base.json#/$defs/Id"
|
|
4620
|
+
}
|
|
4621
|
+
},
|
|
4622
|
+
"required": [
|
|
4623
|
+
"AccountId"
|
|
4624
|
+
],
|
|
4625
|
+
"additionalProperties": false
|
|
4626
|
+
},
|
|
4627
|
+
"output": {
|
|
4628
|
+
"type": "array",
|
|
4629
|
+
"items": {
|
|
4630
|
+
"$ref": "#/$defs/Opportunity"
|
|
4631
|
+
}
|
|
4632
|
+
},
|
|
4633
|
+
"description": "Opportunities on one account."
|
|
4634
|
+
},
|
|
4635
|
+
"create_opportunity": {
|
|
4636
|
+
"input": {
|
|
4637
|
+
"type": "object",
|
|
4638
|
+
"properties": {
|
|
4639
|
+
"opportunity": {
|
|
4640
|
+
"$ref": "#/$defs/OpportunityCreate"
|
|
4641
|
+
}
|
|
4642
|
+
},
|
|
4643
|
+
"required": [
|
|
4644
|
+
"opportunity"
|
|
4645
|
+
],
|
|
4646
|
+
"additionalProperties": false
|
|
4647
|
+
},
|
|
4648
|
+
"output": {
|
|
4649
|
+
"$ref": "#/$defs/Opportunity"
|
|
4650
|
+
},
|
|
4651
|
+
"description": "Create an opportunity from the documented createable fields. Id is caller-supplied only because this deterministic world has no Salesforce id generator."
|
|
4652
|
+
},
|
|
4653
|
+
"update_stage": {
|
|
4654
|
+
"input": {
|
|
4655
|
+
"type": "object",
|
|
4656
|
+
"properties": {
|
|
4657
|
+
"Id": {
|
|
4658
|
+
"$ref": "base.json#/$defs/Id"
|
|
4659
|
+
},
|
|
4660
|
+
"StageName": {
|
|
4661
|
+
"$ref": "#/$defs/Opportunity/properties/StageName"
|
|
4662
|
+
}
|
|
4663
|
+
},
|
|
4664
|
+
"required": [
|
|
4665
|
+
"Id",
|
|
4666
|
+
"StageName"
|
|
4667
|
+
],
|
|
4668
|
+
"additionalProperties": false
|
|
4669
|
+
},
|
|
4670
|
+
"output": {
|
|
4671
|
+
"$ref": "#/$defs/Opportunity"
|
|
4672
|
+
},
|
|
4673
|
+
"description": "Move an opportunity to a new stage, re-deriving IsClosed and IsWon."
|
|
4674
|
+
},
|
|
4675
|
+
"query_records": {
|
|
4676
|
+
"input": {
|
|
4677
|
+
"type": "object",
|
|
4678
|
+
"properties": {
|
|
4679
|
+
"soql": {
|
|
4680
|
+
"$ref": "base.json#/$defs/Text"
|
|
4681
|
+
}
|
|
4682
|
+
},
|
|
4683
|
+
"required": [
|
|
4684
|
+
"soql"
|
|
4685
|
+
],
|
|
4686
|
+
"additionalProperties": false
|
|
4687
|
+
},
|
|
4688
|
+
"output": {
|
|
4689
|
+
"$ref": "#/$defs/QueryResult"
|
|
4690
|
+
},
|
|
4691
|
+
"description": "Run a SOQL subset (SELECT fields FROM object [WHERE ...] [ORDER BY ...] [LIMIT n]) and return a QueryResult."
|
|
4692
|
+
}
|
|
4693
|
+
}
|
|
4694
|
+
}
|
|
4695
|
+
}
|