Favicon

You are here: Home > API Reference > Workspace > Organization > Send organization support email notification

Send organization support email notification

Required Permission: base.organization.management.sendSupportEmail

Initiates automated email notifications to designated support contacts for organization events such as subscription changes, security alerts, or administrative actions.

GET
/v1/organizations/:organizationId/support-email/:action
Copy to clipboard

Send organization support email notification

Required Permission: base.organization.management.sendSupportEmail

Initiates automated email notifications to designated support contacts for organization events such as subscription changes, security alerts, or administrative actions.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Organization unique identifier or URL-friendly slug used for workspace access, API routing, and resource isolation across dashboard.
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
action string
required
Action identifier specifying notification type to send such as subscription changes, security alerts, or administrative events requiring immediate stakeholder communication.
≤ 128 characters

Responses

200 Response application/json
status boolean optional
data object optional
status string optional
≤ 128 characters
{
    "status": true,
    "data": {
        "status": "string"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5010
message string optional
Billing platform error
{
    "status": false,
    "error": {
        "code": 5010,
        "message": "Billing platform error"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4001
message string optional
Unauthorized
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}