REST API
Tugann REST API v1 ChatReact rochtain cláraithe ar oibríochtaí tacaíochta sa dashboard: chatbots, bunachar eolais agus creathadh, praghsanna struchtúrtha, Ceisteanna Coitianta (FAQs), athbhreithniú comhrá agus an Gníomhaire Feabhsaithe, luaidhe, foirmeacha teagmhála, comhrá beo, an chuideachta agus an fhoireann, an Cúnamh Ríomhphoist, anailís agus fógraí. Fanann gníomhartha ceangailte leis an mbrabhsálaí (íocaíochtaí, údarú bosca poist, passkeys, scrios cuntas agus bainistíocht eochair API) sa dashboard.
Más fearr libh labhairt le cúntóir AI, tá na cumais chéanna ar fáil mar uirlisí MCP — féach MCP Server Integration. Tá an API Explorer idirghníomhach le scéimeanna iarratais agus freagraí ar /api-reference, áit ar féidir libh an sonrasc OpenAPI 3.0 a íoslódáil freisin.
Údarú
- Téigh go Painéal → Cuideachta → cluaisín API agus cliceáil Cruthaigh Eochair API
- Roghnaigh ainm agus na scóip cead a theastaíonn don eochair (féach thíos)
- Cóipeáil an eochair — tosóidh sí le
cr_agus ní thaispeántar í ach uair amháin
Seol an eochair le gach iarratas:
curl https://www.chatreact.ai/api/v1/chatbots \
-H "Authorization: Bearer cr_your_api_key"
Glactar le ceannlíne X-API-Key: cr_your_api_key freisin. Tá eochracha API bainteach le cuideachta amháin agus feidhmíonn siad leis na ceadanna de úinéir na cuideachta; cuirtear teorainneacha plean agus geataí gné ar fáil díreach mar atá sa dashboard.
Tá rochtain API ar fáil ar phleananna íoctha — féach an Pricing page. Is féidir eochracha a chealú ag am ar bith ón dashboard.
Scóipanna
Gabhann gach eochair ceann nó níos mó scóipanna. Fillfidh deighreann 403 nuair nach bhfuil an scóip riachtanach ag an eochair.
| Scope | Grants |
|---|---|
chatbots:read / chatbots:write | Cumraíocht chatbot: pearsantacht, teangacha, widget, iompar, srianta, treoracha croí, cód iframe, céim fhoghlama, samhlacha chatbot, socruithe widget FAQ |
knowledge:read / knowledge:write | Bunachar eolais: doiciméid, creathadh suíomh Gréasáin, leathanaigh creathaithe |
faqs:read / faqs:write | FAQs, catagóirí FAQ, moltaí, aistriúcháin |
chats:read / chats:write | Stair comhrá, rátálacha comhrá, catagóirí muiníne, comhrá beo (teastaíonn chats:write le gníomhartha gníomhaire) |
leads:read / leads:write | Luaidhe, catagóirí luaidhe, socruithe ghabhála luaidhe, easpórtáil |
forms:read / forms:write | Foirmeacha teagmhála agus isteachlíneacha |
analytics:read | Staitisticí, sraitheanna gníomhaíochta, funnels, stádas muiníne |
company:read / company:write | Próifíl agus socruithe cuideachta, baill foirne, cuireadh |
email:read / email:write | Naisc Cúnamh Ríomhphoist, catagóirí, teagmhálacha, gníomhaíocht |
prices:read | Léamh iontrálacha praghsanna struchtúrtha, athruithe, incháilitheacht agus moltaí |
prices:write | Cruthú agus eagarthóireacht dréachtphacáistí praghsanna, allmhairiú CSV agus moladh a chur i bhfeidhm mar dréacht; teastaíonn úinéir na cuideachta |
prices:approve | Ceadaigh leaganacha chruinne nó cartlann iontrálacha; teastaíonn úinéir na cuideachta |
blog:read / blog:write | Ábhar blag an ardáin (inmheánach do ChatReact) |
| any valid key | /v1/me, úsáid an chuntais, do fógraí |
Coinbhinsiúin
- Base URL:
https://www.chatreact.ai/api/v1, JSON isteach agus amach (Content-Type: application/json). - Freagraí:
{ "success": true, "data": … }; cuireann liostaí"pagination": { "total", "page", "pageSize", "totalPages" }leis. ÚsáidpageaguspageSize(uasmhéid 100) ar dheighreanna liosta; cuireann roinnt deighreann scagadh cursor ar fáil (cursor/nextCursor). - Earrí:
{ "success": false, "error": "message", "code": "BAD_REQUEST" }ledetailsroghnach do earráidí bailíochtaithe. Cód stádais:400ionchur neamhbhailí,401eochair ar iarraidh nó neamhbhailí,403scóip ar iarraidh, gné plean nach bhfuil san áireamh nó ról neamhleordhóthanach,404acmhainn gan bhunachar (atáirgeadh freisin do acmhainní ó chuideachtaí eile),409coimhlint,429teorainn ráta sáraithe. - Nuashonruithe páirteacha: athraíonn deighreanna
PATCHach na réimsí a sheolann sibh; diúltaítear réimsí anaithnid. - Teorainn ráta: 30 iarratas in aghaidh an nóiméid in aghaidh an IP.
- Oibríochtaí fada (creathanna, gineadh AI, aistriúcháin) filltear go tapa le post nó torthaí ar féidir libh pioláil orthu; úsáideann siad na ticéid agus buiséid creathadh de do phlean.
Deighreanna
Prices & services
Sábháil, eagarthóireacht, allmhairiú agus cur i bhfeidhm moltaí cruthaíonn dréachtaí gan cead. Déanann oibríochtaí ceadaithe agus cartlann athbhreithniú ar leaganacha chruinne; fillfidh leagan seanmhódh coimhlint. Ní fhaigheann eochracha atá ann cheana ceadanna praghsanna go huathoibríoch. Ní féidir ach le húinéir na cuideachta cead scríbhneoireachta nó ceadaithe a thabhairt. Maidir le sreabhadh oibre an chustaiméara, féach Prices & services.
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/prices | Liostaigh iontrálacha praghsanna agus incháilitheacht | prices:read |
POST | /api/v1/chatbots/{id}/prices | Cruthaigh dréacht | prices:write |
GET | /api/v1/chatbots/{id}/prices/{itemId} | Léigh sonraí agus stair leathanleathanuithe | prices:read |
PATCH | /api/v1/chatbots/{id}/prices/{itemId} | Cruthaigh dréacht eagarthóireachta ó leagan atá ag súil leis | prices:write |
GET | /api/v1/chatbots/{id}/prices/{itemId}/state | Léigh staid iomlán an mhíre | prices:read |
POST | /api/v1/chatbots/{id}/prices/{itemId}/approve | Ceadaigh leagan cruinn | prices:approve |
POST | /api/v1/chatbots/{id}/prices/{itemId}/archive | Cartlannaigh leagan cruinn | prices:approve |
POST | /api/v1/chatbots/{id}/prices/approve-many | Ceadaigh roghnú leagain sonraithe go adamhach | prices:approve |
POST | /api/v1/chatbots/{id}/prices/import | Allmhaigh dréachtaí CSV le ID allmhairiú seasta | prices:write |
GET | /api/v1/chatbots/{id}/prices/suggestions | Liostaigh moltaí praghsanna | prices:read |
POST | /api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/apply | Cuir moladh roghnaithe i bhfeidhm mar dréacht | prices:write |
Chatbots
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots | Liostaigh chatbots | chatbots:read |
POST | /api/v1/chatbots | Cruthaigh chatbot | chatbots:write |
GET | /api/v1/chatbots/{id} | Faigh chatbot | chatbots:read |
PATCH | /api/v1/chatbots/{id} | Nuashonraigh chatbot | chatbots:write |
DELETE | /api/v1/chatbots/{id} | Scrios chatbot | chatbots:write |
GET | /api/v1/chatbots/{id}/personality | Faigh pearsantacht chatbot | chatbots:read |
PATCH | /api/v1/chatbots/{id}/personality | Nuashonraigh pearsantacht chatbot | chatbots:write |
GET | /api/v1/chatbots/{id}/widget | Faigh socruithe widget | chatbots:read |
PATCH | /api/v1/chatbots/{id}/widget | Nuashonraigh socruithe widget | chatbots:write |
GET | /api/v1/chatbots/{id}/widget/translations | Faigh aistriúcháin widget | chatbots:read |
PUT | /api/v1/chatbots/{id}/widget/translations | Athsholáthar aistriúcháin widget | chatbots:write |
GET | /api/v1/chatbots/{id}/embed | Faigh cód iframe | chatbots:read |
POST | /api/v1/chatbots/{id}/embed/confirm | Deimhnigh iframe | chatbots:write |
GET | /api/v1/chatbots/{id}/learning-phase | Faigh socruithe céim fhoghlama | chatbots:read |
PATCH | /api/v1/chatbots/{id}/learning-phase | Nuashonraigh socruithe céim fhoghlama | chatbots:write |
POST | /api/v1/chatbots/{id}/learning-phase/end | Críochnaigh céim fhoghlama | chatbots:write |
GET | /api/v1/chatbots/{id}/instructions | Liostaigh treoracha croí | chatbots:read |
POST | /api/v1/chatbots/{id}/instructions | Cuir treoir croí leis | chatbots:write |
PUT | /api/v1/chatbots/{id}/instructions/reorder | Athordú treoracha croí | chatbots:write |
POST | /api/v1/chatbots/{id}/instructions/improve | Feabhsaigh treoracha le AI | chatbots:write |
GET | /api/v1/instructions/{id} | Faigh treoir croí | chatbots:read |
PATCH | /api/v1/instructions/{id} | Nuashonraigh treoir croí | chatbots:write |
DELETE | /api/v1/instructions/{id} | Scrios treoir croí | chatbots:write |
GET | /api/v1/chatbot-templates | Liostaigh samhlacha chatbot | chatbots:read |
Knowledge base
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/knowledge | Forbhreathnú bunachar eolais | knowledge:read |
GET | /api/v1/chatbots/{id}/documents | Liostaigh doiciméid do chatbot | knowledge:read |
POST | /api/v1/chatbots/{id}/documents | Uaslódáil doiciméid | knowledge:write |
POST | /api/v1/chatbots/{id}/documents/presign | Réamhshínithe uaslódáil doiciméid | knowledge:write |
GET | /api/v1/documents/{id} | Faigh doiciméad | knowledge:read |
DELETE | /api/v1/documents/{id} | Scrios doiciméad | knowledge:write |
POST | /api/v1/documents/{id}/confirm | Deimhnigh uaslódáil réamhshínithe | knowledge:write |
GET | /api/v1/chatbots/{id}/crawl/limits | Teorainneacha creathadh | knowledge:read |
POST | /api/v1/chatbots/{id}/crawl/preview | Réamhamharc scanála suíomh Gréasáin | knowledge:write |
GET | /api/v1/chatbots/{id}/crawl | Liostaigh poist chreatha | knowledge:read |
POST | /api/v1/chatbots/{id}/crawl | Tosaigh creathadh | knowledge:write |
GET | /api/v1/crawl-jobs/{jobId} | Faigh post creathadh | knowledge:read |
POST | /api/v1/crawl-jobs/{jobId}/cancel | Cealaigh post creathadh | knowledge:write |
GET | /api/v1/chatbots/{id}/pages | Liostaigh leathanaigh chreatha | knowledge:read |
POST | /api/v1/chatbots/{id}/pages | Cuir URL singil leis | knowledge:write |
POST | /api/v1/chatbots/{id}/pages/bulk-delete | Scrios le mórchúrsa leathanaigh chreatha | knowledge:write |
GET | /api/v1/pages/{id} | Faigh leathanach creatha | knowledge:read |
DELETE | /api/v1/pages/{id} | Scrios leathanach creatha | knowledge:write |
POST | /api/v1/pages/{id}/recrawl | Athchreathaigh leathanach | knowledge:write |
GET | /api/v1/chatbots/{id}/websites | Liostaigh suíomhanna creaththa | knowledge:read |
DELETE | /api/v1/chatbots/{id}/websites/{domain} | Scrios suíomh | knowledge:write |
POST | /api/v1/chatbots/{id}/websites/{domain}/recrawl | Athchreathaigh suíomh | knowledge:write |
POST | /api/v1/chatbots/{id}/websites/{domain}/recrawl/cancel | Cealaigh athchreathadh suíomh | knowledge:write |
FAQs
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/faqs | Liostaigh FAQs do chatbot | faqs:read |
POST | /api/v1/chatbots/{id}/faqs | Cruthaigh FAQ | faqs:write |
POST | /api/v1/chatbots/{id}/faqs/bulk | Allmhaigh FAQs go mór | faqs:write |
POST | /api/v1/chatbots/{id}/faqs/reorder | Athordú FAQs | faqs:write |
GET | /api/v1/chatbots/{id}/faqs/embed | Faigh cód iframe widget FAQ | chatbots:read |
POST | /api/v1/chatbots/{id}/faqs/purge-cache | Glan cacha FAQ iargúlta | faqs:write |
GET | /api/v1/faqs/{id} | Faigh FAQ | faqs:read |
PATCH | /api/v1/faqs/{id} | Nuashonraigh FAQ | faqs:write |
DELETE | /api/v1/faqs/{id} | Scrios FAQ | faqs:write |
PUT | /api/v1/faqs/{id}/translations | Nuashonraigh aistriúcháin FAQ | faqs:write |
POST | /api/v1/faqs/{id}/translate | Aistriúchán AI do FAQ | faqs:write |
GET | /api/v1/chatbots/{id}/faq-suggestions | Liostaigh moltaí FAQ | faqs:read |
POST | /api/v1/chatbots/{id}/faq-suggestions/generate | Gineamh moltaí FAQ ón mbunachar eolais | faqs:write |
GET | /api/v1/faq-suggestions/{id} | Faigh mholadh FAQ | faqs:read |
POST | /api/v1/faq-suggestions/{id}/approve | Ceadaigh mholadh FAQ | faqs:write |
POST | /api/v1/faq-suggestions/{id}/reject | Diúltaigh mholadh FAQ | faqs:write |
GET | /api/v1/chatbots/{id}/faq-categories | Liostaigh catagóirí FAQ | faqs:read |
POST | /api/v1/chatbots/{id}/faq-categories | Cruthaigh catagóir FAQ | faqs:write |
POST | /api/v1/chatbots/{id}/faq-categories/reorder | Athordú catagóirí FAQ | faqs:write |
GET | /api/v1/faq-categories/{id} | Faigh catagóir FAQ | faqs:read |
PATCH | /api/v1/faq-categories/{id} | Nuashonraigh catagóir FAQ | faqs:write |
DELETE | /api/v1/faq-categories/{id} | Scrios catagóir FAQ | faqs:write |
PUT | /api/v1/faq-categories/{id}/translations | Nuashonraigh aistriúcháin catagóir FAQ | faqs:write |
GET | /api/v1/chatbots/{id}/faq-widget-settings | Faigh socruithe widget FAQ | chatbots:read |
PATCH | /api/v1/chatbots/{id}/faq-widget-settings | Nuashonraigh socruithe widget FAQ | chatbots:write |
Chats, feedback & Improvement Agent
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chats | Liostaigh seisiúin comhrá | chats:read |
GET | /api/v1/chats/{sessionId} | Faigh seisiún comhrá | chats:read |
PATCH | /api/v1/chats/{sessionId} | Socraigh catagóir muiníne comhrá | chats:write |
POST | /api/v1/chats/{sessionId}/feedback | Rátáil comhrá (Maith / Tá gá le feabhas) | chats:write |
POST | /api/v1/chats/{sessionId}/feedback/dismiss | Diúltaigh athbhreithniú comhrá | chats:write |
POST | /api/v1/chats/{sessionId}/improve | Tosaigh an Gníomhaire Feabhsaithe do chomhrá | chatbots:write |
GET | /api/v1/chatbots/{id}/feedback | Liostaigh athbhreithnithe comhrá chatbot | chats:read |
GET | /api/v1/chatbots/{id}/feedback/stats | Cártaí staitisticí athbhreithnithe comhrá | chats:read |
GET | /api/v1/feedback/{id} | Faigh athbhreithniú comhrá | chats:read |
PATCH | /api/v1/feedback/{id} | Osclaigh déine athbhreithnithe | chats:write |
POST | /api/v1/feedback/{id}/improvement-session | Tosaigh an Gníomhaire Feabhsaithe don athbhreithniú | chatbots:write |
GET | /api/v1/chatbots/{id}/confidence | Faigh stádas muiníne | analytics:read |
GET | /api/v1/chatbots/{id}/confidence-categories | Liostaigh catagóirí muiníne | chats:read |
POST | /api/v1/chatbots/{id}/confidence-categories | Cruthaigh catagóir muiníne | chatbots:write |
PATCH | /api/v1/confidence-categories/{id} | Nuashonraigh catagóir muiníne | chatbots:write |
DELETE | /api/v1/confidence-categories/{id} | Scrios catagóir muiníne | chatbots:write |
POST | /api/v1/confidence-categories/{id}/merge | Aontú catagóirí muiníne | chatbots:write |
GET | /api/v1/chatbots/{id}/improvement-sessions | Liostaigh seisiúin feabhsaithe | chatbots:read |
GET | /api/v1/improvement-sessions/{id} | Faigh seisiún feabhsaithe | chatbots:read |
POST | /api/v1/improvement-sessions/{id}/messages | Seol teachtaireacht chuig an Gníomhaire Feabhsaithe | chatbots:write |
POST | /api/v1/improvement-sessions/{id}/complete | Críochnaigh seisiún feabhsaithe | chatbots:write |
POST | /api/v1/improvement-sessions/{id}/reset | Athshocraigh seisiún feabhsaithe | chatbots:write |
POST | /api/v1/improvement-proposals/{id}/apply | Cuir moladh feabhsaithe i bhfeidhm | chatbots:write |
POST | /api/v1/improvement-proposals/{id}/reject | Diúltaigh moladh feabhsaithe | chatbots:write |
POST | /api/v1/improvement-proposals/{id}/simulations | Insamhail moladh feabhsaithe | chatbots:write |
POST | /api/v1/improvement-simulations/{id}/assessment | Rátáil toradh insamhalta | chatbots:write |
Leads
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/leads | Liostaigh luaidhe | leads:read |
POST | /api/v1/leads | Cruthaigh luaidhe | leads:write |
GET | /api/v1/leads/{id} | Faigh luaidhe | leads:read |
PATCH | /api/v1/leads/{id} | Nuashonraigh luaidhe | leads:write |
DELETE | /api/v1/leads/{id} | Scrios luaidhe | leads:write |
POST | /api/v1/leads/{id}/assign | Ceap luaidhe | leads:write |
POST | /api/v1/leads/bulk-status | Nuashonrú mórchúrsail stádas luaidhe | leads:write |
GET | /api/v1/leads/stats | Staitisticí luaidhe | leads:read |
GET | /api/v1/leads/export | Easpórtáil luaidhe | leads:read |
GET | /api/v1/chatbots/{id}/lead-config | Faigh cumraíocht ghabhála luaidhe | leads:read |
PUT | /api/v1/chatbots/{id}/lead-config | Nuashonraigh cumraíocht ghabhála luaidhe | leads:write |
GET | /api/v1/chatbots/{id}/lead-categories | Liostaigh catagóirí luaidhe | leads:read |
POST | /api/v1/chatbots/{id}/lead-categories | Cruthaigh catagóir luaidhe | leads:write |
GET | /api/v1/lead-categories/{id} | Faigh catagóir luaidhe | leads:read |
PATCH | /api/v1/lead-categories/{id} | Nuashonraigh catagóir luaidhe | leads:write |
DELETE | /api/v1/lead-categories/{id} | Scrios catagóir luaidhe | leads:write |
PUT | /api/v1/lead-categories/{id}/users/{userId} | Ceangail ball le catagóir luaidhe | leads:write |
DELETE | /api/v1/lead-categories/{id}/users/{userId} | Bain ball as catagóir luaidhe | leads:write |
Contact forms
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/chatbots/{id}/forms | Liostaigh foirmeacha teagmhála | forms:read |
POST | /api/v1/chatbots/{id}/forms | Cruthaigh foirm teagmhála | forms:write |
GET | /api/v1/forms/{id} | Faigh foirm teagmhála | forms:read |
PATCH | /api/v1/forms/{id} | Nuashonraigh foirm teagmhála | forms:write |
DELETE | /api/v1/forms/{id} | Scrios foirm teagmhála | forms:write |
GET | /api/v1/forms/{id}/submissions | Liostaigh isteachlíneacha foirme | forms:read |
GET | /api/v1/forms/{id}/stats | Staitisticí isteachlíne foirme | forms:read |
GET | /api/v1/submissions/{id} | Faigh isteachlíne foirme | forms:read |
PATCH | /api/v1/submissions/{id} | Athbhreithniú isteachlíne foirme | forms:write |
DELETE | /api/v1/submissions/{id} | Scrios isteachlíne foirme | forms:write |
Live chat
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/live-chat/availability | Faigh do infhaighteacht comhrá beo féin | chats:read |
PUT | /api/v1/live-chat/availability | Socraigh do infhaighteacht comhrá beo féin | chats:write |
POST | /api/v1/live-chat/heartbeat | Seol bualadh croí láithreachais | chats:write |
GET | /api/v1/live-chat/agents | Liostaigh gníomhairí comhrá beo atá ar fáil | chats:read |
GET | /api/v1/live-chat/sessions | Liostaigh seisiúin comhrá beo | chats:read |
GET | /api/v1/live-chat/sessions/{sessionId} | Faigh seisiún comhrá beo | chats:read |
POST | /api/v1/live-chat/sessions/{sessionId}/assign | Glac le comhrá beo (sannadh d'úinéir na heochair) | chats:write |
POST | /api/v1/live-chat/sessions/{sessionId}/messages | Seol teachtaireacht mar ghníomhairí | chats:write |
POST | /api/v1/live-chat/sessions/{sessionId}/close | Críochnaigh comhrá beo | chats:write |
Analytics
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/analytics | Faigh forbhreathnú anailíse | analytics:read |
GET | /api/v1/analytics/activity | Faigh sraith gníomhaíochta comhrá | analytics:read |
GET | /api/v1/analytics/chatbots | Liostaigh staitisticí feidhmíochta in aghaidh gach chatbot | analytics:read |
GET | /api/v1/analytics/chatbots/{id} | Faigh anailís chatbot | analytics:read |
GET | /api/v1/analytics/leads | Faigh funnel luaidhe | analytics:read |
GET | /api/v1/analytics/forms | Faigh staitisticí isteachlíne foirme | analytics:read |
GET | /api/v1/activity | Faigh achoimre airdeála | analytics:read |
Company & team
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/company | Faigh cuideachta | any key |
PATCH | /api/v1/company | Nuashonraigh cuideachta | company:write |
GET | /api/v1/company/settings | Faigh socruithe cuideachta | company:read |
PATCH | /api/v1/company/settings | Nuashonraigh socruithe cuideachta | company:write |
DELETE | /api/v1/company/logo | Bain lógó cuideachta | company:write |
GET | /api/v1/company/members | Liostaigh baill foirne | company:read |
PATCH | /api/v1/company/members/{userId} | Athraigh ról ball | company:write |
DELETE | /api/v1/company/members/{userId} | Bain ball foirne | company:write |
GET | /api/v1/company/invites | Liostaigh cuireadh | company:read |
POST | /api/v1/company/invites | Cuireadh ball foirne | company:write |
DELETE | /api/v1/company/invites/{id} | Cealaigh cuireadh | company:write |
POST | /api/v1/company/invites/{id}/resend | Athsheol cuireadh | company:write |
Email Assistant
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/email/connections | Liostaigh nascadh bosca poist | email:read |
GET | /api/v1/email/connections/{id} | Faigh nasc bosca poist | email:read |
PATCH | /api/v1/email/connections/{id} | Nuashonraigh nasc bosca poist | email:write |
DELETE | /api/v1/email/connections/{id} | Dísconaict bosca poist | email:write |
GET | /api/v1/email/connections/{id}/categories | Liostaigh catagóirí ríomhphoist | email:read |
POST | /api/v1/email/connections/{id}/categories | Cruthaigh catagóir ríomhphoist | email:write |
GET | /api/v1/email/connections/{id}/folders | Liostaigh fillteáin poist | email:read |
POST | /api/v1/email/connections/{id}/folders | Cruthaigh fillteán poist | email:write |
GET | /api/v1/email/connections/{id}/activity | Liostaigh log gníomhaíochta ríomhphoist | email:read |
GET | /api/v1/email/categories/{id} | Faigh catagóir ríomhphoist | email:read |
PATCH | /api/v1/email/categories/{id} | Nuashonraigh catagóir ríomhphoist | email:write |
DELETE | /api/v1/email/categories/{id} | Scrios catagóir ríomhphoist | email:write |
GET | /api/v1/email/contacts | Liostaigh teagmhálacha ríomhphoist | email:read |
GET | /api/v1/email/contacts/{id} | Faigh teagmháil ríomhphoist | email:read |
PATCH | /api/v1/email/contacts/{id} | Nuashonraigh teagmháil ríomhphoist | email:write |
DELETE | /api/v1/email/contacts/{id} | Scrios teagmháil ríomhphoist | email:write |
Account & notifications
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/me | Faigh comhthéacs eochair (whoami) | any key |
GET | /api/v1/account/usage | Faigh plean agus úsáid | any key |
GET | /api/v1/notifications | Liostaigh fógraí | any key |
DELETE | /api/v1/notifications | Scrios fógraí léite sean | any key |
GET | /api/v1/notifications/unread-count | Faigh comhaireamh fógraí gan léamh | any key |
POST | /api/v1/notifications/mark-all-read | Marcáil gach fógra mar léite | any key |
GET | /api/v1/notifications/{id} | Faigh fógra | any key |
PATCH | /api/v1/notifications/{id} | Marcáil fógra mar léite | any key |
Blog (platform)
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/blog | Liostaigh poist bhlag | any key |
POST | /api/v1/blog | Cruthaigh post bhlag | any key |
POST | /api/v1/blog/assets | Uaslódáil sócmhainn bhlag | any key |
GET | /api/v1/blog/{id} | Faigh post bhlag | any key |
PATCH | /api/v1/blog/{id} | Nuashonraigh post bhlag | any key |
DELETE | /api/v1/blog/{id} | Scrios post bhlag | any key |
POST | /api/v1/blog/{id}/translations | Cuir aistriúcháin bhlag i sciobadh | any key |
An gá le cabhair? Déan teagmháil lenár bhfoireann tacaíochta →