# Introduction

{% embed url="<https://youtu.be/_k63Ly7ms3w?si=hk5wYgno2IkiCq10>" %}

## List of Available APIs

List of Available APIs as below&#x20;

<table data-header-hidden><thead><tr><th width="251.33333333333331">API Type</th><th>URL</th><th></th><th>Use</th></tr></thead><tbody><tr><td><strong>API Type</strong></td><td><strong>URL</strong></td><td><strong>URL V4</strong></td><td><strong>Use</strong></td></tr><tr><td>For Sending Messages</td><td><a href="https://pickyassist.com/app/api/v2/push">https://pickyassist.com/app/api/v2/push</a> </td><td><a href="https://app.pickyassist.com/api/v2/push">https://app.pickyassist.com/api/v2/push </a></td><td>For Sending Text, Image, Video, Audio &#x26; Files</td></tr><tr><td>WhatsApp Official Template</td><td><a href="https://pickyassist.com/app/api/v2/template-request">https://pickyassist.com/app/api/v2/template-request</a></td><td><a href="https://app.pickyassist.com/api/v2/template-request">https://app.pickyassist.com/api/v2/template-request</a></td><td>For Requesting WhatsApp Official Template</td></tr><tr><td>WhatsApp Official Template Status</td><td><a href="https://pickyassist.com/app/api/v2
/template-status">https://pickyassist.com/app/api/v2<br>/template-status</a></td><td><a href="https://app.pickyassist.com/api/v2/template-status">https://app.pickyassist.com/api/v2<br>/template-status</a></td><td>Fetching template status of WhatsApp Official </td></tr><tr><td>WhatsApp Official - Profile Update</td><td><a href="https://pickyassist.com/app/api/v2
/update-profile">https://pickyassist.com/app/api/v2<br>/update-profile</a></td><td><a href="https://pickyassist.com/app/api/v2
/update-profile">https://app.pickyassist.com/api/v2<br>/update-profile</a></td><td>To Update WhatsApp Official account Profile details </td></tr><tr><td>WhatsApp Official - 2FA</td><td><a href="https://pickyassist.com/app/api/v2/two-step-verification">https://pickyassist.com/app/api/v2/two-step-verification</a></td><td><a href="https://app.pickyassist.com/api/v2/two-step-verification">https://app.pickyassist.com/api/v2/two-step-verification</a></td><td>To enable or disable 2FA on WhatsApp Official Number</td></tr><tr><td>WhatsApp Web Automation - Status Update</td><td><a href="https://pickyassist.com/app/api/v2/wa_status">https://pickyassist.com/app/api/v2/wa_status</a></td><td>Not Supported</td><td>To add status to your WhatsApp number (works only with WhatsApp Web Automation)</td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="
https://pickyassist.com/app/api/v2
/create-whatsapp-group"><br>https://pickyassist.com/app/api/v2/create-whatsapp-group</a></td><td>Not Supported</td><td>For Creating WhatsApp Groups</td></tr><tr><td>WhatsApp Web Automation - Fetching Contact &#x26; Groups</td><td><a href="https://pickyassist.com/app/api/v2/fetch-contacts">https://pickyassist.com/app/api/v2/fetch-contacts</a></td><td>Not Supported</td><td>To fetch all contacts and group in WhatsApp numbers, only supported in WhatsApp Web Automation </td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/set-group-permission">https://pickyassist.com/app/api/v2/set-group-permission</a></td><td>Not Supported</td><td>For Setting Group Permissions </td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/add-group-admin">https://pickyassist.com/app/api/v2/add-group-admin</a></td><td>Not Supported</td><td>For Adding Admin into WhatsApp Groups</td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/add-group-members">https://pickyassist.com/app/api/v2/add-group-members</a></td><td>Not Supported</td><td>For Adding Members into WhatsApp Groups</td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/group-details">https://pickyassist.com/app/api/v2/group-details</a></td><td>Not Supported</td><td>For fetching WhatsApp Group Details </td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/update-group-info">https://pickyassist.com/app/api/v2/update-group-info</a></td><td>Not Supported</td><td>For updating WhatsApp Group Informations</td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/remove-group-members">https://pickyassist.com/app/api/v2/remove-group-members</a></td><td>Not Supported</td><td>For removing  members from WhatsApp Group</td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/generate-invite-link">https://pickyassist.com/app/api/v2/generate-invite-link</a></td><td>Not Supported</td><td>To Generate New Invite Link</td></tr><tr><td>WhatsApp Web Automation - Group</td><td><a href="https://pickyassist.com/app/api/v2/delete-group-action">https://pickyassist.com/app/api/v2/delete-group-action</a></td><td>Not Supported</td><td>To Delete groups Invitation URL, Leave Group </td></tr><tr><td>Fetch Account Balance</td><td><a href="https://pickyassist.com/app/api/v2/check-balance">https://pickyassist.com/app/api/v2/check-balance</a></td><td></td><td>This will fetch the available balance in the Picky Assist Account</td></tr><tr><td>Device Status API</td><td><a href="http://pickyassist.com/app/api/v2/device-status">http://pickyassist.com/app/api/v2/device-status</a> </td><td>Not Supported</td><td>To fetch connection status of WhatsApp Web Automation with our Server, which also returns number of queue in the server </td></tr></tbody></table>

