Make an account an admin of a kind

POST

/admin/admins

Needs grant-admin. A preset type resolves to its constants; other
takes scopes and keeps them as a document in object storage, and is
refused while that store is not live. Granting an account that already
has a row rewrites it.

Request

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

The admin — and their personal inbox address, <f><lastname>@ at
the sending domain, made (or switched back on) with the grant and
routed to them. Its routing says whether the Cloudflare rule that
delivers its mail was made; if not, routing.error says why, and
POST /admin/email/addresses/{id}/route retries.

Bodyapplication/json

🟠400

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.prod-orm.io/admin/admins' \
--header 'Content-Type: application/json' \
--data '{
    "userId": 0,
    "type": "general",
    "scopes": [
        "string"
    ]
}'

Response Example

201 - Example 1

{
    "admin": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "userId": 0,
        "type": "general",
        "role": "string",
        "scopes": [
            "string"
        ],
        "canGrantAdmin": true,
        "user": {
            "id": 0,
            "email": "user@example.com",
            "username": "string",
            "fname": "string",
            "lname": "string",
            "fullname": "string",
            "age": 0,
            "role": "admin",
            "birthday": "2019-08-24",
            "guardian": {
                "email": "user@example.com",
                "username": "string",
                "relationship": "parent",
                "approved": true
            },
            "emancipatedAt": "2019-08-24T14:15:22.123Z",
            "restrictions": {
                "provisioning": true,
                "signin": true
            },
            "verified": true
        },
        "createdAt": "2019-08-24T14:15:22.123Z"
    },
    "personalAddress": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "address": "user@example.com",
        "label": "string",
        "routesTo": [
            0
        ],
        "active": true,
        "ownerId": 0,
        "routing": {
            "managed": true,
            "ruleTag": "string",
            "error": "string"
        },
        "createdBy": 0,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "counts": {
            "unread": 0,
            "read": 0,
            "archived": 0,
            "spam": 0
        }
    }
}

Modified at 2026-10-05 04:09:21

Every admin, and the scopes each resolves to

Change an admin's kind, or a custom admin's scopes