Create Project

Create New Project

API to Create A New Project under your account.

post
Create New Project

https://pickyassist.com/app/api/v2/pm/create-project
This API allows you to Create Project
Request
Response
Request
Body Parameters
token
required
string
Your Master API Token for authentication
project_name
required
string
Project Name for you reference maximum 20 characters allowed
number
required
number
A WhatsApp or any number can given for your internal reference
company_name
required
string
Company Name for your reference
country
required
string
Country of the customer Refer Here
time_zone
required
string
Time Zone of the customer Refer Here
date_format
required
number
Select the Date Format YYYY-MM-DD DD-MM-YYYY MM-DD-YYYY
service
required
number
Specify the service which need to enabled o the project 1=Phone Automation
billing_plan
required
number
Specify the billing plan need to be applied to the project 1= Pay As You Go 2= Phone Automation Small 3= Phone Automation Medium 4 =Phone Automation Large 5= Phone Automation Unlimited 6 = Phone Automation Yearly Unlimited
generate_api_token
optional
boolean
Whether API token need to generated or not for the project true false
token_ip_address
optional
array
If you need to bind the API token with IP address then please pass the IP address in an array [ "192.168.0.1", "202.164.148.84" ]
global_webhook
optional
string
You can pass the global webhook which need to be configured against the project
event_webhook
optional
string
You can set the event webhook which need to be configured against the project
smart_reply_webhook
optional
string
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
notes
optional
string
Specify if any notes to identify the customers for your internal reference , maximum 250 characters allowed
Response
200: OK
{
"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":""
}

Response Variables

Variable

Type

Description

status

numeric

Status of the Request

100 = Sucess

Refer Error Codes for complete Status Codes

message

string

Error or detailed response Message details

project_status

string

Active

Expired

Delete

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

time_zone

string

Time zone in the specific format. Refer Here

date_format

numeric

YYYY-MM-DD DD-MM-YYYY MM-DD-YYYY

service

numeric

1 = Phone Automation

2 = WhatsApp Official Account

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

This is an array where you will get following details

ip = IP Address

token = API Token

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

1= Pay As You Go

2= Phone Automation Small 3= Phone Automation Medium 4 =Phone Automation Large 5= Phone Automation Unlimited 6 = Phone Automation Yearly Unlimited

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

{
"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

{
"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":""
}