For more information on using API

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

Create and return a new Push campaign

Request Information

URI Parameters

Body Parameters

ApiPushCampaignUpdateCampaignContainer

Name

Description

Type

Additional information

campaign

is_sent

boolean
scheduled_date

date

Request Formats

application/json, text/json

Sample:
{
  "campaign": {
    "CampaignIndexId": "",
    "id": "d9f7780d-514a-41b8-90f0-3d787de97fa2",
    "parentuserid": 2,
    "title": "sample string 3",
    "subtitle": "sample string 4",
    "priority": 0,
    "sound": 0,
    "fromname": "sample string 5",
    "fromnumber": "sample string 6",
    "name": "sample string 7",
    "content": "sample string 8",
    "isdeleted": true,
    "totalsent": 10,
    "totalsucceeded": 11,
    "totalopens": 12,
    "totalfailed": 13,
    "canunsubscribe": true,
    "totalunsubscribed": 15,
    "unsubscribetext": "sample string 16",
    "removalword": "sample string 17",
    "wizardmaxstep": 64,
    "wizardcurrentstep": 64,
    "statustype": 0,
    "sendingprofileid": 18,
    "totalclicks": 19,
    "totaluniqueclicks": 20,
    "islinktracking": true,
    "sendtype": 1,
    "groupids": [
      1,
      2
    ],
    "restricatedgroupids": [
      1,
      2
    ],
    "restricatedcampaignids": [
      "642fb040-e097-46c3-9e7d-01276de39bad",
      "c743c9cc-a19f-44ba-a26f-83f64da9d489"
    ],
    "restricatedopenedcampaignids": [
      "dabb3a69-5a4d-477b-81e6-7d5580c463cc",
      "6b4b95ca-1e29-4bae-839b-52a0770159a3"
    ],
    "links": [
      {
        "id": "4b6cf3e2-5e2d-4167-83b6-49fb9890669c",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      },
      {
        "id": "4b6cf3e2-5e2d-4167-83b6-49fb9890669c",
        "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": 23,
    "templateid": "sample string 24",
    "imageurl": "sample string 25",
    "devicetokens": {
      "sample string 1": [
        "sample string 1",
        "sample string 2"
      ],
      "sample string 2": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "sendtoallusers": true,
    "sendtoanonymoususersonly": true,
    "deeplink": "sample string 28"
  },
  "is_sent": true,
  "scheduled_date": "2016-12-24T14:12:12"
}

application/xml, text/xml

Sample:
<ApiPushCampaignUpdateCampaignContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.PushNotification.PushCampaignReport">
  <campaign xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.PushNotification.Campaign">
    <d2p1:CanUnsubscribe>true</d2p1:CanUnsubscribe>
    <d2p1:Content>sample string 8</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:DeepLink>sample string 28</d2p1:DeepLink>
    <d2p1:DeviceTokens xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    </d2p1:DeviceTokens>
    <d2p1:FromName>sample string 5</d2p1:FromName>
    <d2p1:FromNumber>sample string 6</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>d9f7780d-514a-41b8-90f0-3d787de97fa2</d2p1:Id>
    <d2p1:ImageUrl>sample string 25</d2p1:ImageUrl>
    <d2p1:IsDeleted>true</d2p1:IsDeleted>
    <d2p1:IsLinkTracking>true</d2p1:IsLinkTracking>
    <d2p1:Links>
      <d2p1:PushCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>4b6cf3e2-5e2d-4167-83b6-49fb9890669c</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:PushCampaignLink>
      <d2p1:PushCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>4b6cf3e2-5e2d-4167-83b6-49fb9890669c</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:PushCampaignLink>
    </d2p1:Links>
    <d2p1:Name>sample string 7</d2p1:Name>
    <d2p1:ParentUserId>2</d2p1:ParentUserId>
    <d2p1:Priority>None</d2p1:Priority>
    <d2p1:RemovalWord>sample string 17</d2p1:RemovalWord>
    <d2p1:RestricatedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>642fb040-e097-46c3-9e7d-01276de39bad</d3p1:guid>
      <d3p1:guid>c743c9cc-a19f-44ba-a26f-83f64da9d489</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:RestricatedOpenedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>dabb3a69-5a4d-477b-81e6-7d5580c463cc</d3p1:guid>
      <d3p1:guid>6b4b95ca-1e29-4bae-839b-52a0770159a3</d3p1:guid>
    </d2p1:RestricatedOpenedCampaignIds>
    <d2p1:ScheduledDateUtc>2016-12-24T14:12:12</d2p1:ScheduledDateUtc>
    <d2p1:ScheduledTimeZoneId>1</d2p1:ScheduledTimeZoneId>
    <d2p1:SchemaId>23</d2p1:SchemaId>
    <d2p1:SendToAllUsers>true</d2p1:SendToAllUsers>
    <d2p1:SendToAnonymousUsersOnly>true</d2p1:SendToAnonymousUsersOnly>
    <d2p1:SendType>Regular</d2p1:SendType>
    <d2p1:SendingProfileId>18</d2p1:SendingProfileId>
    <d2p1:Sound>Default</d2p1:Sound>
    <d2p1:StatusType>None</d2p1:StatusType>
    <d2p1:Subtitle>sample string 4</d2p1:Subtitle>
    <d2p1:TemplateId>sample string 24</d2p1:TemplateId>
    <d2p1:Title>sample string 3</d2p1:Title>
    <d2p1:TotalClicks>19</d2p1:TotalClicks>
    <d2p1:TotalFailed>13</d2p1:TotalFailed>
    <d2p1:TotalOpens>12</d2p1:TotalOpens>
    <d2p1:TotalSent>10</d2p1:TotalSent>
    <d2p1:TotalSucceeded>11</d2p1:TotalSucceeded>
    <d2p1:TotalUniqueClicks>20</d2p1:TotalUniqueClicks>
    <d2p1:TotalUnsubscribed>15</d2p1:TotalUnsubscribed>
    <d2p1:UnsubscribeText>sample string 16</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>
</ApiPushCampaignUpdateCampaignContainer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiPushCampaignInfoCampaign

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": {
    "CampaignIndexId": "",
    "id": "b2ab50f6-ba82-43f5-974a-93298a5bc3bb",
    "parentuserid": 2,
    "title": "sample string 3",
    "subtitle": "sample string 4",
    "priority": 0,
    "sound": 0,
    "fromname": "sample string 5",
    "fromnumber": "sample string 6",
    "name": "sample string 7",
    "content": "sample string 8",
    "isdeleted": true,
    "totalsent": 10,
    "totalsucceeded": 11,
    "totalopens": 12,
    "totalfailed": 13,
    "canunsubscribe": true,
    "totalunsubscribed": 15,
    "unsubscribetext": "sample string 16",
    "removalword": "sample string 17",
    "wizardmaxstep": 64,
    "wizardcurrentstep": 64,
    "statustype": 0,
    "sendingprofileid": 18,
    "totalclicks": 19,
    "totaluniqueclicks": 20,
    "islinktracking": true,
    "sendtype": 1,
    "groupids": [
      1,
      2
    ],
    "restricatedgroupids": [
      1,
      2
    ],
    "restricatedcampaignids": [
      "c57eea7c-1d12-4889-a110-86aa62c2e9a1",
      "02b3240f-405c-40e3-ba37-a4ac5f4f6a60"
    ],
    "restricatedopenedcampaignids": [
      "d79cb45d-1e1f-4e31-a601-0b85694e0faf",
      "7ecb30cc-4a56-4dfd-a37b-62e7fa53024a"
    ],
    "links": [
      {
        "id": "620b10dc-e5d2-491d-80f3-4e3d6ed476af",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      },
      {
        "id": "620b10dc-e5d2-491d-80f3-4e3d6ed476af",
        "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": 23,
    "templateid": "sample string 24",
    "imageurl": "sample string 25",
    "devicetokens": {
      "sample string 1": [
        "sample string 1",
        "sample string 2"
      ],
      "sample string 2": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "sendtoallusers": true,
    "sendtoanonymoususersonly": true,
    "deeplink": "sample string 28"
  },
  "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:
<ApiPushCampaignInfoCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.PushNotification.PushCampaignReport">
  <campaign xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.PushNotification.Campaign">
    <d2p1:CanUnsubscribe>true</d2p1:CanUnsubscribe>
    <d2p1:Content>sample string 8</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:DeepLink>sample string 28</d2p1:DeepLink>
    <d2p1:DeviceTokens xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    </d2p1:DeviceTokens>
    <d2p1:FromName>sample string 5</d2p1:FromName>
    <d2p1:FromNumber>sample string 6</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>b2ab50f6-ba82-43f5-974a-93298a5bc3bb</d2p1:Id>
    <d2p1:ImageUrl>sample string 25</d2p1:ImageUrl>
    <d2p1:IsDeleted>true</d2p1:IsDeleted>
    <d2p1:IsLinkTracking>true</d2p1:IsLinkTracking>
    <d2p1:Links>
      <d2p1:PushCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>620b10dc-e5d2-491d-80f3-4e3d6ed476af</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:PushCampaignLink>
      <d2p1:PushCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>620b10dc-e5d2-491d-80f3-4e3d6ed476af</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:PushCampaignLink>
    </d2p1:Links>
    <d2p1:Name>sample string 7</d2p1:Name>
    <d2p1:ParentUserId>2</d2p1:ParentUserId>
    <d2p1:Priority>None</d2p1:Priority>
    <d2p1:RemovalWord>sample string 17</d2p1:RemovalWord>
    <d2p1:RestricatedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>c57eea7c-1d12-4889-a110-86aa62c2e9a1</d3p1:guid>
      <d3p1:guid>02b3240f-405c-40e3-ba37-a4ac5f4f6a60</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:RestricatedOpenedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>d79cb45d-1e1f-4e31-a601-0b85694e0faf</d3p1:guid>
      <d3p1:guid>7ecb30cc-4a56-4dfd-a37b-62e7fa53024a</d3p1:guid>
    </d2p1:RestricatedOpenedCampaignIds>
    <d2p1:ScheduledDateUtc>2016-12-24T14:12:12</d2p1:ScheduledDateUtc>
    <d2p1:ScheduledTimeZoneId>1</d2p1:ScheduledTimeZoneId>
    <d2p1:SchemaId>23</d2p1:SchemaId>
    <d2p1:SendToAllUsers>true</d2p1:SendToAllUsers>
    <d2p1:SendToAnonymousUsersOnly>true</d2p1:SendToAnonymousUsersOnly>
    <d2p1:SendType>Regular</d2p1:SendType>
    <d2p1:SendingProfileId>18</d2p1:SendingProfileId>
    <d2p1:Sound>Default</d2p1:Sound>
    <d2p1:StatusType>None</d2p1:StatusType>
    <d2p1:Subtitle>sample string 4</d2p1:Subtitle>
    <d2p1:TemplateId>sample string 24</d2p1:TemplateId>
    <d2p1:Title>sample string 3</d2p1:Title>
    <d2p1:TotalClicks>19</d2p1:TotalClicks>
    <d2p1:TotalFailed>13</d2p1:TotalFailed>
    <d2p1:TotalOpens>12</d2p1:TotalOpens>
    <d2p1:TotalSent>10</d2p1:TotalSent>
    <d2p1:TotalSucceeded>11</d2p1:TotalSucceeded>
    <d2p1:TotalUniqueClicks>20</d2p1:TotalUniqueClicks>
    <d2p1:TotalUnsubscribed>15</d2p1:TotalUnsubscribed>
    <d2p1:UnsubscribeText>sample string 16</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>
</ApiPushCampaignInfoCampaign>