Developer API
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-companies settings page.
Find the full developer API schema here: https://v3-api.proto.cx/api/platform/docs
Conversations API
URL
POST https://v3-api.proto.cx/api/platform/v1/conversations/{subcompany_id}/create-ticket
Body
One of customer_id, external_customer_id, gateway_profile_id, or provided_unique_id must be provided to identify the customer.
Returns
Customers API
URL
GET https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/get-customer
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
subcompany_id | string | required | subcompany_id from Proto |
provided_unique_id | string | required | user's provided_unique_id |
authorization | required | Proto%20AICX%20Documentation%20b455c971650a4d5eb656974bc77e8b04.md |
Returns
URL
PUT https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/create-customer/{provided_unique_id}
Body
Returns
PUT https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/add-tags
💡 Use create_if_not_exists to also create any tags that do not exist before applying it to the customer.
PUT https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/add-custom-fields
💡 One of id or name must be provided for each custom field element in the request body. The id of a custom field can be retrieved from listing or creating a new custom field.
Custom Fields
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
select_options must be provided if and only if type is select.
DELETE https://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/custom-field/{custom_field_id}/delete-custom-fields
Last updated