POST api/Campaigns/CreateCampaign
Creates a new campaign
Request Information
URI Parameters
None.
Body Parameters
Details of the new campaign
CreateCampaignRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken | string |
None. |
|
| Title | string |
None. |
|
| Text | string |
None. |
|
| Folder | integer |
None. |
|
| Brand | string |
None. |
|
| FromNumber | string |
None. |
|
| LaunchAt | date |
None. |
|
| Lease | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"SessionToken": "sample string 1",
"Title": "sample string 2",
"Text": "sample string 3",
"Folder": 4,
"Brand": "sample string 5",
"FromNumber": "sample string 6",
"LaunchAt": "2025-10-24T15:16:02.872726+01:00",
"Lease": 8
}
application/xml, text/xml
Sample:
<CreateCampaignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector"> <Brand>sample string 5</Brand> <Folder>4</Folder> <FromNumber>sample string 6</FromNumber> <LaunchAt>2025-10-24T15:16:02.872726+01:00</LaunchAt> <Lease>8</Lease> <SessionToken>sample string 1</SessionToken> <Text>sample string 3</Text> <Title>sample string 2</Title> </CreateCampaignRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The ID of the new campaign
APIReturnOfCampaignStatusAndInt32| Name | Description | Type | Additional information |
|---|---|---|---|
| StatusEnum | CampaignStatus |
None. |
|
| Status | string |
None. |
|
| Result | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"StatusEnum": 0,
"Status": "Success",
"Result": 1
}
application/xml, text/xml
Sample:
<APIReturnOfCampaignStatusintArk7AG5L xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector"> <Result>1</Result> <StatusEnum>Success</StatusEnum> </APIReturnOfCampaignStatusintArk7AG5L>