For more information on using API

POST http://webapi.mymarketing.co.il/api/whatsappcampaign/Campaign

Create and return a new WhatsApp campaign

Request Information

URI Parameters

Body Parameters

ApiWhatsAppCampaignUpdateCampaignContainer

Name

Description

Type

Additional information

campaign

is_sent

boolean
scheduled_date

date

Request Formats

application/json, text/json

Sample:
{
  "campaign": {
    "id": "0236a7d8-6e65-400d-8a4a-2afb65fd057f",
    "parentuserid": 2,
    "fromname": "sample string 3",
    "fromnumber": "sample string 4",
    "name": "sample string 5",
    "content": "sample string 6",
    "isdeleted": true,
    "totalsent": 8,
    "totalsucceeded": 9,
    "totalopens": 10,
    "totalfailed": 11,
    "canunsubscribe": true,
    "totalunsubscribed": 13,
    "unsubscribetext": "sample string 14",
    "totalcredits": 15,
    "wizardmaxstep": 64,
    "wizardcurrentstep": 64,
    "statustype": 0,
    "sendingprofileid": 16,
    "totalclicks": 17,
    "totaluniqueclicks": 18,
    "islinktracking": true,
    "sendtype": 1,
    "groupids": [
      1,
      2
    ],
    "mobilenumbers": {
      "sample string 1": 2,
      "sample string 3": 4
    },
    "restricatedgroupids": [
      1,
      2
    ],
    "restricatedcampaignids": [
      "832a7d96-9bc1-46d1-9f68-fc36cc5df776",
      "7ed6de9d-1590-4762-958b-f287f28e0756"
    ],
    "links": [
      {
        "id": "bcc0bdd4-8c23-451f-8761-598c0f4b383e",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      },
      {
        "id": "bcc0bdd4-8c23-451f-8761-598c0f4b383e",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      }
    ],
    "scheduledtimezoneid": 1,
    "scheduleddateutc": "2016-12-24T14:12:12",
    "datesentutc": "2016-12-24T14:12:12",
    "datecreatedutc": "2016-12-24T14:12:12",
    "dateupdatedutc": "2016-12-24T14:12:12",
    "datedeletedutc": "2016-12-24T14:12:12",
    "schemaid": 21,
    "templateid": "sample string 22",
    "type": 1,
    "attachments": [
      {
        "Url": "sample string 1",
        "Type": 0
      },
      {
        "Url": "sample string 1",
        "Type": 0
      }
    ],
    "removalword": "sample string 23"
  },
  "is_sent": true,
  "scheduled_date": "2016-12-24T14:12:12"
}

application/xml, text/xml

