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.

Learner Restriction Violation (GET, POST)

Retrieve and apply a new restriction (hold) to a learner by their contact ID.

Resource

1/connect/education/holds/assignees/${contactId}

Resource example for GET

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

Resource example for POST

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

Available version

64.0

HTTP methods

GET POST

Response body for GET

Hold Violation Result

Request body for POST

JSON example

1{
2  "caseStatus": "string",
3  "caseOrigin": "string",
4  "caseRecordTypeId": "string",
5  "dateCreated": "2025-07-25",
6  "description": "string",
7  "complianceDueDate": "2025-07-25",
8  "dateResolved": "2025-07-25",
9  "status": "string",
10  "type": "string",
11  "regulatoryCodeId": "string",
12  "reasons": [
13    "string"
14  ]
15}

Properties

Name	Type	Description	Required or Optional	Available Version
`caseOrigin`	String	Origin of the case for the contact user.	Optional	65.0
`caseRecordTypeId`	String	Record Type ID of the case for the contact user.	Optional	65.0
`caseStatus`	String	Status of the case for the contact user.	Optional	65.0
`complianceDueDate`	String	Date by which compliance is expected for the hold violation.	Optional	65.0
`dateCreated`	String	Date from which the hold violation is effective.	Optional	65.0
`dateResolved`	String	Date on which the hold violation is resolved.	Optional	65.0
`description`	String	Description of the hold violation.	Optional	65.0
`reasons`	String[]	Reasons for the hold violation.	Optional	65.0
`regulatoryCodeId`	String	Unique ID for hold Definition.	Required	65.0
`status`	String	Status of the hold violation.	Optional	65.0
`type`	String	Type of the hold violation.	Optional	65.0

Response body for POST

Hold Violation

Education Cloud Developer Guide

Learner Restriction Violation (GET, POST)