POST api/group/{id}/sendemail

To send an adhoc email to a group

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	Type	Additional information
IsDraft	boolean	None.
FromAddress	string	None.
FromName	string	None.
ToContactItemIds	Collection of integer	None.
CCContactItemIds	Collection of integer	None.
CCFreeTextEmails	Collection of string	None.
BCCContactItemIds	Collection of integer	None.
Body	SendGroupEmailBodyDataContract	None.
Subject	string	None.
PreferredProviderId	integer	None.
BrandId	integer	None.
BranchId	integer	None.
FranchiseId	integer	None.
AttachmentIds	Collection of integer	None.
GDPRTransactional	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "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

JobInvocationDetailsDataContract

Name	Type	Additional information
SupportsCancellation	boolean	None.
ReportsProgress	boolean	None.
InitialStatusText	string	None.
JobReference	globally unique identifier	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "a21bb5f7-d5b8-4c07-931a-dd35c2166d9e",
  "Success": true
}