Saltar para a documentação
Python

Todos os métodos

Os 430, uma linha cada, junto ao endpoint que cada um chama.

Todos os métodos

Um método para cada operação documentada, com os nomes de TypeScript em snake_case, e a verificação de paridade do pacote prova-o. Lê o documento OpenAPI, chama todos os métodos contra um transporte que grava os pedidos, e falha quando uma operação não tem método ou quando um método envia algo que não seja exatamente o pedido que o seu equivalente em TypeScript envia.

Todos os exemplos usam o cliente já pronto, from openemail import openemail, que lê OPENEMAIL_API_KEY na primeira vez que é usado. AsyncOpenEmail tem todos os métodos daqui com os mesmos argumentos: faça a chamada com await e percorra iterate com async for.

list_all e iterate percorrem o mesmo endpoint que o list ao seu lado, tal como os outros pares com o nome da lista que percorrem, como list_all_runs e iterate_runs em rules. Por isso, um pedido pode aparecer em mais do que uma linha.

As linhas de temp_mail dizem «Inbox token» onde todas as outras indicam um âmbito. As caixas descartáveis são o único recurso da API que se autentica com algo que não é uma chave: passe o token oe_inbox_ que create devolveu como inbox_token= em cada chamada.

ChamadaEndpointÂmbito
me.get()GET /keys/selfSem âmbito
me.ping()GET /pingSem âmbito
me.rotate()POST /keys/self/rotatekeys:write
security.step_up_status()GET /security/step-upSem âmbito
security.begin_step_up()POST /security/step-upSem âmbito
security.verify_step_up()POST /security/step-up/verifySem âmbito
keys.list()GET /keyskeys:read
keys.list_all()GET /keyskeys:read
keys.iterate()GET /keyskeys:read
keys.get()GET /keys/{id}keys:read
keys.create()POST /keyskeys:manage
keys.update()PATCH /keys/{id}keys:manage
keys.delete()DELETE /keys/{id}keys:manage
keys.rotate()POST /keys/{id}/rotatekeys:manage
keys.revoke()POST /keys/{id}/revokekeys:manage
keys.list_requests()GET /keys/{id}/requestskeys:read
keys.list_all_requests()GET /keys/{id}/requestskeys:read
keys.iterate_requests()GET /keys/{id}/requestskeys:read
keys.list_activity()GET /keys/{id}/activitykeys:read
keys.list_all_activity()GET /keys/{id}/activitykeys:read
keys.iterate_activity()GET /keys/{id}/activitykeys:read
keys.list_workspace_requests()GET /keys/requestskeys:read
keys.list_all_workspace_requests()GET /keys/requestskeys:read
keys.iterate_workspace_requests()GET /keys/requestskeys:read
keys.list_workspace_activity()GET /keys/activitykeys:read
keys.list_all_workspace_activity()GET /keys/activitykeys:read
keys.iterate_workspace_activity()GET /keys/activitykeys:read
keys.stats()GET /keys/statskeys:read + emails:read
addresses.list()GET /addressesemails:send
addresses.list_all()GET /addressesemails:send
addresses.iterate()GET /addressesemails:send
languages.list()GET /languagesSem âmbito
emails.send()POST /emailsemails:send
emails.send_batch()POST /emails/batchemails:send
emails.translate()POST /emails/translateemails:send
emails.check()POST /emails/checkemails:send
emails.list()GET /emailsemails:read
emails.list_all()GET /emailsemails:read
emails.iterate()GET /emailsemails:read
emails.get()GET /emails/{id}emails:read
emails.list_events()GET /emails/{id}/eventsemails:read
emails.list_all_events()GET /emails/{id}/eventsemails:read
emails.iterate_events()GET /emails/{id}/eventsemails:read
emails.get_tracking()GET /emails/{id}/trackingemails:read
emails.cancel()POST /emails/{id}/cancelemails:send
emails.reschedule()PATCH /emails/{id}emails:send
emails.update()PATCH /emails/{id}emails:send
emails.compose()POST /emails/composeemails:send
emails.rewrite()POST /emails/rewriteemails:send
emails.suggest_subject()POST /emails/subjectemails:send
templates.list()GET /templatestemplates:read
templates.list_all()GET /templatestemplates:read
templates.iterate()GET /templatestemplates:read
templates.get()GET /templates/{id}templates:read
templates.create()POST /templatestemplates:write
templates.update()PATCH /templates/{id}templates:write
templates.duplicate()POST /templates/{id}/duplicatetemplates:write
templates.replace_content()POST /templates/{id}/contenttemplates:write
templates.delete()DELETE /templates/{id}templates:write
templates.list_versions()GET /templates/{id}/versionstemplates:read
templates.list_all_versions()GET /templates/{id}/versionstemplates:read
templates.iterate_versions()GET /templates/{id}/versionstemplates:read
templates.get_version()GET /templates/{id}/versions/{version}templates:read
templates.publish()POST /templates/{id}/versionstemplates:write
templates.restore_version()POST /templates/{id}/versions/{version}/restoretemplates:write
templates.delete_version()DELETE /templates/{id}/versions/{version}templates:write
templates.list_starters()GET /templates/starterstemplates:read
templates.get_starter()GET /templates/starters/{slug}templates:read
templates.list_fonts()GET /templates/fontstemplates:read
templates.render()POST /templates/rendertemplates:read
templates.preview()POST /templates/{id}/previewtemplates:read
templates.get_analytics()GET /templates/{id}/analyticstemplates:read
templates.list_sends()GET /templates/{id}/sendstemplates:read
templates.send()POST /templates/{id}/sendtemplates:write + emails:send
templates.list_images()GET /templates/imagestemplates:read
templates.list_all_images()GET /templates/imagestemplates:read
templates.iterate_images()GET /templates/imagestemplates:read
templates.upload_image()POST /templates/imagestemplates:write
templates.design()POST /templates/designtemplates:write
templates.redesign()POST /templates/{id}/redesigntemplates:write
tracking.list()GET /trackingemails:read
tracking.list_all()GET /trackingemails:read
tracking.iterate()GET /trackingemails:read
tracking.get_stats()GET /tracking/statsemails:read
tracking.get()GET /tracking/{id}emails:read
tracking.list_opens()GET /tracking/{id}/opensemails:read
tracking.list_all_opens()GET /tracking/{id}/opensemails:read
tracking.iterate_opens()GET /tracking/{id}/opensemails:read
tracking.list_clicks()GET /tracking/{id}/clicksemails:read
tracking.list_all_clicks()GET /tracking/{id}/clicksemails:read
tracking.iterate_clicks()GET /tracking/{id}/clicksemails:read
threads.list()GET /threadsthreads:read
threads.list_all()GET /threadsthreads:read
threads.iterate()GET /threadsthreads:read
threads.get()GET /threads/{id}threads:read
threads.update()PATCH /threads/{id}threads:write
threads.trash()POST /threads/{id}/trashthreads:write
threads.snooze()POST /threads/{id}/snoozethreads:write
threads.unsnooze()POST /threads/{id}/unsnoozethreads:write
threads.list_attachments()GET /threads/{id}/messages/{messageId}/attachmentsthreads:read
threads.list_notes()GET /threads/{id}/notesthreads:read
threads.create_note()POST /threads/{id}/notesthreads:write
threads.update_note()PATCH /threads/{id}/notes/{noteId}threads:write
threads.delete_note()DELETE /threads/{id}/notes/{noteId}threads:write
threads.reorder_notes()POST /threads/{id}/notes/reorderthreads:write
threads.counts()GET /threads/countsthreads:read
threads.summary()GET /threads/{id}/summarythreads:read
threads.restore()POST /threads/{id}/restorethreads:write
threads.delete()DELETE /threads/{id}threads:write
threads.unsubscribe()POST /threads/{id}/unsubscribethreads:write
threads.get_event()GET /threads/{id}/eventcalendar:read
drafts.list()GET /draftsdrafts:read
drafts.list_all()GET /draftsdrafts:read
drafts.iterate()GET /draftsdrafts:read
drafts.get()GET /drafts/{id}drafts:read
drafts.create()POST /draftsdrafts:write
drafts.update()PATCH /drafts/{id}drafts:write
drafts.delete()DELETE /drafts/{id}drafts:write
labels.list()GET /labelslabels:read
labels.list_all()GET /labelslabels:read
labels.iterate()GET /labelslabels:read
labels.list_colors()GET /labels/colorslabels:read
labels.get()GET /labels/{id}labels:read
labels.create()POST /labelslabels:write
labels.update()PATCH /labels/{id}labels:write
labels.delete()DELETE /labels/{id}labels:write
contacts.list()GET /contactscontacts:read
contacts.list_all()GET /contactscontacts:read
contacts.iterate()GET /contactscontacts:read
contacts.get()GET /contacts/{email}contacts:read
contacts.create()POST /contactscontacts:write
contacts.update()PATCH /contacts/{email}contacts:write
contacts.delete()DELETE /contacts/{email}contacts:write
contacts.set_audiences()PUT /contacts/{email}/audiencesaudiences:write
contacts.list_people()GET /contacts/peoplecontacts:read
contacts.list_all_people()GET /contacts/peoplecontacts:read
contacts.iterate_people()GET /contacts/peoplecontacts:read
contacts.save()PUT /contacts/{email}contacts:write
contacts.delete_many()POST /contacts/batch-deletecontacts:write
contacts.set_photo()PUT /contacts/{email}/photocontacts:write
contacts.remove_photo()DELETE /contacts/{email}/photocontacts:write
contacts.block()POST /contacts/{email}/blocksettings:write
contacts.unblock()DELETE /contacts/{email}/blocksettings:write
contacts.list_threads()GET /contacts/{email}/threadsthreads:read
contacts.list_all_threads()GET /contacts/{email}/threadsthreads:read
contacts.iterate_threads()GET /contacts/{email}/threadsthreads:read
contacts.activity()GET /contacts/{email}/activitythreads:read
audiences.list()GET /audiencesaudiences:read
audiences.list_all()GET /audiencesaudiences:read
audiences.iterate()GET /audiencesaudiences:read
audiences.growth()GET /audiences/growthaudiences:read
audiences.get()GET /audiences/{id}audiences:read
audiences.create()POST /audiencesaudiences:write
audiences.update()PATCH /audiences/{id}audiences:write
audiences.delete()DELETE /audiences/{id}audiences:write
audiences.empty()POST /audiences/{id}/emptyaudiences:write
audiences.list_contacts()GET /audiences/{id}/contactsaudiences:read
audiences.list_all_contacts()GET /audiences/{id}/contactsaudiences:read
audiences.iterate_contacts()GET /audiences/{id}/contactsaudiences:read
audiences.add_contact()POST /audiences/{id}/contactsaudiences:write
audiences.remove_contact()DELETE /audiences/{id}/contacts/{email}audiences:write
audiences.add_contacts()POST /audiences/{id}/contacts/batchaudiences:write
audiences.remove_contacts()POST /audiences/{id}/contacts/batch-removeaudiences:write
audiences.import_contacts()POST /audiences/{id}/importaudiences:write + contacts:write
forms.list()GET /formsforms:read
forms.list_all()GET /formsforms:read
forms.iterate()GET /formsforms:read
forms.create()POST /formsforms:write
forms.design()POST /forms/designforms:write
forms.redesign()POST /forms/{id}/redesignforms:write
forms.list_starters()GET /forms/startersforms:read
forms.get_starter()GET /forms/starters/{slug}forms:read
forms.get()GET /forms/{id}forms:read
forms.update()PATCH /forms/{id}forms:write
forms.delete()DELETE /forms/{id}forms:write
forms.publish()POST /forms/{id}/publishforms:write
forms.pause()POST /forms/{id}/pauseforms:write
forms.resume()POST /forms/{id}/resumeforms:write
forms.duplicate()POST /forms/{id}/duplicateforms:write
forms.analytics()GET /forms/{id}/analyticsforms:read
forms.list_submissions()GET /forms/{id}/submissionsforms:read
forms.list_all_submissions()GET /forms/{id}/submissionsforms:read
forms.iterate_submissions()GET /forms/{id}/submissionsforms:read
forms.get_submission()GET /forms/{id}/submissions/{submissionId}forms:read
forms.delete_submission()DELETE /forms/{id}/submissions/{submissionId}forms:write
forms.delete_submissions()POST /forms/{id}/submissions/batch-removeforms:write
forms.approve_submission()POST /forms/{id}/submissions/{submissionId}/approveforms:write + contacts:write
forms.resend_confirmation()POST /forms/{id}/submissions/{submissionId}/resendforms:write + emails:send
forms.subscribe()POST /subscribe/{formId}Sem credencial
broadcasts.preview()POST /broadcasts/previewaudiences:read
broadcasts.send()POST /broadcastsemails:send + audiences:read
broadcasts.list()GET /broadcastsemails:read
broadcasts.list_all()GET /broadcastsemails:read
broadcasts.iterate()GET /broadcastsemails:read
broadcasts.get()GET /broadcasts/{id}emails:read
broadcasts.stats()GET /broadcasts/{id}/statsemails:read
broadcasts.analytics()GET /broadcasts/analyticsemails:read
broadcasts.list_recipients()GET /broadcasts/{id}/recipientsemails:read
broadcasts.list_all_recipients()GET /broadcasts/{id}/recipientsemails:read
broadcasts.iterate_recipients()GET /broadcasts/{id}/recipientsemails:read
broadcasts.get_recipient()GET /broadcasts/{id}/recipients/{emailId}emails:read
broadcasts.cancel()POST /broadcasts/{id}/cancelemails:send
domains.list()GET /domainsdomains:read
domains.list_all()GET /domainsdomains:read
domains.iterate()GET /domainsdomains:read
domains.get()GET /domains/{id}domains:read
domains.create()POST /domainsdomains:write
domains.verify()POST /domains/{id}/verifydomains:write
domains.update()PATCH /domains/{id}domains:write
domains.delete()DELETE /domains/{id}domains:write
domains.get_logo()GET /domains/{id}/logodomains:read
domains.set_logo()PUT /domains/{id}/logodomains:write
domains.remove_logo()DELETE /domains/{id}/logodomains:write
domains.set_logo_certificate()PUT /domains/{id}/logo/certificatedomains:write
domains.remove_logo_certificate()DELETE /domains/{id}/logo/certificatedomains:write
domains.list_addresses()GET /domains/{id}/addressesdomains:read
domains.list_all_addresses()GET /domains/{id}/addressesdomains:read
domains.iterate_addresses()GET /domains/{id}/addressesdomains:read
domains.create_address()POST /domains/{id}/addressesdomains:write
domains.get_address()GET /domains/{id}/addresses/{addressId}domains:read
domains.update_address()PATCH /domains/{id}/addresses/{addressId}domains:write
domains.set_address_photo()PUT /domains/{id}/addresses/{addressId}/photodomains:write
domains.remove_address_photo()DELETE /domains/{id}/addresses/{addressId}/photodomains:write
domains.delete_address()DELETE /domains/{id}/addresses/{addressId}domains:write
domains.list_address_forwards()GET /domains/{id}/addresses/{addressId}/forwardsdomains:read
domains.add_address_forwards()POST /domains/{id}/addresses/{addressId}/forwardsdomains:write
domains.update_address_forward()PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId}domains:write
domains.delete_address_forward()DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId}domains:write
domains.resend_address_forward_consent()POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resenddomains:write
domains.list_address_members()GET /domains/{id}/addresses/{addressId}/membersmembers:read
domains.get_address_login()GET /domains/{id}/addresses/{addressId}/loginmembers:write
domains.set_address_login()PUT /domains/{id}/addresses/{addressId}/loginmembers:write
domains.delete_address_login()DELETE /domains/{id}/addresses/{addressId}/loginmembers:write
domains.get_dns()GET /domains/{id}/dnsdomains:read
domains.set_dns_zone()PUT /domains/{id}/dnsdomains:write
domains.sync_dns()POST /domains/{id}/dns/syncdomains:write
app_host.get()GET /app-hostdomains:read
app_host.set()PUT /app-hostdomains:write
app_host.verify()POST /app-host/verifydomains:write
app_host.delete()DELETE /app-hostdomains:write
branding.get()GET /brandingsettings:read
branding.update()PATCH /brandingsettings:write
branding.upload_image()PUT /branding/images/{variant}settings:write
branding.remove_image()DELETE /branding/images/{variant}settings:write
rules.list()GET /rulesrules:read
rules.list_all()GET /rulesrules:read
rules.iterate()GET /rulesrules:read
rules.get()GET /rules/{id}rules:read
rules.create()POST /rulesrules:write
rules.update()PATCH /rules/{id}rules:write
rules.delete()DELETE /rules/{id}rules:write
rules.reorder()POST /rules/reorderrules:write
rules.test()POST /rules/{id}/testrules:read
rules.list_runs()GET /rules/runsrules:read
rules.list_all_runs()GET /rules/runsrules:read
rules.iterate_runs()GET /rules/runsrules:read
webhooks.list()GET /webhookswebhooks:read
webhooks.list_all()GET /webhookswebhooks:read
webhooks.iterate()GET /webhookswebhooks:read
webhooks.get()GET /webhooks/{id}webhooks:read
webhooks.create()POST /webhookswebhooks:write
webhooks.update()PATCH /webhooks/{id}webhooks:write
webhooks.delete()DELETE /webhooks/{id}webhooks:write
webhooks.rotate_secret()POST /webhooks/{id}/rotate-secretwebhooks:write
webhooks.test()POST /webhooks/{id}/testwebhooks:write
webhooks.list_deliveries()GET /webhooks/{id}/deliverieswebhooks:read
webhooks.list_all_deliveries()GET /webhooks/{id}/deliverieswebhooks:read
webhooks.iterate_deliveries()GET /webhooks/{id}/deliverieswebhooks:read
webhooks.get_delivery()GET /webhooks/{id}/deliveries/{deliveryId}webhooks:read
webhooks.replay_delivery()POST /webhooks/{id}/deliveries/{deliveryId}/replaywebhooks:write
webhooks.list_workspace_deliveries()GET /webhooks/deliverieswebhooks:read
webhooks.list_all_workspace_deliveries()GET /webhooks/deliverieswebhooks:read
webhooks.iterate_workspace_deliveries()GET /webhooks/deliverieswebhooks:read
webhooks.list_activity()GET /webhooks/{id}/activitywebhooks:read
webhooks.list_all_activity()GET /webhooks/{id}/activitywebhooks:read
webhooks.iterate_activity()GET /webhooks/{id}/activitywebhooks:read
webhooks.list_workspace_activity()GET /webhooks/activitywebhooks:read
webhooks.list_all_workspace_activity()GET /webhooks/activitywebhooks:read
webhooks.iterate_workspace_activity()GET /webhooks/activitywebhooks:read
webhooks.list_events()GET /webhooks/eventswebhooks:read
webhooks.stats()GET /webhooks/statswebhooks:read
imports.list()GET /importsthreads:read
imports.list_all()GET /importsthreads:read
imports.iterate()GET /importsthreads:read
imports.get()GET /imports/{id}threads:read
imports.create()POST /importsthreads:write
imports.upload_state()GET /imports/{id}/uploadthreads:write
imports.upload_chunk()PUT /imports/{id}/files/{file}/chunks/{chunk}threads:write
imports.start()POST /imports/{id}/startthreads:write
imports.cancel()POST /imports/{id}/cancelthreads:write
imports.list_failures()GET /imports/{id}/failuresthreads:read
imports.delete_upload()DELETE /imports/{id}/uploadthreads:write
imports.import_files()POST /importsthreads:write
provider_imports.inspect()POST /provider-imports/inspectsettings:write
provider_imports.create()POST /provider-importssettings:write
provider_imports.list()GET /provider-importssettings:read
provider_imports.list_all()GET /provider-importssettings:read
provider_imports.iterate()GET /provider-importssettings:read
provider_imports.get()GET /provider-imports/{id}settings:read
provider_imports.cancel()POST /provider-imports/{id}/cancelsettings:write
calendar.list_events()GET /calendar/eventscalendar:read
calendar.list_all_events()GET /calendar/eventscalendar:read
calendar.iterate_events()GET /calendar/eventscalendar:read
calendar.get_event()GET /calendar/events/{id}calendar:read
calendar.get_event_ics()GET /calendar/events/{id}/icscalendar:read
calendar.create_event()POST /calendar/eventscalendar:write
calendar.update_event()PATCH /calendar/events/{id}calendar:write
calendar.delete_event()DELETE /calendar/events/{id}calendar:write
calendar.cancel_event()POST /calendar/events/{id}/cancelcalendar:write
calendar.respond_to_event()POST /calendar/events/{id}/respondcalendar:write + emails:send
settings.get()GET /settingssettings:read
settings.update()PATCH /settingssettings:write
roles.list()GET /rolesroles:read
roles.list_all()GET /rolesroles:read
roles.iterate()GET /rolesroles:read
roles.get()GET /roles/{id}roles:read
roles.create()POST /rolesroles:write
roles.update()PATCH /roles/{id}roles:write
roles.delete()DELETE /roles/{id}roles:write
roles.list_permissions()GET /roles/permissionsroles:read
members.list()GET /membersmembers:read
members.list_all()GET /membersmembers:read
members.iterate()GET /membersmembers:read
members.get()GET /members/{userId}members:read
members.add()POST /membersmembers:write
members.update()PATCH /members/{userId}members:write
members.remove()DELETE /members/{userId}members:write
members.grant_address()POST /members/{userId}/addressesmembers:write
members.revoke_address()DELETE /members/{userId}/addresses/{addressId}members:write
members.grant_domain()POST /members/{userId}/domainsmembers:write
members.revoke_domain()DELETE /members/{userId}/domains/{domainId}members:write
members.list_invitations()GET /members/invitationsmembers:read
members.list_all_invitations()GET /members/invitationsmembers:read
members.iterate_invitations()GET /members/invitationsmembers:read
members.revoke_invitation()DELETE /members/invitations/{invitationId}members:write
members.resend_invitation()POST /members/invitations/{invitationId}/resendmembers:write
suppressions.list()GET /suppressionssettings:read
suppressions.list_all()GET /suppressionssettings:read
suppressions.iterate()GET /suppressionssettings:read
suppressions.get()GET /suppressions/{id}settings:read
suppressions.add()POST /suppressionssettings:write
suppressions.remove()DELETE /suppressions/{id}settings:write
files.list()GET /filesfiles:read
files.list_all()GET /filesfiles:read
files.iterate()GET /filesfiles:read
files.get()GET /files/{id}files:read
files.stats()GET /files/statsfiles:read
files.download()GET /files/{id}/contentfiles:read
files.list_links()GET /files/{id}/linksfiles:read
files.list_all_links()GET /files/{id}/linksfiles:read
files.iterate_links()GET /files/{id}/linksfiles:read
files.create_link()POST /files/{id}/linksfiles:write
files.revoke_link()DELETE /files/{id}/links/{linkId}files:write
files.revoke_all_links()DELETE /files/{id}/linksfiles:write
files.upload()POST /filesfiles:write
files.delete()DELETE /files/{id}files:write
files.delete_many()POST /files/batch-deletefiles:write
temp_mail.list_domains()GET /temp-mail/domainsSem credencial
temp_mail.create()POST /temp-mail/inboxesSem credencial
temp_mail.get()GET /temp-mail/inboxes/{id}Token da caixa de entrada
temp_mail.extend()POST /temp-mail/inboxes/{id}/extendToken da caixa de entrada
temp_mail.delete()DELETE /temp-mail/inboxes/{id}Token da caixa de entrada
temp_mail.list_messages()GET /temp-mail/inboxes/{id}/messagesToken da caixa de entrada
temp_mail.list_all_messages()GET /temp-mail/inboxes/{id}/messagesToken da caixa de entrada
temp_mail.iterate_messages()GET /temp-mail/inboxes/{id}/messagesToken da caixa de entrada
temp_mail.get_message()GET /temp-mail/inboxes/{id}/messages/{messageId}Token da caixa de entrada
temp_mail.delete_message()DELETE /temp-mail/inboxes/{id}/messages/{messageId}Token da caixa de entrada
temp_mail.list_attachments()GET /temp-mail/inboxes/{id}/messages/{messageId}/attachmentsToken da caixa de entrada
tools.check_dmarc()GET /tools/dmarcSem âmbito
tools.check_bimi()GET /tools/bimiSem âmbito
tools.check_deliverability()GET /tools/deliverabilitySem âmbito
support.send()POST /supportSem âmbito
encryption.list_keys()GET /encryption/keysemails:read
encryption.publish_key()POST /encryption/keysemails:read
encryption.lookup_keys()GET /encryption/keys/lookupemails:send
senders.get()GET /senders/{email}threads:read
senders.research()POST /senders/{email}/researchthreads:read
chats.list()GET /chatsthreads:read
chats.list_all()GET /chatsthreads:read
chats.iterate()GET /chatsthreads:read
chats.get()GET /chats/{id}threads:read
chats.rename()PATCH /chats/{id}threads:write
chats.delete()DELETE /chats/{id}threads:write
analytics.mailbox()GET /analytics/mailboxthreads:read
analytics.sending()GET /analytics/sendingemails:read
subscriptions.list()GET /subscriptionsthreads:read
subscriptions.list_domains()GET /subscriptions/domainsthreads:read
subscriptions.unsubscribe()POST /subscriptions/{id}/unsubscribethreads:write
subscriptions.unsubscribe_domain()POST /subscriptions/domains/{domain}/unsubscribethreads:write
subscriptions.move()POST /subscriptions/{id}/movethreads:write
exports.preview()GET /exports/previewthreads:read
exports.list()GET /exportsthreads:read
exports.get()GET /exports/{id}threads:read
exports.start()POST /exportsthreads:read
exports.download()GET /exports/{id}/contentthreads:read
dns_connections.list()GET /dns-connectionsdomains:read
dns_connections.get()GET /dns-connections/{id}domains:read
dns_connections.delete()DELETE /dns-connections/{id}domains:write
billing.get()GET /billingbilling:read
billing.list_plans()GET /billing/plansbilling:read
billing.get_usage()GET /billing/usagebilling:read
billing.list_alerts()GET /billing/alertsbilling:read
billing.list_countries()GET /billing/countriesbilling:read
billing.get_pay_as_you_go()GET /billing/pay-as-you-gobilling:read
billing.set_pay_as_you_go()PATCH /billing/pay-as-you-gobilling:write
billing.set_pay_as_you_go_limit()PUT /billing/pay-as-you-go/limitbilling:write
billing.confirm_pay_as_you_go()POST /billing/pay-as-you-go/confirmbilling:write
billing.start_checkout()POST /billing/checkoutbilling:write
billing.open_portal()POST /billing/portalbilling:write
billing.list_invoices()GET /billing/invoicesbilling:read
billing.get_invoice()GET /billing/invoices/{orderId}billing:read
billing.save_invoice_details()PUT /billing/invoices/{orderId}/detailsbilling:write
workspaces.list()GET /workspacesaccount:read
workspaces.create()POST /workspacesaccount:write
workspaces.get_active()GET /workspaces/activeaccount:read
workspaces.set_active()PUT /workspaces/activeaccount:write
workspaces.delete()DELETE /workspaces/{id}account:write
account.get_notifications()GET /account/notificationsaccount:read
account.set_email_notification()PUT /account/notifications/email/{category}account:write
account.set_push_muted()PUT /account/notifications/push/{workspaceId}account:write
account.set_photo()PUT /account/photoaccount:write
account.remove_photo()DELETE /account/photoaccount:write
account.get_username()GET /account/usernameaccount:read
account.check_username()GET /account/username/availabilityaccount:read
account.set_username()PUT /account/usernameaccount:write
account.list_connected_apps()GET /account/connected-appsaccount:read
account.revoke_connected_app()DELETE /account/connected-apps/{clientId}account:write
account.list_invitations()GET /account/invitationsaccount:read
account.accept_invitation()POST /account/invitations/{invitationId}/acceptaccount:write
account.decline_invitation()POST /account/invitations/{invitationId}/declineaccount:write