Cancel campaign

Cancel campaign

Description

You can use this API to cancel your campaign.

Endpoint

    POST https://019sms.co.il/api
  

Parameters

Name	Type	Description	Required
cancel	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
campaign_id	int	The number of the your campaign	✔️

Request Example

json

Copy code

    {
  "cancel": {
    "user": {
      "username": "Leeroy"
    },
    "campaign_id": "1324"
  }
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <user>
        <username>Leeroy</username>
    </user>
    <campaign_id>1234</campaign_id>
</cancel>

  

Response Example

json

Copy code

    {
  "status": 0,
  "message": "Campaign successfuly cancel"
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <status>0</status>
    <message>Campaign successfuly cancel</message>
</cancel>

  

Note

Full description of the response status and message can be found in here:

Cancel campaigns by name

Description

You can use this API to cancel your campaigns by their campaign name.

Endpoint

    POST https://019sms.co.il/api
  

Parameters

Name	Type	Description	Required
cancel	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
campaign_name	string	The name of your campaign	✔️

Request Example

json

Copy code

    {
  "cancel": {
    "user": {
      "username": "Leeroy"
    },
    "campaign_name": "My Campaign"
  }
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <user>
        <username>Leeroy</username>
    </user>
    <campaign_name>My Campaign</campaign_name>
</cancel>

  

Response Example

json

Copy code

    {
  "status": 0,
  "message": "Campaigns successfully cancel",
  "count": 1
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <status>0</status>
    <message>Campaigns successfully cancel</message>
    <count>1</count>
</cancel>

  

Note

Full description of the response status and message can be found in here: