Initiate Consent Request

POST

https://api.inboxkit.com/v1/api/mailboxes/consent-request/initiate

Maintainer:Not configured

Create a new consent request for a mailbox. Can identify mailbox by either UID or username+domain combination.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Consent request initiated successfully

Body

🟠400Bad Request

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

cURL

Using mailbox UIDUsing username and domain

curl --location --request POST 'https://api.inboxkit.com/v1/api/mailboxes/consent-request/initiate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mailbox_uid": "550e8400-e29b-41d4-a716-446655440000",
    "consent_url": "https://accounts.google.com/consent?client_id=123456",
    "request_data": {
        "client_id": "123456"
    }
}'

Response Example

200 - Example 1

{
    "error": false,
    "message": "Consent request initiated successfully",
    "data": {
        "uid": "660e8400-e29b-41d4-a716-446655440000",
        "status": "queued",
        "mailbox_email": "[email protected]",
        "created_at": "2024-01-15T10:30:00.000Z"
    }
}

Modified at 2025-09-24 14:23:34

Get billing portal link

Get Consent Request Status