POST api/group/{id}/sendsms

To send an adhoc sms to a group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

Details of the sms to send

Dezrez.Core.DataContracts.External.Api.Group.Command.SendSMS.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/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "ContactItemIds": [
    1,
    2
  ],
  "Message": "sample string 1",
  "PreferredProviderId": 1,
  "BrandId": 1,
  "FranchiseId": 1,
  "GroupId": 2,
  "GDPRTransactional": true
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.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": "e109fc7a-81f5-4719-85d2-26b0267cbbf8",
  "Success": true
}