Hold Definition (POST)

Create a hold definition with hold reasons and a resolution plan.

Resource 

1/connect/education/holds

Resource Example 

1https://yourInstance.salesforce.com/services/data/v68.0/connect/education/holds

Available Version 

64.0

HTTP Methods 

POST

Request Body for POST 

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 

NameTypeDescriptionRequired or OptionalAvailable Version
canResolve​AutomaticallyBooleanIndicates whether the restriction can be auto-resolved (true) or requires manual resolution (false).Optional64.0
descriptionStringDescription of the hold.Optional64.0
effectiveFromStringDate from which the hold is effective.Optional64.0
effectiveToStringDate till which the hold is effective.Optional64.0
nameStringName of the hold.Optional64.0
reasonsString[]Reasons for the hold.Optional64.0
regulatory​AuthorityIdStringUnique ID of the regulatory authority.Required64.0
resolutionAction Plan Template InputUnique ID of the action plan template associated with the resolution of this hold.Required64.0
subjectStringSubject of the hold.Optional64.0
typeStringType of the hold.Optional64.0

Response Body for POST 

Hold Setup