# Create Project

{% hint style="danger" %}

## Project Management API is disabled from Feb 1st, 2023 onwards, so any request made to this en point will fail

{% endhint %}

API to Create A New Project under your account.

## &#x20;Create New Project

<mark style="color:green;">`POST`</mark> `https://pickyassist.com/app/api/v2/pm/create-project`

This API allows you to Create Project

#### Request Body

| Name                  | Type    | Description                                                                                                                                                                                                                                                         |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token                 | string  | Your Master API Token for authentication                                                                                                                                                                                                                            |
| project\_name         | string  | Project Name for you reference maximum 20 characters allowed                                                                                                                                                                                                        |
| number                | number  | A WhatsApp or any number can given for your internal reference                                                                                                                                                                                                      |
| company\_name         | string  | Company Name for your reference                                                                                                                                                                                                                                     |
| country               | string  | Country of the customer Refer Here                                                                                                                                                                                                                                  |
| time\_zone            | string  | Time Zone of the customer Refer Here                                                                                                                                                                                                                                |
| date\_format          | number  | <p>Select the Date Format <br><br>YYYY-MM-DD<br>DD-MM-YYYY<br>MM-DD-YYYY</p>                                                                                                                                                                                        |
| service               | number  | <p>Specify the service which need to enabled o the project<br><br>1=Phone Automation</p>                                                                                                                                                                            |
| billing\_plan         | number  | <p>Specify the billing plan need to be applied to the project<br><br>1= Pay As You Go<br><br>2= Phone Automation Small<br>3= Phone Automation Medium<br>4 =Phone Automation Large<br>5= Phone Automation Unlimited<br>6 = Phone Automation Yearly Unlimited<br></p> |
| generate\_api\_token  | boolean | <p>Whether API token need to generated or not for the project <br><br>true<br>false<br></p>                                                                                                                                                                         |
| token\_ip\_address    | array   | <p>If you need to bind the API token with IP address then please pass the IP address in an array <br><br>\[ "192.168.0.1", "202.164.148.84" ]</p>                                                                                                                   |
| global\_webhook       | string  | You can pass the global webhook which need to be configured against the project                                                                                                                                                                                     |
| event\_webhook        | string  | <p>You can set the event webhook which need to be configured against the project<br></p>                                                                                                                                                                            |
| smart\_reply\_webhook | string  | <p>Smart Replies webhook which need to be configured, please note if the smart reply webhook is configured and smart reply is online then global webhook will not get trigger <br></p>                                                                              |
| notes                 | string  | <p>Specify if any notes to identify the customers for your internal reference , maximum 250 characters allowed<br><br></p>                                                                                                                                          |

{% tabs %}
{% tab title="200 " %}

```
{
   "status":100,
   "message":"Success",
   "project_status":"Active",
   "project_id":"715",
   "project_name":"api test project1",
   "number":"9234324324",
   "company_name":"picky test",
   "country":"IN",
   "time_zone":"Asia/Kolkata",
   "date_format":DD-MM-YYYY,
   "service":1,
   "license_key":"9bb448151f161d292e212b05c835c4",
   "qr_code_base64":"aHR0cDovL2Rldi1waWNreS5jb20vdXBsb2Fkcy9pbWFnZXMvcXJjb2RlXzVlZTBiNDcyMGU2ZWYucG5n",
   "unbranded_keyword":"XY404793eFMMejtejZ",
   "branded_keyword":"",
   "api_tokens":[
      {
         "ip":"192.168.0.1",
         "token":"6999c1c7f31f50828ce24c6a509c41c57ec8b78c"
      },
      {
         "ip":"202.164.148.84",
         "token":"f368691b8436f164e527af9af942010708227296"
      }
   ],
    "global_webhook":"https://pickyassist.com/beta/test_webhook.php",
   "event_webhook":"https://pickyassist.com/beta/event_webhook.php",
   "smart_reply_webhook":"https://pickyassist.com/beta/test_webhook.php",
   "next_billing_date":"11-07-2020",
   "amount_debited":"10",
   "notes":""
}
```

{% endtab %}
{% endtabs %}

## Response Variables&#x20;

