API authentication required
Need API Access?

Please use ‘Create Account’ to quickly register and start exploring our APIs

POST

https://leadassist.exotel.in/v1/tenants/<tenant_id>/greenpin

An allocation request generates the pin and maps it to a set of users over a requested Virtual Number. The users in the API are referred to as a-party_numbers and b-party_numbers

Parameter
Name
Value
Description
* Body
Jsonbody

Replace <your_sid> with your tenant ID.

Response Content Type

DELETE

https://leadassist.exotel.in/v1/tenants/<tenant_id>/greenpin/<greenpin_id>

A deallocation request deletes the pin-mapping between users and the assigned Virtual Number. It is essential to deallocate an existing allocation in order to free-up a pin which is no longer in use. So that the same pin can be reused for future transactions.

Parameter
Name
Value
Description
* greenpin_id
path

From the response of ‘Create a Pin Allocation‘ (POST) API

Response Content Type

GET

https://leadassist.exotel.in/v1/tenants/<tenant_id>/greenpin/<greenpin_id>

The details of an allocation can be retrieved using this method. The greenpin_id needs to be provided in the API request.

Parameter
Name
Value
Description
* greenpin_id
path

From the response of ‘Create a Pin Allocation‘ (POST) API

Response Content Type

PUT

https://leadassist.exotel.in/v1/tenants/<your_sid>/greenpin/<greenpin_id>

Update an active GreenPin allocation

Parameter
Name
Value
Description
* greenpin_id
path

The greenpin_id will be used to uniquely identify the allocation that needs to be updated

* Body
Jsonbody

Form a json body with the parameters mentioned in the API Docs

Response Content Type

PUT

https://leadassist.exotel.in/v1/tenants/<your_sid>/greenpin

Update multiple active GreenPin allocations in one go!

Parameter
Name
Value
Description
* Body
Jsonbody

Form a json body with the parameters mentioned in the API Docs

Response Content Type