POST api/group/{id}/sendsms

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

SendGroupSMSDataContract
NameDescriptionTypeAdditional information
ContactItemIds

Collection of integer

None.

Message

string

None.

PreferredProviderId

integer

None.

BrandId

integer

None.

FranchiseId

integer

None.

GroupId

integer

None.

GDPRTransactional

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ContactItemIds": [
    1,
    2
  ],
  "Message": "sample string 1",
  "PreferredProviderId": 1,
  "BrandId": 1,
  "FranchiseId": 1,
  "GroupId": 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 'SendGroupSMSDataContract'.

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": "d46d04b2-41db-47fe-92e2-44590df74198",
  "Success": true
}