Create Endorsement Draft for Insurance Brokerage Policy Action

This action is available in API version 67.0 and later.

Special Access Rules

This action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/endorseDraftInsBrokeragePolicy

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
inputRep	Apex-defined	Required. An Apex ConnectApi__EndorseDraftBrokeragePolicyIAInputRep record that contains the details of the original brokerage policy to endorse.

Outputs

Output	Type	Description
draftPolicyId	string	ID of the newly created endorsement draft policy.

Example

POST

This sample request is for the Create Endorsement Draft for Insurance Brokerage Policy action.

{
  "inputs": [
    {
      "inputRep": {
        "policyId": "0YjXX0000000001",
        "endorsementDate": "2026-08-01",
        "effectiveFromDate": "2026-08-01",
        "effectiveToDate": "2027-08-01",
        "policyName": "Updated Policy Name",
        "policyNumber": "POL-2026-ENDORSED"
      }
    }
  ]
}

This is a sample request to call this invocable action from Apex code.

// Create the standard Invocable Action for creating an endorsement draft of a brokerage policy
Invocable.Action action = Invocable.Action.createStandardAction('endorseDraftInsBrokeragePolicy');

// Instantiate the input object
ConnectApi.EndorseDraftBrokeragePolicyIAInputRep input = new ConnectApi.EndorseDraftBrokeragePolicyIAInputRep();

// Required: Set the Policy ID of the original brokerage policy to endorse
input.policyId = '0YjXX0000000001';

// Optional: Set endorsement details
input.endorsementDate = '2026-08-01';
input.effectiveFromDate = '2026-08-01';
input.effectiveToDate = '2027-08-01';
input.policyName = 'Updated Policy Name';
input.policyNumber = 'POL-2026-ENDORSED';

// Set the invocation parameter and invoke
action.setInvocationParameter('endorseDraftBrokeragePolicyIAInputRep', input);
List<Invocable.Action.Result> results = action.invoke();

System.debug('Endorse-Draft Brokerage Policy Invocable Action result = ' + results);

This is the sample response for the Create Endorsement Draft for Insurance Brokerage Policy action.

[
  {
    "actionName": "endorseDraftInsBrokeragePolicy",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "draftPolicyId": "0YjXX0000000099"
    },
    "sortOrder": -1,
    "version": 1
  }
]