Sample:
<ApiWhatsAppCampaignUpdateCampaignContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.WhatsAppCampaignReport">
  <campaign xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.Campaign">
    <d2p1:Attachments xmlns:d3p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.Message">
      <d3p1:WhatsAppAttachment>
        <d3p1:Type>IMAGE</d3p1:Type>
        <d3p1:Url>sample string 1</d3p1:Url>
      </d3p1:WhatsAppAttachment>
      <d3p1:WhatsAppAttachment>
        <d3p1:Type>IMAGE</d3p1:Type>
        <d3p1:Url>sample string 1</d3p1:Url>
      </d3p1:WhatsAppAttachment>
    </d2p1:Attachments>
    <d2p1:CanUnsubscribe>true</d2p1:CanUnsubscribe>
    <d2p1:Content>sample string 6</d2p1:Content>
    <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
    <d2p1:DateDeletedUtc>2016-12-24T14:12:12</d2p1:DateDeletedUtc>
    <d2p1:DateSentUtc>2016-12-24T14:12:12</d2p1:DateSentUtc>
    <d2p1:DateUpdatedUtc>2016-12-24T14:12:12</d2p1:DateUpdatedUtc>
    <d2p1:FromName>sample string 3</d2p1:FromName>
    <d2p1:FromNumber>sample string 4</d2p1:FromNumber>
    <d2p1:GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:GroupIds>
    <d2p1:Id>0236a7d8-6e65-400d-8a4a-2afb65fd057f</d2p1:Id>
    <d2p1:IsDeleted>true</d2p1:IsDeleted>
    <d2p1:IsLinkTracking>true</d2p1:IsLinkTracking>
    <d2p1:Links>
      <d2p1:WhatsAppCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>bcc0bdd4-8c23-451f-8761-598c0f4b383e</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:WhatsAppCampaignLink>
      <d2p1:WhatsAppCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>bcc0bdd4-8c23-451f-8761-598c0f4b383e</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:WhatsAppCampaignLink>
    </d2p1:Links>
    <d2p1:MobileNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringlong>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>2</d3p1:Value>
      </d3p1:KeyValueOfstringlong>
      <d3p1:KeyValueOfstringlong>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>4</d3p1:Value>
      </d3p1:KeyValueOfstringlong>
    </d2p1:MobileNumbers>
    <d2p1:Name>sample string 5</d2p1:Name>
    <d2p1:ParentUserId>2</d2p1:ParentUserId>
    <d2p1:RemovalWord>sample string 23</d2p1:RemovalWord>
    <d2p1:RestricatedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>832a7d96-9bc1-46d1-9f68-fc36cc5df776</d3p1:guid>
      <d3p1:guid>7ed6de9d-1590-4762-958b-f287f28e0756</d3p1:guid>
    </d2p1:RestricatedCampaignIds>
    <d2p1:RestricatedGroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:RestricatedGroupIds>
    <d2p1:ScheduledDateUtc>2016-12-24T14:12:12</d2p1:ScheduledDateUtc>
    <d2p1:ScheduledTimeZoneId>1</d2p1:ScheduledTimeZoneId>
    <d2p1:SchemaId>21</d2p1:SchemaId>
    <d2p1:SendType>Regular</d2p1:SendType>
    <d2p1:SendingProfileId>16</d2p1:SendingProfileId>
    <d2p1:StatusType>None</d2p1:StatusType>
    <d2p1:TemplateId>sample string 22</d2p1:TemplateId>
    <d2p1:TotalClicks>17</d2p1:TotalClicks>
    <d2p1:TotalCredits>15</d2p1:TotalCredits>
    <d2p1:TotalFailed>11</d2p1:TotalFailed>
    <d2p1:TotalOpens>10</d2p1:TotalOpens>
    <d2p1:TotalSent>8</d2p1:TotalSent>
    <d2p1:TotalSucceeded>9</d2p1:TotalSucceeded>
    <d2p1:TotalUniqueClicks>18</d2p1:TotalUniqueClicks>
    <d2p1:TotalUnsubscribed>13</d2p1:TotalUnsubscribed>
    <d2p1:Type>Template</d2p1:Type>
    <d2p1:UnsubscribeText>sample string 14</d2p1:UnsubscribeText>
    <d2p1:WizardCurrentStep>64</d2p1:WizardCurrentStep>
    <d2p1:WizardMaxStep>64</d2p1:WizardMaxStep>
  </campaign>
  <is_sent>true</is_sent>
  <scheduled_date>2016-12-24T14:12:12</scheduled_date>
</ApiWhatsAppCampaignUpdateCampaignContainer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiWhatsAppCampaignInfoCampaign

Name

Description

Type

Additional information

campaign

send_type_name

string
status_name

string
status_date

date
handled_date

date

Response Formats

application/json, text/json

Sample:
{
  "campaign": {
    "id": "9eb8e415-ad9b-487b-9cb0-5fe2e1fdc095",
    "parentuserid": 2,
    "fromname": "sample string 3",
    "fromnumber": "sample string 4",
    "name": "sample string 5",
    "content": "sample string 6",
    "isdeleted": true,
    "totalsent": 8,
    "totalsucceeded": 9,
    "totalopens": 10,
    "totalfailed": 11,
    "canunsubscribe": true,
    "totalunsubscribed": 13,
    "unsubscribetext": "sample string 14",
    "totalcredits": 15,
    "wizardmaxstep": 64,
    "wizardcurrentstep": 64,
    "statustype": 0,
    "sendingprofileid": 16,
    "totalclicks": 17,
    "totaluniqueclicks": 18,
    "islinktracking": true,
    "sendtype": 1,
    "groupids": [
      1,
      2
    ],
    "mobilenumbers": {
      "sample string 1": 2,
      "sample string 3": 4
    },
    "restricatedgroupids": [
      1,
      2
    ],
    "restricatedcampaignids": [
      "1cdbe9fe-bf2f-4fbe-9e4d-0ab2ee49dcbb",
      "47e2809e-fb75-4196-95b5-b889f9633a7b"
    ],
    "links": [
      {
        "id": "a7049ec9-45e8-4032-8e31-b89a82640933",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      },
      {
        "id": "a7049ec9-45e8-4032-8e31-b89a82640933",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      }
    ],
    "scheduledtimezoneid": 1,
    "scheduleddateutc": "2016-12-24T14:12:12",
    "datesentutc": "2016-12-24T14:12:12",
    "datecreatedutc": "2016-12-24T14:12:12",
    "dateupdatedutc": "2016-12-24T14:12:12",
    "datedeletedutc": "2016-12-24T14:12:12",
    "schemaid": 21,
    "templateid": "sample string 22",
    "type": 1,
    "attachments": [
      {
        "Url": "sample string 1",
        "Type": 0
      },
      {
        "Url": "sample string 1",
        "Type": 0
      }
    ],
    "removalword": "sample string 23"
  },
  "send_type_name": "sample string 1",
  "status_name": "sample string 2",
  "status_date": "2016-12-24T14:12:12",
  "handled_date": "2016-12-24T14:12:12"
}

