POST api/group/{id}/sendemail
To send an adhoc email 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 group id |
integer |
Required |
Body Parameters
Details of the email to send
SendGroupEmailDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| IsDraft |
Indicates whether this item is draft. |
boolean |
None. |
| FromAddress |
The from address value. |
string |
None. |
| FromName |
The from name value. |
string |
None. |
| ToContactItemIds |
The unique identifiers of the related to contact item resources. |
Collection of integer |
None. |
| CCContactItemIds |
The unique identifiers of the related cc contact item resources. |
Collection of integer |
None. |
| CCFreeTextEmails |
The collection of cc free text emails. |
Collection of string |
None. |
| BCCContactItemIds |
The unique identifiers of the related bcc contact item resources. |
Collection of integer |
None. |
| Body |
The body value. |
SendGroupEmailBodyDataContract |
None. |
| Subject |
The subject 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. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| FranchiseId |
The unique identifier of the related franchise resource. |
integer |
None. |
| AttachmentIds |
The unique identifiers of the related attachment resources. |
Collection of 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
{
"IsDraft": true,
"FromAddress": "sample string 2",
"FromName": "sample string 3",
"ToContactItemIds": [
1,
2
],
"CCContactItemIds": [
1,
2
],
"CCFreeTextEmails": [
"sample string 1",
"sample string 2"
],
"BCCContactItemIds": [
1,
2
],
"Body": {
"Html": "sample string 1",
"PlainText": "sample string 2"
},
"Subject": "sample string 4",
"PreferredProviderId": 1,
"BrandId": 1,
"BranchId": 1,
"FranchiseId": 1,
"AttachmentIds": [
1,
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": "4eea1e8d-13b8-4fe5-8a30-695bad935975",
"Success": true
}