Creates a new customer in the integrations platform with the provided customer name and email.
https:/<sub_domain>/v2/integrations/customer
<subdomain> with the region of your account
You can use our official postman collection to try out the APIs.
The following are the POST parameters:
|
Parameter |
Type |
Required |
Description |
|
CustomerName |
String |
Yes |
ID of the entity - customer/app. |
|
|
String |
Yes |
Secret of the entity - customer/app. |
curl --location --request POST 'https://integrationscore.us3.qaexotel.com/v2/integrations/customer' \ --header 'Content-Type: application/json' \ --data-raw '{ "CustomerName": "ABE", "Email": "xyz@exotel.in" }'
{ "RequestId": "05a9d895-d101-48d7-9a5c-46eda5a161c8", "Status": "Success", "Code": 200, "Error": "", "Data": { "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0", "CustomerSecret": "5b8215f7-8595-42c0-9b63-404bcc474f94", "CustomerName": "John Doe", "Email": "johndoe@example.com", "CustomerSetting": null, "CreatedAt": "2023-03-23T09:36:25.967+05:30", "UpdatedAt": "2023-03-23T09:36:25.967+05:30", "DeletedAt": false } }
Status codes are as follows -
|
Status Code |
Description |
|
200 |
Customer created successfully. |
|
400 |
Bad request. Check the input parameters. |
|
401 |
Unauthorized. Check the entity id and secret. |
|
500 |
Internal server error. There was an issue creating the customer. |
Retrieves details of the customer associated with the provided authorization token.
https:/<sub_domain>/v2/integrations/customer
<subdomain> with the region of your account
You can use our official postman collection to try out the APIs.
The following are the parameter details :
|
Parameter |
Type |
Required |
Description |
|
Authorization |
String |
Yes |
Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token. entity=customer |
curl --location --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/customer' \ --header 'Authorization: {{AuthCode}}'
{ "RequestId": "01906552-dd91-4359-a184-739870991fa9", "Status": "Success", "Code": 200, "Error": "", "Data": { "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0", "CustomerSecret": "5b8215f7-8595-42c0-9b63-404bcc474f94", "CustomerName": "Temp Name", "Email": "temp.mail@company.in", "CustomerSetting": null, "CreatedAt": "2023-03-23T09:36:26+05:30", "UpdatedAt": "2023-03-23T09:36:26+05:30", "DeletedAt": false } }
Status code are as follows-
|
Status Code |
Description |
|
200 |
Request successful. Customer details retrieved. |
|
401 |
Unauthorized. Check the entity id and secret. |
|
500 |
Internal server error. There was an issue getting the customer. |
Deletes the specified customer entity.
https:/<sub_domain>/v2/integrations/customer
<subdomain> with the region of your account
You can use our official postman collection to try out the APIs.
The following are the parameter details :
|
Parameter |
Type |
Required |
Description |
|
Authorization |
String |
Yes |
Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token entity=customer |
curl --location --request DELETE 'https://integrationscore.us3.qaexotel.com/v2/integrations/customer' \ --header 'Authorization: {{AuthCode}}'
{ "RequestId": "f940efa6-349e-45e1-a298-de24f9a6e1a5", "Status": "Success", "Code": 200, "Error": "", "Data": "Deleted Successfully" }
Status code are as follows-
|
Status Code |
Description |
|
200 |
Customer deleted successfully. |
|
401 |
Unauthorized. Check the entity id and secret. |
|
500 |
Internal server error. There was an issue deleting the customer. |
