For more information on using API

PUT https://webapi.mymarketing.co.il/api/smscampaign/Campaign/{id}

Update SMS campaign (whether it was sent or not). You can also sent the updated campaign in the process

Request Information

URI Parameters

Name

Description

Type

Additional information

id

SMS profile ID. The phone number of which the SMS will be sent from. Can be found using the endpoint "Get the account Sms sending profiles" or in the UI (go to Mobile -> SMS -> Sending Profiles -> inspect/F12)

integer

Required

Body Parameters

ApiSmsCampaignUpdateCampaignContainer

Name

Description

Type

Additional information

id

SMS profile ID. The phone number of which the SMS will be sent from. Can be found using the endpoint "Get the account Sms sending profiles" or in the UI (go to Mobile -> SMS -> Sending Profiles -> inspect/F12)

integer

Required

name

SMS campaign name. Internal use only.

string

Required

from_name

From name. Required if "sms_sending_profile_id" is not used. The sender name. The name must be up to 11 English letters without special characters or spaces.

string
content

SMS content.

string

Required

segment

Camapaign segmantation and sending restrictions

ApiSmsCampaignSegment

Required

scheduling

Scheduling the SMS campaign

ApiSmsCampaignTimeZoneScheduling

Required

is_link_tracking

Is links are tracked

boolean

Request Formats

application/json, text/json

Sample: 
{
  "id": 1,
  "name": "sample string 2",
  "from_name": "sample string 3",
  "content": "sample string 4",
  "segment": {
    "group_ids": [
      1,
      2
    ],
    "restricated_group_ids": [
      1,
      2
    ],
    "restricated_campaign_ids": [
      1,
      2
    ],
    "mailing_list_id": 1,
    "limit_amount": 1,
    "sms_sending_profile_id": 1
  },
  "scheduling": {
    "is_sent": true,
    "scheduled_time_zone": "Israel",
    "scheduled_date": "2016-12-24T14:12:12"
  },
  "is_link_tracking": true
}

application/xml, text/xml

Sample: 
<ApiSmsCampaignUpdateCampaignContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <content>sample string 4</content>
  <from_name>sample string 3</from_name>
  <is_link_tracking>true</is_link_tracking>
  <name>sample string 2</name>
  <scheduling>
    <is_sent>true</is_sent>
    <scheduled_date>2016-12-24T14:12:12</scheduled_date>
    <scheduled_time_zone>Israel</scheduled_time_zone>
  </scheduling>
  <segment>
    <group_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </group_ids>
    <limit_amount>1</limit_amount>
    <mailing_list_id>1</mailing_list_id>
    <restricated_campaign_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </restricated_campaign_ids>
    <restricated_group_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </restricated_group_ids>
    <sms_sending_profile_id>1</sms_sending_profile_id>
  </segment>
  <id>1</id>
</ApiSmsCampaignUpdateCampaignContainer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.