POST api/group/{id}/sendemail

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

SendGroupEmailDataContract
NameDescriptionTypeAdditional information
IsDraft

boolean

None.

FromAddress

string

None.

FromName

string

None.

ToContactItemIds

Collection of integer

None.

CCContactItemIds

Collection of integer

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/json, text/json

Sample:
{
  "IsDraft": true,
  "FromAddress": "sample string 2",
  "FromName": "sample string 3",
  "ToContactItemIds": [
    1,
    2
  ],
  "CCContactItemIds": [
    1,
    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
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SendGroupEmailDataContract'.

Response Information

Resource Description

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional 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": "01009d9a-7e2c-492a-a6d4-db0ae3318dc4",
  "Success": true
}