Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Hold Setup Input

Input representation of the request to create a hold.

JSON example

1{
2  "name": "RestrictionName",
3  "subject": "string",
4  "description": "Updated description for academic probation hold.",
5  "regulatoryAuthorityId": "string",
6  "reasons": [
7    "0x6frr566",
8    "0x5674432",
9    "0x6frzz566"
10  ],
11  "resolution": {
12    "actionPlanTemplateVersionId": "0x4467778"
13  },
14  "type": "Academic",
15  "effectiveFrom": "2025-07-29",
16  "effectiveTo": "2025-07-29",
17  "canResolveAutomatically": true
18}

Properties

Name	Type	Description	Required or Optional	Available Version
`canResolveAutomatically`	Boolean	Indicates whether the restriction can be auto-resolved (`true`) or requires manual resolution (`false`).	Optional	64.0
`description`	String	Description of the hold.	Optional	64.0
`effectiveFrom`	String	Date from which the hold is effective.	Optional	64.0
`effectiveTo`	String	Date till which the hold is effective.	Optional	64.0
`name`	String	Name of the hold.	Optional	64.0
`reasons`	String[]	Reasons for the hold.	Optional	64.0
`regulatoryAuthorityId`	String	Unique ID of the regulatory authority.	Required	64.0
`resolution`	Action Plan Template Input	Unique ID of the action plan template associated with the resolution of this hold.	Required	64.0
`subject`	String	Subject of the hold.	Optional	64.0
`type`	String	Type of the hold.	Optional	64.0

Education Cloud Developer Guide

Hold Setup Input