## WhatsApp Server for WhatsApp Web Automation Service (Deprecated)

Similar to WhatsApp Official Solution, we also create a dedicated WhatsApp Server for each number, and when your scan the QR code to pair your existing number we replicate your WhatsApp Web in our server, and over the top, our automation app just automates the sending and receive messages as per your command through API's

## WhatsApp Cloud API&#x20;

Whatsapp Cloud API is a fully managed service directly offered by WhatsApp and before you start using API through Picky Assist you must have your WhatsApp number linked with your Facebook Business Manager and need to follow the [step-by-step process](/setting-up-guide/connecting-channels/connecting-whatsapp-cloud-api.md) to connect it with Picky Assist as a channel, once your connected then you will able to use the API's&#x20;

## API Calling Method

| API Call Method        | POST Only                                                               |
| ---------------------- | ----------------------------------------------------------------------- |
| Base URL For Version 2 | <https://pickyassist.com/app/api/v2>                                    |
| Base URL for Version 4 | [https://app.pickyassist.com/api/v2](ttps://app.pickyassist.com/api/v2) |
| API Type               | Standard JSON Type                                                      |

{% hint style="info" %}
Picky Assist API is compatible with all programming language platforms and we make use of JSON. API which allows you to send messages and Webhook enables you to receive messages.
{% endhint %}

## **Prerequisite**&#x20;

1. For WhatsApp Official Solution you must take approval through us.<br>
2. For WhatsApp Cloud API you must link your credit card directly on Meta<br>
3. API Token (Visit <https://pickyassist.com/app> and generate tokens from `Settings -> Developers ->` [`API`](https://pickyassist.com/app/settings/developers/api)\ <br>
4. API Token in V4 (Visit [ ](https://app.pickyassist.com/settings/developers/api)<https://app.pickyassist.com/settings/developers/api> and generate tokens from `Settings -> Developers ->` [`API`](https://app.pickyassist.com/settings/developers/api)

## API Authentication Method

All API requests are authenticated through API Token, so you need to pass your API Token through  **`“token”: “YOUR_API_TOKEN”,`** variable, this should be passed along with all API requests body in JSON format.

{% hint style="warning" %}
We don't use header authentication, so it's not required to pass a header, all data should be passed in the body.
{% endhint %}

## API Rate Limit&#x20;

All the API requests to any endpoints are rate limited to **90 requests per minute** from one project, if we are getting more than 90 requests per minute then you will receive an error "**429"** and those messages or requests will be dropped in our firewall level and won't be showing in your Picky Assist Platform&#x20;

{% hint style="info" %}
If you want to send high-volume personalized messaging then we highly recommend make use of our Dynamic Push API. [Read More ](/api-documentation-v2/push-api/sending-dynamic-messages-push.md)
{% endhint %}

The Admin will also receive an email notification with the Subject **"Urgent Rate Limit Reached - Picky Assist"** whenever we throttle your request because of the rate limit. <mark style="color:red;">Kindly note that in order to avoid cluttering your email inbox we will send emails once every 30 minutes only even if we drop your message continuously.</mark>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.pickyassist.com/api-documentation-v2/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.