Customer API
Configure Customer Portal
Customer API
Configure Customer Portal
POST
/api/configure_customer_portal/
Explo-Authorization*
curl --request POST \
--url https://api.explo.co/api/configure_customer_portal/ \
--header 'Explo-Authorization: <explo-authorization>'This endpoint lets you programmatically permission customer emails to the Customer Portal.
Body
dashboard_embed_id
string
This is the embed_id of the dashboard that will be used in the portal.
provided_id
string
This is the ID you use to identify this customer in your database that you provided to explo.
emails
object
This is a list of strings, where each string is an email allowed to authenticate in the portal to see the respective dashboard.
Response
success
number
Indicates whether the call was successful. 1 if successful, 0 if not.
curl --location --request POST 'https://api.explo.co/api/configure_customer_portal/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"dashboard_embed_id": "Ab123CdefG",
"provided_id": "test_id_1",
"emails": ["apple@explo.co", "orange@explo.co"]
}'
{
"success": 1
}
curl --location --request POST 'https://api.explo.co/api/configure_customer_portal/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"dashboard_embed_id": "Ab123CdefG",
"provided_id": "test_id_1",
"emails": ["apple@explo.co", "orange@explo.co"]
}'
{
"success": 1
}