| Variable              | Type    | Description                                                                                                                                                                                                   |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| status                | numeric | <p>Status of the Request </p><p></p><p>100 = Sucess</p><p></p><p>Refer <a href="../references/status-and-error-codes">Error Codes</a> for complete Status Codes</p>                                           |
| message               | string  | Error or detailed response Message details                                                                                                                                                                    |
| project\_status       | string  | <p>Active</p><p>Expired</p><p>Delete</p>                                                                                                                                                                      |
| project\_id           | numeric | Unique Project ID , using this id need to communicate further for all quires                                                                                                                                  |
| project\_name         | string  | Name of the Project                                                                                                                                                                                           |
| number                | number  | Number of the Project                                                                                                                                                                                         |
| company\_name         | string  | Company Name                                                                                                                                                                                                  |
| country               | string  | This is a complete list of all country ISO codes as described in the ISO 3166 international standard. [Refer Here](https://help.pickyassist.com/api-documentation-v2/country-code-and-timezones#country-code) |
| time\_zone            | string  | Time zone in the specific format. [Refer Here](https://help.pickyassist.com/api-documentation-v2/country-code-and-timezones#time-zones)                                                                       |
| date\_format          | numeric | <p>YYYY-MM-DD <br>DD-MM-YYYY<br>MM-DD-YYYY</p>                                                                                                                                                                |
| service               | numeric | <p>1 = Phone Automation </p><p>2 = WhatsApp Official Account</p>                                                                                                                                              |
| license\_key          | string  | License key of the project (only for phone automation)                                                                                                                                                        |
| qr\_code\_base64      | string  | QR code of the license key for quick pairing the bridge app with the project                                                                                                                                  |
| unbranded\_keyword    | string  | Unbranded Shared Number for the project                                                                                                                                                                       |
| branded\_keyword      | string  | Branded keyword if active in the project                                                                                                                                                                      |
| api\_tokens           | array   | <p>This is an array where you will get following details </p><p>ip = IP Address</p><p>token = API Token</p>                                                                                                   |
| global\_webhook       | url     | Global Webhook if configured                                                                                                                                                                                  |
| event\_webhook        | url     | Event Webhook if configured                                                                                                                                                                                   |
| smart\_reply\_webhook | url     | Smart Reply Webhook if configured                                                                                                                                                                             |
| billing\_plan         | numeric | <p>1= Pay As You Go<br></p><p>2= Phone Automation Small <br>3= Phone Automation Medium <br>4 =Phone Automation Large <br>5= Phone Automation Unlimited <br>6 = Phone Automation Yearly Unlimited</p>          |
| next\_billing\_date   | date    | next billing date and time in ISO Standard format                                                                                                                                                             |
| amount\_debited       | numeric | Amount debited towards activation of the plan in USD, not applicable for pay as you go plan                                                                                                                   |
| notes                 | string  | notes                                                                                                                                                                                                         |

## Sample Request Body JSON

```javascript
{
   "token":"ac48c7069803d3fa3bc2c8457452e285f2fa0",
   "project_name":"api test project1",
   "number":"9234324324",
   "company_name":"picky test",
   "country":"IN",
   "time_zone":"Asia/Kolkata",
   "billing_plan":DD-MM-YYYY,
   "generate_api_token":true,
   "token_ip_address":
      [
         "192.168.0.1",
         "202.164.148.84"
      ],
   "global_webhook":"https://pickyassist.com/beta/test_webhook.php",
   "event_webhook":"https://pickyassist.com/beta/event_webhook.php",
   "smart_reply_webhook":"https://pickyassist.com/beta/test_webhook.php"
}
```

## Sample Response

```javascript
{
   "status":100,
   "message":"Success",
   "project_status":"Active",
   "project_id":"109",
   "project_name":"api test project1",
   "number":"9234324324",
   "company_name":"picky test",
   "country":"IN",
   "time_zone":"Asia/Kolkata",
   "date_format":DD-MM-YYYY,
   "service":1,
   "license_key":"9bb448151f161d292e212b05c835c4",
   "qr_code_base64":"aHR0cDovL2Rldi1waWNreS5jb20vdXBsb2Fkcy9pbWFnZXMvcXJjb2RlXzVlZTBiNDcyMGU2ZWYucG5n",
   "unbranded_keyword":"XY404793eFMMejtejZ",
   "branded_keyword":"",
   "api_tokens":[
      {
         "ip":"192.168.0.1",
         "token":"6999c1c7f31f50828ce24c6a509c41c57ec8b78c"
      },
      {
         "ip":"202.164.148.84",
         "token":"f368691b8436f164e527af9af942010708227296"
      }
   ],
    "global_webhook":"https://pickyassist.com/beta/test_webhook.php",
   "event_webhook":"https://pickyassist.com/beta/event_webhook.php",
   "smart_reply_webhook":"https://pickyassist.com/beta/test_webhook.php",
   "next_billing_date":"11-07-2020",
   "amount_debited":"10",
   "notes":""
}
```
