POST api/group/{id}/sendsms
To send an adhoc sms to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
Body Parameters
Details of the sms to send
SendGroupSMSDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| ContactItemIds |
The unique identifiers of the related contact item resources. |
Collection of integer |
None. |
| Message |
The message value. |
string |
None. |
| PreferredProviderId |
The unique identifier of the related preferred provider resource. |
integer |
None. |
| BrandId |
The unique identifier of the related brand resource. |
integer |
None. |
| FranchiseId |
The unique identifier of the related franchise resource. |
integer |
None. |
| GroupId |
The unique identifier of the related group resource. |
integer |
None. |
| GDPRTransactional |
Indicates whether gdpr transactional is true. |
boolean |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"ContactItemIds": [
1,
2
],
"Message": "sample string 1",
"PreferredProviderId": 1,
"BrandId": 1,
"FranchiseId": 1,
"GroupId": 2,
"GDPRTransactional": true
}
Response Information
Resource Description
The response returned after the operation completes.
JobInvocationDetailsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SupportsCancellation |
Indicates whether supports cancellation is true. |
boolean |
None. |
| ReportsProgress |
Indicates whether reports progress is true. |
boolean |
None. |
| InitialStatusText |
The initial status text value. |
string |
None. |
| JobReference |
The job reference globally unique identifier. |
globally unique identifier |
None. |
| Success |
Indicates whether success is true. |
boolean |
None. |
Response Formats
application/json, text/json
{
"SupportsCancellation": true,
"ReportsProgress": true,
"InitialStatusText": "sample string 3",
"JobReference": "f0c09456-995a-4cfe-8f35-e28dc3a827cc",
"Success": true
}