//[[restapi:start|RESTful API]]//

====== Create Campaign ======

==== Previous versions ====
<wrap button>[[restapi:create_campaign_3_34|Tag 34]]</wrap>
==== Overview ====

Allows the user to create interactive campaigns

==== URL ====

Http access method: <wrap notice>POST</wrap>

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/campaign/{instanceId}/{minType}/{publicKey}/{signature}

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| minType | The type of campaign you want to create/edit. See the available [[restapi:appx_c_types|Campaign's Types]] for more information |
| Json \\ <wrap notice>POST</wrap> | The campaign description in detail. Learn more about the [[restapi:campaign_json|Campaign Descriptor]] file |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |

==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>createCampaign</input>
<status>OK</status>
<description>Completed</description>
<result>
      <mim>
         <id>1</id>
         <msgtype>2</msgtype>
         <name>MIM1</name>
         <description>MIM description</description>
         <active>1</active>
         <deliveryMethod>SMS</deliveryMethod>
      </mim>
</result>

</code>