Developer API

Connect to Proto AICX directly through an easy API.

API account access is available with the Total plan and above.

Find the full developer API schema here: https://v3-api.proto.cx/api/platform/docs


Authentication API

Each request to the developer API must include a bearer token in the Authorization header. This bearer token should be in the form of Authorization: Bearer {subcompany_takeover_secret}. This takeover secret can be found in the sub-company settings page.


Conversations API

URL
POST https://v3-api.proto.cx/api/platform/v1/conversations/{subcompany_id}/create-ticket
Body
{
  "subject": "string" (required),
  "customer_id": "string",
  "external_customer_id": "string",
  "gateway_profile_id": "string",
  "provided_unique_id": "string"
}
Returns
{
  "id": "The id of the created conversation."
}

Customers API

URL
GET https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/get-customer
Returns
A JSON dictionary of all customer information other than their associated custom field values. 
Parameters
Data Type
Required
Description

subcompany_id

string

subcompany_id from Proto

provided_unique_id

string

user's provided_unique_id

authorization

URL
PUT https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/create-customer/{provided_unique_id}
Body
{
  "external_customer_id": "string" (optional),
  "name": "string" (optional),
  "location": "string" (optional),
  "email": "string" (optional),
  "phone_number": "string" (optional),
  "avatar": "string" (optional)
}
Returns
A JSON dictionary of the created customer.

PUT https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/add-tags

PUT https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/add-custom-fields

Custom Fields API

GET https://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/list-custom-fields

POST https://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/create-custom-field

DELETE https://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/custom-field/{custom_field_id}/delete-custom-fields

Last updated