Create Project
Create New Project
API to Create A New Project under your account.
Create New Project
POST
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 | Select the Date Format YYYY-MM-DD DD-MM-YYYY MM-DD-YYYY |
service | number | Specify the service which need to enabled o the project 1=Phone Automation |
billing_plan | 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 | boolean | Whether API token need to generated or not for the project true false |
token_ip_address | 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 | string | You can pass the global webhook which need to be configured against the project |
event_webhook | string | You can set the event webhook which need to be configured against the project |
smart_reply_webhook | 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 | string | Specify if any notes to identify the customers for your internal reference , maximum 250 characters allowed |
Response Variables
Variable | Type | Description |
status | numeric | |
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
Sample Response
Last updated