---
schema_version: "1"
id: 15101fab9c30f4cc5eda18a35f3c939b1203b5cc2355e050670c6d571c55d87e
title: GenOpPlanRequest
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_genopplanrequest.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_genopplanrequest.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 67ed7d3deff4e652ed2778a47e8e7737dedfdf0dfef3666667ed267789adffe2
description: Represents a request to generate a service plan. This object is available in API version 67.0 and later.
---
# GenOpPlanRequest

Represents a request to generate a service plan. This object is available in API version 67.0 and later.

Each request is stored as record data. We support all delete operations at the record or bulk level. For example, you can [use Bulk API 2.0 to delete multiple records in Marketing Cloud Next](https://developer.salesforce.com/docs/marketing/marketing-cloud-growth/guide/mc-manage-objects-delete-bulk.html).

## Supported Calls

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()

## Special Access Rules

To access this object, you must have the Service Planner Access add-on license.

## Fields

| Field Name | Details |
| --- | --- |
| CopilotId | 
Type

reference

Properties

Filter, Group, Sort, Nillable

Description

(Optional) The ID of the Einstein Copilot associated with the plan request.

This field is a relationship field.

Relationship Name

Copilot

Refers To

GenAiPlannerDefinition



 |
| CopilotName | 

Type

string

Properties

Filter, Group, Sort, Nillable

Description

(Optional) The name of the Einstein Copilot associated with the plan request.



 |
| ErrorCode | 

Type

picklist

Properties

Filter, Group, Nillable, Restricted picklist, Sort

Description

(Optional) The standard error code when plan generation fails.

Possible values are:

- AgentNotActive
- AgentNotFound
- CaseGroundingNotEnabled (Service AI Grounding isn’t enabled)
- InstructionsOrActionsNotFound
- InsufficientData
- InvalidRecordId
- NoEligibilityDefined (No eligibility criteria defined)
- NotEligible
- RagConfigurationError
- StepSummaryEmpty
- TopicIdNotFound
- TopicNotFound
- Unknown





 |
| ErrorMessage | 

Type

string

Properties

Filter, Group, Sort, Nillable

Description

(Optional) The error message when plan generation fails.



 |
| LlmModelName | 

Type

string

Properties

Filter, Group, Sort, Nillable

Description

(Optional) The name of the large language model used for plan generation. The maximum length is 80 characters.



 |
| LlmProviderName | 

Type

string

Properties

Filter, Group, Sort, Nillable

Description

(Optional) The name of the LLM provider. The maximum length is 80 characters.



 |
| Name | 

Type

string

Properties

Autonumber, Defaulted on create, Filter, idLookup, Sort

Description

(Required) The auto-generated name of the generated operation plan request.



 |
| ParentId | 

Type

reference

Properties

Filter, Group, Sort

Description

(Required) The ID of the service plan parent record.

This field is a polymorphic relationship field.

Relationship Name

Parent

Relationship Type

Master-detail

Refers To

Case, Incident, MessagingSession, Opportunity (the master object)



 |
| PromptTemplateDevName | 

Type

string

Properties

Filter, Group, Sort, Nillable

Description

(Optional) The developer name of the prompt template used for plan generation. The maximum length is 80 characters.



 |
| PromptTemplateVersionNo | 

Type

int

Properties

Filter, Group, Sort, Nillable

Description

(Optional) The version number of the prompt template.



 |
| Reason | 

Type

picklist

Properties

Defaulted on create, Filter, Group, Restricted picklist, Sort

Description

(Required) The reason why plan generation failed or returned no steps.

Possible values are:

- CannotGeneratePlan
- NoEligibilityConfig (no eligibility criteria set)
- None (default)
- NoPlanGenerated PlanEmpty
- PlanEmptyInsufficientData
- RagConfigurationError
- ThresholdError (eligibility not met for unknown reason)
- ThresholdNotMet





 |
| RequestSource | 

Type

picklist

Properties

Filter, Group, Nillable, Restricted picklist, Sort

Description

(Optional) The source where the plan request originated.

Possible values are:

- CASE
- EINSTEIN\_LEX (Einstein Chat LEX component)
- INCIDENT





 |
| RequestType | 

Type

picklist

Properties

Defaulted on create, Filter, Group, Restricted picklist, Sort

Description

(Required) The type of service plan request.

Possible values are:

- Close
- Generation
- Summary (default)





 |
| Status | 

Type

picklist

Properties

Defaulted on create, Filter, Group, Restricted picklist, Sort

Description

(Required) The status of the plan generation request.

Possible values are:

- Error
- Incomplete
- InProgress (default)
- Success





 |
| Utterance | 

Type

textarea

Properties

Nillable

Description

(Optional) The natural language input or prompt used for plan generation. The maximum length is 32,000 characters.



 |