Name

Description

Type

Additional information

group_ids

List of group IDs that will recieve the campaign.Can be found using the endpoint "Get account's groups" or in the UI(go to Contacts->Groups->click on the group's name -> you'll find the id int the URL)

Collection of integer

Required

restricated_group_ids

Do not send the SMS to users that are in those groups. IDs Can be found using the endpoint "Get account's groups" or in the UI(go to Contacts->Groups->click on the group's name -> you'll find the id int the URL)

Collection of integer
restricated_campaign_ids

Do not send the SMS to users that got the following campaigns. Can be found using the endpoint "Get account's email campaigns..." or in the UI (go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id int the URL)

Collection of integer
mailing_list_id

The mailing list the sms is going to be sent to. Required if you have mailing lists on your account - if not, remove this parameter. Can be found using the endpoint "Get account's mailing lists" or in the UI (go to Contacts->Mailing Lists->click on the mailing lists's name -> you'll find the id int the URL)

integer
limit_amount

Limit the number of sms to send

integer
sms_sending_profile_id

SMS sending profile ID. Required if "from_name" is not used. Can be found using the endpoint "Get account's sms campaigns.." or in the UI (go to Mobile -> SMS -> SMS list -> inspect/F12)

integer