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 

NameTypeDescriptionRequired or OptionalAvailable Version
caseOriginStringOrigin of the case for the contact user.Optional65.0
caseRecord​TypeIdStringRecord Type ID of the case for the contact user.Optional65.0
caseStatusStringStatus of the case for the contact user.Optional65.0
compliance​DueDateStringDate by which compliance is expected for the hold violation.Optional65.0
dateCreatedStringDate from which the hold violation is effective.Optional65.0
dateResolvedStringDate on which the hold violation is resolved.Optional65.0
descriptionStringDescription of the hold violation.Optional65.0
reasonsString[]Reasons for the hold violation.Optional65.0
regulatory​CodeIdStringUnique ID for hold Definition.Required65.0
statusStringStatus of the hold violation.Optional65.0
typeStringType of the hold violation.Optional65.0

Response Body for POST 

Hold Violation