Adds a subscriber to the named subscriber lists of a case.
Namespace
goss.CaseManagement.v1.api.case.caseSubscriber.caseSubscriberCreate
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| caseSubscriberToCreate | Object | Details of the subscriber |
| caseSubscriberToCreate.email | String <email> | The email address of the subscriber |
| caseSubscriberToCreate.subs | Array <String> | The names of the subscriber lists. Allowed values: caseClosed |
| user | Object | Details of the user |
| user.siteUserName | String | The username a valid case manager |
| Optional Properties | Type | Description |
| n/a | n/a | n/a |
{
"caseBusinessKey": "0123-4567-8901-2345",
"caseSubscriberToCreate": {
"email": "[email protected]",
"subs": [
"caseClosed"
]
},
"user": {
"siteUserName": "Abc"
}
}
Returns
| Property | Type | Description |
|---|---|---|
| success | Boolean | Whether the request completed successfully |
| errors | Array | Any errors that occurred. Only returned if there are errors |
| warnings | Array | Any warnings that occurred. Only returned if there are warnings |
Rules
| Rule | Validation error |
|---|---|
| User must exist | Could not retrieve siteUser details |
| Case must exist | Could not retrieve case Case 1234-5678-9012-3456 |
| Case must be active | User aUser does not have permissions to add a subscriber |
| User must be a member of the case managers group or the case manager if one is assigned | User aUser does not have permissions to add a subscriber |
Behaviour
If the validation rules pass
- Adds the email address to each of the named subscriber lists for the case
Last modified on 20 October 2026
