Kalo te dokumentacioni
API

Krijo një rol

Një emër dhe një listë lejesh. Ajo që kthehet është më e gjatë se ajo që dërguat.

POSTapi.openemail.uk/roles

Ekzekuton thirrjen reale kundrejt hapësirës suaj të punës, me çelësin tuaj.

POST /roles

Një emër dhe një listë lejesh. Ajo që kthehet është më e gjatë se ajo që dërguat.

Shembull

Kërkon roles:write. Kthen 201. Një rol i personalizuar është builtin: null, editable: true dhe deletable: true, dhe nuk e mban askush derisa dikush të zhvendoset mbi të.

curl
curl -X POST "$OE/roles" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "name": "Support",    "description": "Answers the shared inboxes and nothing else.",    "permissions": ["emails:send", "threads:write", "labels:write", "contacts:read"]  }'
Përgjigje
{  "object": "role",  "id": "role_2b81de079c1f0a4b7e05d386",  "name": "Support",  "description": "Answers the shared inboxes and nothing else.",  "permissions": [    "emails:send",    "emails:read",    "threads:read",    "threads:write",    "labels:read",    "labels:write",    "contacts:read"  ],  "builtin": null,  "editable": true,  "deletable": true,  "members": 0,  "apiKeys": 0,  "createdAt": "2026-08-30T10:41:02.000Z",  "updatedAt": "2026-08-30T10:41:02.000Z"}

Katër leje hynë dhe shtatë u kthyen. emails:send nënkupton emails:read, threads:write nënkupton threads:read, labels:write nënkupton labels:read. Një rol që mund të arkivojë një bisedë të cilën nuk mund ta hapë është një kuti zgjedhjeje që dikush e harroi, jo një politikë që e do dikush me të vërtetë, prandaj implikimi ruhet në vend që të refuzohet. Lista kthehet gjithashtu në rend kanonik, dhe kjo është ajo që i lejon një klienti të krahasojë dy role si JSON dhe të vendosë nëse Save është aktiv.

Një leje e panjohur REFUZOHET këtu, në vend që të hiqet pa zhurmë: templates:writ është invalid_parameter, një 422, që e emërton vargun. Shërbimi normalizon në heshtje sepse është edhe rruga e krijimit fillestar edhe rruga e MCP-së, ku dështimi i një roli të tërë për shkak të një fjale të panjohur do të ishte më keq. Kjo është e gabuar për një thirrje që dikush e bëri me qëllim. Një 200 që mbart një rol i cili nuk mund të redaktojë shabllonet nuk u ka thënë asgjë, dhe ata do të harxhojnë gjithë pasditen me të.

Një emër i dyfishtë në të njëjtën hapësirë pune është role_name_taken, një 409. Roli i 25-të i personalizuar është role_limit_reached, një 422. Ai ruan sa e madhe mund të bëhet një matricë përpara se të mos e auditojë më askush, dhe nuk është kufi plani.

Krijimi i një roli nuk ia jep atë askujt. Zhvendosja e njerëzve mbi të bëhet me PATCH /members/{userId}, ndërsa drejtimi i një çelësi drejt tij bëhet aty ku lëshohet çelësi.