application/xml, text/xml

Sample:
<ApiWhatsAppCampaignInfoCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.WhatsAppCampaignReport">
  <campaign xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.Campaign">
    <d2p1:Attachments xmlns:d3p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.Message">
      <d3p1:WhatsAppAttachment>
        <d3p1:Type>IMAGE</d3p1:Type>
        <d3p1:Url>sample string 1</d3p1:Url>
      </d3p1:WhatsAppAttachment>
      <d3p1:WhatsAppAttachment>
        <d3p1:Type>IMAGE</d3p1:Type>
        <d3p1:Url>sample string 1</d3p1:Url>
      </d3p1:WhatsAppAttachment>
    </d2p1:Attachments>
    <d2p1:CanUnsubscribe>true</d2p1:CanUnsubscribe>
    <d2p1:Content>sample string 6</d2p1:Content>
    <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
    <d2p1:DateDeletedUtc>2016-12-24T14:12:12</d2p1:DateDeletedUtc>
    <d2p1:DateSentUtc>2016-12-24T14:12:12</d2p1:DateSentUtc>
    <d2p1:DateUpdatedUtc>2016-12-24T14:12:12</d2p1:DateUpdatedUtc>
    <d2p1:FromName>sample string 3</d2p1:FromName>
    <d2p1:FromNumber>sample string 4</d2p1:FromNumber>
    <d2p1:GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:GroupIds>
    <d2p1:Id>9eb8e415-ad9b-487b-9cb0-5fe2e1fdc095</d2p1:Id>
    <d2p1:IsDeleted>true</d2p1:IsDeleted>
    <d2p1:IsLinkTracking>true</d2p1:IsLinkTracking>
    <d2p1:Links>
      <d2p1:WhatsAppCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>a7049ec9-45e8-4032-8e31-b89a82640933</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:WhatsAppCampaignLink>
      <d2p1:WhatsAppCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>a7049ec9-45e8-4032-8e31-b89a82640933</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:WhatsAppCampaignLink>
    </d2p1:Links>
    <d2p1:MobileNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringlong>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>2</d3p1:Value>
      </d3p1:KeyValueOfstringlong>
      <d3p1:KeyValueOfstringlong>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>4</d3p1:Value>
      </d3p1:KeyValueOfstringlong>
    </d2p1:MobileNumbers>
    <d2p1:Name>sample string 5</d2p1:Name>
    <d2p1:ParentUserId>2</d2p1:ParentUserId>
    <d2p1:RemovalWord>sample string 23</d2p1:RemovalWord>
    <d2p1:RestricatedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>1cdbe9fe-bf2f-4fbe-9e4d-0ab2ee49dcbb</d3p1:guid>
      <d3p1:guid>47e2809e-fb75-4196-95b5-b889f9633a7b</d3p1:guid>
    </d2p1:RestricatedCampaignIds>
    <d2p1:RestricatedGroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:RestricatedGroupIds>
    <d2p1:ScheduledDateUtc>2016-12-24T14:12:12</d2p1:ScheduledDateUtc>
    <d2p1:ScheduledTimeZoneId>1</d2p1:ScheduledTimeZoneId>
    <d2p1:SchemaId>21</d2p1:SchemaId>
    <d2p1:SendType>Regular</d2p1:SendType>
    <d2p1:SendingProfileId>16</d2p1:SendingProfileId>
    <d2p1:StatusType>None</d2p1:StatusType>
    <d2p1:TemplateId>sample string 22</d2p1:TemplateId>
    <d2p1:TotalClicks>17</d2p1:TotalClicks>
    <d2p1:TotalCredits>15</d2p1:TotalCredits>
    <d2p1:TotalFailed>11</d2p1:TotalFailed>
    <d2p1:TotalOpens>10</d2p1:TotalOpens>
    <d2p1:TotalSent>8</d2p1:TotalSent>
    <d2p1:TotalSucceeded>9</d2p1:TotalSucceeded>
    <d2p1:TotalUniqueClicks>18</d2p1:TotalUniqueClicks>
    <d2p1:TotalUnsubscribed>13</d2p1:TotalUnsubscribed>
    <d2p1:Type>Template</d2p1:Type>
    <d2p1:UnsubscribeText>sample string 14</d2p1:UnsubscribeText>
    <d2p1:WizardCurrentStep>64</d2p1:WizardCurrentStep>
    <d2p1:WizardMaxStep>64</d2p1:WizardMaxStep>
  </campaign>
  <handled_date>2016-12-24T14:12:12</handled_date>
  <send_type_name>sample string 1</send_type_name>
  <status_date>2016-12-24T14:12:12</status_date>
  <status_name>sample string 2</status_name>
</ApiWhatsAppCampaignInfoCampaign>