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

====== Create Label ======

==== Previous Versions ====
<wrap button>[[restapi:create_label_3_34|Tag 34]]</wrap>

==== Overview ====

Creates a new Label.

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

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/createLabel/{instanceId}/{mimId}/{labelName}/{labelId}/{labelResponse}/{publicKey}/{signature}/?labelKeyword=

^ 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// |
| mimId | The campaign id, you could retrieve this information from the campaign manager UI or using the [[restapi:campaigns#list_campaigns|List Campaigns]] |
| labelName | The new name to assign to the label. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| labelId | The label id to use |
| labelResponse | The new response to assign to the label. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| labelKeyword | New list of keywords for the label |
| 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>createLabel</input>
   <status>OK</status>
   <description>Completed</description>
   <result>
      <label>
         <index>1</index>
         <name>testqaCreateLabel</name>
         <keyword>testqCreate</keyword>
         <response>Test QA Create Label</response>
      </label>
   </result>

</code>