Email Authorize

POST

/addins/email/authorize

Overview
This API validates whether a user is authorized to index emails under a specific agent. By providing necessary credentials the API determines if the user has the necessary permissions to perform email indexing. Successful authorization returns details about the user, agent, and corpus associated with the indexing operation.

Functionality

Authorization Process

The user provides necessary credentials: auth-token, conv_id, agent_id, user_email, and allowed_domain.

The API verifies the authenticity of the auth-token and ensures the user’s email belongs to the specified allowed domain.

If authorized, the API grants permission to index emails under the specified agent.

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

User successfully authorized for email indexing.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/addins/email/authorize' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auth-token": "xxxxx",
    "conv_id": "AAQkADljYmNmOGQzLTQ0NjItNGJiNy1iY2I2LTQ1ZjllMDY3MTM4NAAQAPHLSaGDmNNJntiSCdWaWyg=",
    "agent_id": "13",
    "user_email": "user@example.com",
    "allowed_domain": "datasciencedojo.com"
}'

Response Example

200 - Example 1

{
    "authorize": true,
    "user": {
        "id": 147,
        "email": "user@example.com",
        "org_id": 1
    },
    "agent": {
        "id": 13,
        "name": "Marketing Assistant",
        "project": "General Project2",
        "team": "General",
        "owner": "System"
    },
    "corpus": {
        "id": 13,
        "indexing_mode": "exhaustive"
    }
}

Delete User Permission

Create Conversation Starter