Go
Todos os métodos
Os 558, uma linha cada, junto ao endpoint que cada um chama.
Todos os métodos
Um método para cada método do SDK de TypeScript, com o mesmo nome na grafia de Go, e a verificação de paridade do módulo prova-o. Executa cada método de Go e o seu gémeo de TypeScript com os mesmos argumentos e todas as opções definidas, e falha quando um método falta ou envia um método, um caminho, uma consulta, um cabeçalho ou um corpo diferente.
Cada lista paginada tem ao lado um ListAll e um Iterate, com o nome da lista que percorrem: ListAllEvents e IterateEvents ao lado de ListEvents. Chamam o mesmo endpoint que a lista, por isso as três linhas partilham um caminho.
As linhas de TempMail dizem "inbox token" onde todas as outras indicam um âmbito. As caixas descartáveis autenticam-se com o token que Create devolve, passado com openemail.WithInboxToken, e ListDomains e Create não enviam nenhuma credencial.
As três linhas de Security não precisam de âmbito porque só respondem a um token de acesso OAuth. Uma chave de API que chame uma delas recebe um 400 step_up_not_applicable.
| Chamada | Endpoint | Âmbito |
|---|---|---|
| Me.Get | GET /keys/self | Sem âmbito |
| Me.Ping | GET /ping | Sem âmbito |
| Me.Rotate | POST /keys/self/rotate | keys:write |
| Me.ListRequests | GET /keys/self/requests | Sem âmbito |
| Me.ListAllRequests | GET /keys/self/requests | Sem âmbito |
| Me.IterateRequests | GET /keys/self/requests | Sem âmbito |
| Me.ListActivity | GET /keys/self/activity | Sem âmbito |
| Me.ListAllActivity | GET /keys/self/activity | Sem âmbito |
| Me.IterateActivity | GET /keys/self/activity | Sem âmbito |
| Me.Stats | GET /keys/self/stats | Sem âmbito |
| Security.StepUpStatus | GET /security/step-up | Sem âmbito |
| Security.BeginStepUp | POST /security/step-up | Sem âmbito |
| Security.VerifyStepUp | POST /security/step-up/verify | Sem âmbito |
| Keys.List | GET /keys | keys:read |
| Keys.ListAll | GET /keys | keys:read |
| Keys.Iterate | GET /keys | keys:read |
| Keys.Get | GET /keys/{id} | keys:read |
| Keys.Create | POST /keys | keys:manage |
| Keys.Update | PATCH /keys/{id} | keys:manage |
| Keys.Delete | DELETE /keys/{id} | keys:manage |
| Keys.Rotate | POST /keys/{id}/rotate | keys:manage |
| Keys.Revoke | POST /keys/{id}/revoke | keys:manage |
| Keys.ListRequests | GET /keys/{id}/requests | keys:read |
| Keys.ListAllRequests | GET /keys/{id}/requests | keys:read |
| Keys.IterateRequests | GET /keys/{id}/requests | keys:read |
| Keys.ListActivity | GET /keys/{id}/activity | keys:read |
| Keys.ListAllActivity | GET /keys/{id}/activity | keys:read |
| Keys.IterateActivity | GET /keys/{id}/activity | keys:read |
| Keys.ListWorkspaceRequests | GET /keys/requests | keys:read |
| Keys.ListAllWorkspaceRequests | GET /keys/requests | keys:read |
| Keys.IterateWorkspaceRequests | GET /keys/requests | keys:read |
| Keys.ListWorkspaceActivity | GET /keys/activity | keys:read |
| Keys.ListAllWorkspaceActivity | GET /keys/activity | keys:read |
| Keys.IterateWorkspaceActivity | GET /keys/activity | keys:read |
| Keys.Stats | GET /keys/stats | keys:read + emails:read |
| Addresses.List | GET /addresses | emails:send |
| Addresses.ListAll | GET /addresses | emails:send |
| Addresses.Iterate | GET /addresses | emails:send |
| Languages.List | GET /languages | Sem âmbito |
| Emails.Send | POST /emails | emails:send |
| Emails.SendBatch | POST /emails/batch | emails:send |
| Emails.Translate | POST /emails/translate | emails:send |
| Emails.Check | POST /emails/check | emails:send |
| Emails.List | GET /emails | emails:read |
| Emails.ListAll | GET /emails | emails:read |
| Emails.Iterate | GET /emails | emails:read |
| Emails.Get | GET /emails/{id} | emails:read |
| Emails.ListEvents | GET /emails/{id}/events | emails:read |
| Emails.ListAllEvents | GET /emails/{id}/events | emails:read |
| Emails.IterateEvents | GET /emails/{id}/events | emails:read |
| Emails.GetTracking | GET /emails/{id}/tracking | emails:read |
| Emails.Cancel | POST /emails/{id}/cancel | emails:send |
| Emails.Reschedule | PATCH /emails/{id} | emails:send |
| Emails.Update | PATCH /emails/{id} | emails:send |
| Emails.Compose | POST /emails/compose | emails:send |
| Emails.Rewrite | POST /emails/rewrite | emails:send |
| Emails.SuggestSubject | POST /emails/subject | emails:send |
| Templates.List | GET /templates | templates:read |
| Templates.ListAll | GET /templates | templates:read |
| Templates.Iterate | GET /templates | templates:read |
| Templates.Get | GET /templates/{id} | templates:read |
| Templates.Create | POST /templates | templates:write |
| Templates.Update | PATCH /templates/{id} | templates:write |
| Templates.Duplicate | POST /templates/{id}/duplicate | templates:write |
| Templates.ReplaceContent | POST /templates/{id}/content | templates:write |
| Templates.Delete | DELETE /templates/{id} | templates:write |
| Templates.ListVersions | GET /templates/{id}/versions | templates:read |
| Templates.ListAllVersions | GET /templates/{id}/versions | templates:read |
| Templates.IterateVersions | GET /templates/{id}/versions | templates:read |
| Templates.GetVersion | GET /templates/{id}/versions/{version} | templates:read |
| Templates.Publish | POST /templates/{id}/versions | templates:write |
| Templates.RestoreVersion | POST /templates/{id}/versions/{version}/restore | templates:write |
| Templates.DeleteVersion | DELETE /templates/{id}/versions/{version} | templates:write |
| Templates.ListStarters | GET /templates/starters | templates:read |
| Templates.GetStarter | GET /templates/starters/{slug} | templates:read |
| Templates.ListFonts | GET /templates/fonts | templates:read |
| Templates.Render | POST /templates/render | templates:read |
| Templates.Preview | POST /templates/{id}/preview | templates:read |
| Templates.GetAnalytics | GET /templates/{id}/analytics | templates:read |
| Templates.ListSends | GET /templates/{id}/sends | templates:read |
| Templates.Send | POST /templates/{id}/send | templates:write + emails:send |
| Templates.ListImages | GET /templates/images | templates:read |
| Templates.ListAllImages | GET /templates/images | templates:read |
| Templates.IterateImages | GET /templates/images | templates:read |
| Templates.UploadImage | POST /templates/images | templates:write |
| Templates.Design | POST /templates/design | templates:write |
| Templates.Redesign | POST /templates/{id}/redesign | templates:write |
| Tracking.List | GET /tracking | emails:read |
| Tracking.ListAll | GET /tracking | emails:read |
| Tracking.Iterate | GET /tracking | emails:read |
| Tracking.GetStats | GET /tracking/stats | emails:read |
| Tracking.Get | GET /tracking/{id} | emails:read |
| Tracking.ListOpens | GET /tracking/{id}/opens | emails:read |
| Tracking.ListAllOpens | GET /tracking/{id}/opens | emails:read |
| Tracking.IterateOpens | GET /tracking/{id}/opens | emails:read |
| Tracking.ListClicks | GET /tracking/{id}/clicks | emails:read |
| Tracking.ListAllClicks | GET /tracking/{id}/clicks | emails:read |
| Tracking.IterateClicks | GET /tracking/{id}/clicks | emails:read |
| Threads.List | GET /threads | threads:read |
| Threads.ListAll | GET /threads | threads:read |
| Threads.Iterate | GET /threads | threads:read |
| Threads.Get | GET /threads/{id} | threads:read |
| Threads.Update | PATCH /threads/{id} | threads:write |
| Threads.Trash | POST /threads/{id}/trash | threads:write |
| Threads.Snooze | POST /threads/{id}/snooze | threads:write |
| Threads.Unsnooze | POST /threads/{id}/unsnooze | threads:write |
| Threads.Mute | POST /threads/{id}/mute | threads:write |
| Threads.Unmute | POST /threads/{id}/unmute | threads:write |
| Threads.ListAttachments | GET /threads/{id}/messages/{messageId}/attachments | threads:read |
| Threads.ListNotes | GET /threads/{id}/notes | threads:read |
| Threads.CreateNote | POST /threads/{id}/notes | threads:write |
| Threads.UpdateNote | PATCH /threads/{id}/notes/{noteId} | threads:write |
| Threads.DeleteNote | DELETE /threads/{id}/notes/{noteId} | threads:write |
| Threads.ReorderNotes | POST /threads/{id}/notes/reorder | threads:write |
| Threads.Counts | GET /threads/counts | threads:read |
| Threads.Summary | GET /threads/{id}/summary | threads:read |
| Threads.ReplySuggestions | GET /threads/{id}/reply-suggestions | threads:read |
| Threads.Restore | POST /threads/{id}/restore | threads:write |
| Threads.Delete | DELETE /threads/{id} | threads:write |
| Threads.Unsubscribe | POST /threads/{id}/unsubscribe | threads:write |
| Threads.GetEvent | GET /threads/{id}/event | calendar:read |
| Threads.ListSenderCategories | GET /sender-categories | threads:read |
| Threads.SetSenderCategory | PUT /sender-categories/{email} | threads:write |
| Threads.ClearSenderCategory | DELETE /sender-categories/{email} | threads:write |
| FollowUps.List | GET /follow-ups | threads:read |
| FollowUps.Set | POST /follow-ups | threads:write |
| FollowUps.Cancel | DELETE /follow-ups/{id} | threads:write |
| Drafts.List | GET /drafts | drafts:read |
| Drafts.ListAll | GET /drafts | drafts:read |
| Drafts.Iterate | GET /drafts | drafts:read |
| Drafts.Get | GET /drafts/{id} | drafts:read |
| Drafts.Create | POST /drafts | drafts:write |
| Drafts.Update | PATCH /drafts/{id} | drafts:write |
| Drafts.Delete | DELETE /drafts/{id} | drafts:write |
| Labels.List | GET /labels | labels:read |
| Labels.ListAll | GET /labels | labels:read |
| Labels.Iterate | GET /labels | labels:read |
| Labels.ListColors | GET /labels/colors | labels:read |
| Labels.Get | GET /labels/{id} | labels:read |
| Labels.Create | POST /labels | labels:write |
| Labels.Update | PATCH /labels/{id} | labels:write |
| Labels.Test | POST /labels/{id}/test | labels:write + threads:read |
| Labels.Delete | DELETE /labels/{id} | labels:write |
| Contacts.List | GET /contacts | contacts:read |
| Contacts.ListAll | GET /contacts | contacts:read |
| Contacts.Iterate | GET /contacts | contacts:read |
| Contacts.Get | GET /contacts/{email} | contacts:read |
| Contacts.Create | POST /contacts | contacts:write |
| Contacts.Update | PATCH /contacts/{email} | contacts:write |
| Contacts.Delete | DELETE /contacts/{email} | contacts:write |
| Contacts.SetAudiences | PUT /contacts/{email}/audiences | audiences:write |
| Contacts.ListPeople | GET /contacts/people | contacts:read |
| Contacts.ListAllPeople | GET /contacts/people | contacts:read |
| Contacts.IteratePeople | GET /contacts/people | contacts:read |
| Contacts.Save | PUT /contacts/{email} | contacts:write |
| Contacts.DeleteMany | POST /contacts/batch-delete | contacts:write |
| Contacts.SetPhoto | PUT /contacts/{email}/photo | contacts:write |
| Contacts.RemovePhoto | DELETE /contacts/{email}/photo | contacts:write |
| Contacts.Block | POST /contacts/{email}/block | settings:write |
| Contacts.Unblock | DELETE /contacts/{email}/block | settings:write |
| Contacts.ListThreads | GET /contacts/{email}/threads | threads:read |
| Contacts.ListAllThreads | GET /contacts/{email}/threads | threads:read |
| Contacts.IterateThreads | GET /contacts/{email}/threads | threads:read |
| Contacts.Activity | GET /contacts/{email}/activity | threads:read |
| Contacts.ListEvents | GET /contacts/{email}/events | contacts:read |
| Contacts.ListAllEvents | GET /contacts/{email}/events | contacts:read |
| Contacts.IterateEvents | GET /contacts/{email}/events | contacts:read |
| Contacts.ListCards | GET /contacts/cards | contacts:read |
| Contacts.ListAllCards | GET /contacts/cards | contacts:read |
| Contacts.IterateCards | GET /contacts/cards | contacts:read |
| Contacts.GetCard | GET /contacts/cards/{id} | contacts:read |
| Contacts.CreateCard | POST /contacts/cards | contacts:write |
| Contacts.UpdateCard | PATCH /contacts/cards/{id} | contacts:write |
| Contacts.DeleteCard | DELETE /contacts/cards/{id} | contacts:write |
| Contacts.ImportVcf | POST /contacts/imports | contacts:write |
| Contacts.ListImports | GET /contacts/imports | contacts:read |
| Contacts.ListAllImports | GET /contacts/imports | contacts:read |
| Contacts.IterateImports | GET /contacts/imports | contacts:read |
| Contacts.GetImport | GET /contacts/imports/{id} | contacts:read |
| Contacts.UndoImport | POST /contacts/imports/{id}/undo | contacts:write |
| Audiences.List | GET /audiences | audiences:read |
| Audiences.ListAll | GET /audiences | audiences:read |
| Audiences.Iterate | GET /audiences | audiences:read |
| Audiences.Growth | GET /audiences/growth | audiences:read |
| Audiences.Get | GET /audiences/{id} | audiences:read |
| Audiences.Create | POST /audiences | audiences:write |
| Audiences.Update | PATCH /audiences/{id} | audiences:write |
| Audiences.Delete | DELETE /audiences/{id} | audiences:write |
| Audiences.Empty | POST /audiences/{id}/empty | audiences:write |
| Audiences.ListContacts | GET /audiences/{id}/contacts | audiences:read |
| Audiences.ListAllContacts | GET /audiences/{id}/contacts | audiences:read |
| Audiences.IterateContacts | GET /audiences/{id}/contacts | audiences:read |
| Audiences.AddContact | POST /audiences/{id}/contacts | audiences:write |
| Audiences.RemoveContact | DELETE /audiences/{id}/contacts/{email} | audiences:write |
| Audiences.AddContacts | POST /audiences/{id}/contacts/batch | audiences:write |
| Audiences.RemoveContacts | POST /audiences/{id}/contacts/batch-remove | audiences:write |
| Audiences.ImportContacts | POST /audiences/{id}/import | audiences:write + contacts:write |
| Forms.List | GET /forms | forms:read |
| Forms.ListAll | GET /forms | forms:read |
| Forms.Iterate | GET /forms | forms:read |
| Forms.Create | POST /forms | forms:write |
| Forms.Design | POST /forms/design | forms:write |
| Forms.Redesign | POST /forms/{id}/redesign | forms:write |
| Forms.ListStarters | GET /forms/starters | forms:read |
| Forms.GetStarter | 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}/publish | forms:write |
| Forms.Pause | POST /forms/{id}/pause | forms:write |
| Forms.Resume | POST /forms/{id}/resume | forms:write |
| Forms.Duplicate | POST /forms/{id}/duplicate | forms:write |
| Forms.Analytics | GET /forms/{id}/analytics | forms:read |
| Forms.ListSubmissions | GET /forms/{id}/submissions | forms:read |
| Forms.ListAllSubmissions | GET /forms/{id}/submissions | forms:read |
| Forms.IterateSubmissions | GET /forms/{id}/submissions | forms:read |
| Forms.GetSubmission | GET /forms/{id}/submissions/{submissionId} | forms:read |
| Forms.DeleteSubmission | DELETE /forms/{id}/submissions/{submissionId} | forms:write |
| Forms.DeleteSubmissions | POST /forms/{id}/submissions/batch-remove | forms:write |
| Forms.ApproveSubmission | POST /forms/{id}/submissions/{submissionId}/approve | forms:write + contacts:write |
| Forms.ResendConfirmation | POST /forms/{id}/submissions/{submissionId}/resend | forms:write + emails:send |
| Forms.Subscribe | POST /subscribe/{formId} | Sem credencial |
| Automations.List | GET /automations | automations:read |
| Automations.ListAll | GET /automations | automations:read |
| Automations.Iterate | GET /automations | automations:read |
| Automations.Create | POST /automations | automations:write |
| Automations.ListStarters | GET /automations/starters | automations:read |
| Automations.Get | GET /automations/{id} | automations:read |
| Automations.Update | PATCH /automations/{id} | automations:write |
| Automations.Delete | DELETE /automations/{id} | automations:write |
| Automations.Publish | POST /automations/{id}/publish | automations:write + emails:send |
| Automations.Pause | POST /automations/{id}/pause | automations:write |
| Automations.Resume | POST /automations/{id}/resume | automations:write + emails:send |
| Automations.Archive | POST /automations/{id}/archive | automations:write |
| Automations.Duplicate | POST /automations/{id}/duplicate | automations:write |
| Automations.SendTest | POST /automations/{id}/test | automations:write + emails:send |
| Automations.ListVersions | GET /automations/{id}/versions | automations:read |
| Automations.RestoreVersion | POST /automations/{id}/versions/{version}/restore | automations:write |
| Automations.Stats | GET /automations/{id}/stats | automations:read |
| Automations.ListEnrollments | GET /automations/{id}/enrollments | automations:read |
| Automations.ListAllEnrollments | GET /automations/{id}/enrollments | automations:read |
| Automations.IterateEnrollments | GET /automations/{id}/enrollments | automations:read |
| Automations.GetEnrollment | GET /automations/{id}/enrollments/{enrollmentId} | automations:read |
| Automations.Enroll | POST /automations/{id}/enrollments | automations:write |
| Automations.ExitEnrollment | POST /automations/{id}/enrollments/{enrollmentId}/exit | automations:write |
| Events.Send | POST /events | contacts:write |
| Events.SendBatch | POST /events/batch | contacts:write |
| Events.ListNames | GET /events/names | automations:read |
| Broadcasts.Preview | POST /broadcasts/preview | audiences:read |
| Broadcasts.Send | POST /broadcasts | emails:send + audiences:read |
| Broadcasts.List | GET /broadcasts | emails:read |
| Broadcasts.ListAll | GET /broadcasts | emails:read |
| Broadcasts.Iterate | GET /broadcasts | emails:read |
| Broadcasts.Get | GET /broadcasts/{id} | emails:read |
| Broadcasts.Stats | GET /broadcasts/{id}/stats | emails:read |
| Broadcasts.Analytics | GET /broadcasts/analytics | emails:read |
| Broadcasts.ListRecipients | GET /broadcasts/{id}/recipients | emails:read |
| Broadcasts.ListAllRecipients | GET /broadcasts/{id}/recipients | emails:read |
| Broadcasts.IterateRecipients | GET /broadcasts/{id}/recipients | emails:read |
| Broadcasts.GetRecipient | GET /broadcasts/{id}/recipients/{emailId} | emails:read |
| Broadcasts.Cancel | POST /broadcasts/{id}/cancel | emails:send |
| Domains.List | GET /domains | domains:read |
| Domains.ListAll | GET /domains | domains:read |
| Domains.Iterate | GET /domains | domains:read |
| Domains.Get | GET /domains/{id} | domains:read |
| Domains.Create | POST /domains | domains:write |
| Domains.Verify | POST /domains/{id}/verify | domains:write |
| Domains.Update | PATCH /domains/{id} | domains:write |
| Domains.Delete | DELETE /domains/{id} | domains:write |
| Domains.GetLogo | GET /domains/{id}/logo | domains:read |
| Domains.SetLogo | PUT /domains/{id}/logo | domains:write |
| Domains.RemoveLogo | DELETE /domains/{id}/logo | domains:write |
| Domains.SetLogoCertificate | PUT /domains/{id}/logo/certificate | domains:write |
| Domains.RemoveLogoCertificate | DELETE /domains/{id}/logo/certificate | domains:write |
| Domains.ListAddresses | GET /domains/{id}/addresses | domains:read |
| Domains.ListAllAddresses | GET /domains/{id}/addresses | domains:read |
| Domains.IterateAddresses | GET /domains/{id}/addresses | domains:read |
| Domains.CreateAddress | POST /domains/{id}/addresses | domains:write |
| Domains.GetAddress | GET /domains/{id}/addresses/{addressId} | domains:read |
| Domains.UpdateAddress | PATCH /domains/{id}/addresses/{addressId} | domains:write |
| Domains.SetAddressPhoto | PUT /domains/{id}/addresses/{addressId}/photo | domains:write |
| Domains.RemoveAddressPhoto | DELETE /domains/{id}/addresses/{addressId}/photo | domains:write |
| Domains.DeleteAddress | DELETE /domains/{id}/addresses/{addressId} | domains:write |
| Domains.ListAddressForwards | GET /domains/{id}/addresses/{addressId}/forwards | domains:read |
| Domains.AddAddressForwards | POST /domains/{id}/addresses/{addressId}/forwards | domains:write |
| Domains.UpdateAddressForward | PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId} | domains:write |
| Domains.DeleteAddressForward | DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId} | domains:write |
| Domains.ResendAddressForwardConsent | POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resend | domains:write |
| Domains.ListAddressMembers | GET /domains/{id}/addresses/{addressId}/members | members:read |
| Domains.GetAddressLogin | GET /domains/{id}/addresses/{addressId}/login | members:write |
| Domains.SetAddressLogin | PUT /domains/{id}/addresses/{addressId}/login | members:write |
| Domains.DeleteAddressLogin | DELETE /domains/{id}/addresses/{addressId}/login | members:write |
| Domains.GetMailAppSettings | GET /domains/{id}/addresses/{addressId}/mail-apps | domains:read |
| Domains.UpdateMailAppSettings | PATCH /domains/{id}/addresses/{addressId}/mail-apps | domains:write |
| Domains.ListAppPasswords | GET /domains/{id}/addresses/{addressId}/app-passwords | members:write |
| Domains.CreateAppPassword | POST /domains/{id}/addresses/{addressId}/app-passwords | members:write |
| Domains.UpdateAppPassword | PATCH /domains/{id}/addresses/{addressId}/app-passwords/{passwordId} | members:write |
| Domains.DeleteAppPassword | DELETE /domains/{id}/addresses/{addressId}/app-passwords/{passwordId} | members:write |
| Domains.SendMailAppSetup | POST /domains/{id}/addresses/{addressId}/mail-app-setup | members:write |
| Domains.GetDNS | GET /domains/{id}/dns | domains:read |
| Domains.SetDNSZone | PUT /domains/{id}/dns | domains:write |
| Domains.SyncDNS | POST /domains/{id}/dns/sync | domains:write |
| AppHost.Get | GET /app-host | domains:read |
| AppHost.Set | PUT /app-host | domains:write |
| AppHost.Verify | POST /app-host/verify | domains:write |
| AppHost.Delete | DELETE /app-host | domains:write |
| Branding.Get | GET /branding | settings:read |
| Branding.Update | PATCH /branding | settings:write |
| Branding.UploadImage | PUT /branding/images/{variant} | settings:write |
| Branding.RemoveImage | DELETE /branding/images/{variant} | settings:write |
| Rules.List | GET /rules | rules:read |
| Rules.ListAll | GET /rules | rules:read |
| Rules.Iterate | GET /rules | rules:read |
| Rules.Get | GET /rules/{id} | rules:read |
| Rules.Create | POST /rules | rules:write |
| Rules.Update | PATCH /rules/{id} | rules:write |
| Rules.Delete | DELETE /rules/{id} | rules:write |
| Rules.Reorder | POST /rules/reorder | rules:write |
| Rules.Test | POST /rules/{id}/test | rules:read |
| Rules.ListRuns | GET /rules/runs | rules:read |
| Rules.ListAllRuns | GET /rules/runs | rules:read |
| Rules.IterateRuns | GET /rules/runs | rules:read |
| Webhooks.List | GET /webhooks | webhooks:read |
| Webhooks.ListAll | GET /webhooks | webhooks:read |
| Webhooks.Iterate | GET /webhooks | webhooks:read |
| Webhooks.Get | GET /webhooks/{id} | webhooks:read |
| Webhooks.Create | POST /webhooks | webhooks:write |
| Webhooks.Update | PATCH /webhooks/{id} | webhooks:write |
| Webhooks.Delete | DELETE /webhooks/{id} | webhooks:write |
| Webhooks.RotateSecret | POST /webhooks/{id}/rotate-secret | webhooks:write |
| Webhooks.Test | POST /webhooks/{id}/test | webhooks:write |
| Webhooks.ListDeliveries | GET /webhooks/{id}/deliveries | webhooks:read |
| Webhooks.ListAllDeliveries | GET /webhooks/{id}/deliveries | webhooks:read |
| Webhooks.IterateDeliveries | GET /webhooks/{id}/deliveries | webhooks:read |
| Webhooks.GetDelivery | GET /webhooks/{id}/deliveries/{deliveryId} | webhooks:read |
| Webhooks.ReplayDelivery | POST /webhooks/{id}/deliveries/{deliveryId}/replay | webhooks:write |
| Webhooks.ListWorkspaceDeliveries | GET /webhooks/deliveries | webhooks:read |
| Webhooks.ListAllWorkspaceDeliveries | GET /webhooks/deliveries | webhooks:read |
| Webhooks.IterateWorkspaceDeliveries | GET /webhooks/deliveries | webhooks:read |
| Webhooks.ListActivity | GET /webhooks/{id}/activity | webhooks:read |
| Webhooks.ListAllActivity | GET /webhooks/{id}/activity | webhooks:read |
| Webhooks.IterateActivity | GET /webhooks/{id}/activity | webhooks:read |
| Webhooks.ListWorkspaceActivity | GET /webhooks/activity | webhooks:read |
| Webhooks.ListAllWorkspaceActivity | GET /webhooks/activity | webhooks:read |
| Webhooks.IterateWorkspaceActivity | GET /webhooks/activity | webhooks:read |
| Webhooks.ListEvents | GET /webhooks/events | webhooks:read |
| Webhooks.Stats | GET /webhooks/stats | webhooks:read |
| Imports.List | GET /imports | threads:read |
| Imports.ListAll | GET /imports | threads:read |
| Imports.Iterate | GET /imports | threads:read |
| Imports.Get | GET /imports/{id} | threads:read |
| Imports.Create | POST /imports | threads:write |
| Imports.UploadState | GET /imports/{id}/upload | threads:write |
| Imports.UploadChunk | PUT /imports/{id}/files/{file}/chunks/{chunk} | threads:write |
| Imports.Start | POST /imports/{id}/start | threads:write |
| Imports.Cancel | POST /imports/{id}/cancel | threads:write |
| Imports.ListFailures | GET /imports/{id}/failures | threads:read |
| Imports.DeleteUpload | DELETE /imports/{id}/upload | threads:write |
| Imports.ImportFiles | POST /imports | threads:write |
| Imports.DiscoverMailbox | GET /imports/mailbox-settings | threads:write |
| Imports.CheckMailbox | POST /imports/mailbox/check | threads:write |
| Imports.ConnectMailbox | POST /imports/mailbox | threads:write |
| Imports.Resume | POST /imports/{id}/resume | threads:write |
| ProviderImports.Inspect | POST /provider-imports/inspect | settings:write |
| ProviderImports.Create | POST /provider-imports | settings:write |
| ProviderImports.List | GET /provider-imports | settings:read |
| ProviderImports.ListAll | GET /provider-imports | settings:read |
| ProviderImports.Iterate | GET /provider-imports | settings:read |
| ProviderImports.Get | GET /provider-imports/{id} | settings:read |
| ProviderImports.Cancel | POST /provider-imports/{id}/cancel | settings:write |
| Calendar.ListEvents | GET /calendar/events | calendar:read |
| Calendar.ListAllEvents | GET /calendar/events | calendar:read |
| Calendar.IterateEvents | GET /calendar/events | calendar:read |
| Calendar.GetEvent | GET /calendar/events/{id} | calendar:read |
| Calendar.GetEventIcs | GET /calendar/events/{id}/ics | calendar:read |
| Calendar.CreateEvent | POST /calendar/events | calendar:write |
| Calendar.UpdateEvent | PATCH /calendar/events/{id} | calendar:write |
| Calendar.DeleteEvent | DELETE /calendar/events/{id} | calendar:write |
| Calendar.CancelEvent | POST /calendar/events/{id}/cancel | calendar:write |
| Calendar.RespondToEvent | POST /calendar/events/{id}/respond | calendar:write + emails:send |
| Calendar.DeclineProposal | POST /calendar/events/{id}/decline-proposal | calendar:write + emails:send |
| Calendar.ListFeeds | GET /calendar/feeds | calendar:read |
| Calendar.CreateFeed | POST /calendar/feeds | calendar:write |
| Calendar.ResetFeed | POST /calendar/feeds/{id}/reset | calendar:write |
| Calendar.DeleteFeed | DELETE /calendar/feeds/{id} | calendar:write |
| Calendar.ListSubscriptions | GET /calendar/subscriptions | calendar:read |
| Calendar.CreateSubscription | POST /calendar/subscriptions | calendar:write |
| Calendar.UpdateSubscription | PATCH /calendar/subscriptions/{id} | calendar:write |
| Calendar.RefreshSubscription | POST /calendar/subscriptions/{id}/refresh | calendar:write |
| Calendar.DeleteSubscription | DELETE /calendar/subscriptions/{id} | calendar:write |
| Calendar.ImportIcs | POST /calendar/imports | calendar:write |
| Calendar.ListImports | GET /calendar/imports | calendar:read |
| Calendar.ListAllImports | GET /calendar/imports | calendar:read |
| Calendar.IterateImports | GET /calendar/imports | calendar:read |
| Calendar.GetImport | GET /calendar/imports/{id} | calendar:read |
| Calendar.UndoImport | POST /calendar/imports/{id}/undo | calendar:write |
| Settings.Get | GET /settings | settings:read |
| Settings.Update | PATCH /settings | settings:write |
| OutOfOffice.List | GET /out-of-office | settings:read |
| OutOfOffice.Set | PUT /out-of-office | settings:write |
| OutOfOffice.Clear | DELETE /out-of-office | settings:write |
| Roles.List | GET /roles | roles:read |
| Roles.ListAll | GET /roles | roles:read |
| Roles.Iterate | GET /roles | roles:read |
| Roles.Get | GET /roles/{id} | roles:read |
| Roles.Create | POST /roles | roles:write |
| Roles.Update | PATCH /roles/{id} | roles:write |
| Roles.Delete | DELETE /roles/{id} | roles:write |
| Roles.ListPermissions | GET /roles/permissions | roles:read |
| Members.List | GET /members | members:read |
| Members.ListAll | GET /members | members:read |
| Members.Iterate | GET /members | members:read |
| Members.Get | GET /members/{userId} | members:read |
| Members.Add | POST /members | members:write |
| Members.Update | PATCH /members/{userId} | members:write |
| Members.Remove | DELETE /members/{userId} | members:write |
| Members.GrantAddress | POST /members/{userId}/addresses | members:write |
| Members.RevokeAddress | DELETE /members/{userId}/addresses/{addressId} | members:write |
| Members.GrantDomain | POST /members/{userId}/domains | members:write |
| Members.RevokeDomain | DELETE /members/{userId}/domains/{domainId} | members:write |
| Members.ListInvitations | GET /members/invitations | members:read |
| Members.ListAllInvitations | GET /members/invitations | members:read |
| Members.IterateInvitations | GET /members/invitations | members:read |
| Members.RevokeInvitation | DELETE /members/invitations/{invitationId} | members:write |
| Members.ResendInvitation | POST /members/invitations/{invitationId}/resend | members:write |
| Suppressions.List | GET /suppressions | settings:read |
| Suppressions.ListAll | GET /suppressions | settings:read |
| Suppressions.Iterate | GET /suppressions | settings:read |
| Suppressions.Get | GET /suppressions/{id} | settings:read |
| Suppressions.Add | POST /suppressions | settings:write |
| Suppressions.Remove | DELETE /suppressions/{id} | settings:write |
| Sending.ListStreams | GET /sending/streams | emails:read |
| Sending.ResumeStream | POST /sending/streams/{stream}/resume | domains:write |
| Sending.ListDedicatedIPs | GET /sending/dedicated-ips | domains:read |
| Sending.GetDedicatedIP | GET /sending/dedicated-ips/{ip} | domains:read |
| Files.List | GET /files | files:read |
| Files.ListAll | GET /files | files:read |
| Files.Iterate | GET /files | files:read |
| Files.Get | GET /files/{id} | files:read |
| Files.Stats | GET /files/stats | files:read |
| Files.Download | GET /files/{id}/content | files:read |
| Files.ListLinks | GET /files/{id}/links | files:read |
| Files.ListAllLinks | GET /files/{id}/links | files:read |
| Files.IterateLinks | GET /files/{id}/links | files:read |
| Files.CreateLink | POST /files/{id}/links | files:write |
| Files.RevokeLink | DELETE /files/{id}/links/{linkId} | files:write |
| Files.RevokeAllLinks | DELETE /files/{id}/links | files:write |
| Files.Upload | POST /files | files:write |
| Files.Delete | DELETE /files/{id} | files:write |
| Files.DeleteMany | POST /files/batch-delete | files:write |
| Knowledge.List | GET /knowledge | knowledge:read |
| Knowledge.ListAll | GET /knowledge | knowledge:read |
| Knowledge.Iterate | GET /knowledge | knowledge:read |
| Knowledge.Levels | GET /knowledge/levels | knowledge:read |
| Knowledge.Usage | GET /knowledge/usage | knowledge:read |
| Knowledge.Search | POST /knowledge/search | knowledge:read |
| Knowledge.CreateNote | POST /knowledge/notes | knowledge:write |
| Knowledge.AddLink | POST /knowledge/links | knowledge:write |
| Knowledge.UploadFile | POST /knowledge/files | knowledge:write |
| Knowledge.Get | GET /knowledge/{id} | knowledge:read |
| Knowledge.Update | PATCH /knowledge/{id} | knowledge:write |
| Knowledge.Delete | DELETE /knowledge/{id} | knowledge:write |
| Knowledge.Refresh | POST /knowledge/{id}/refresh | knowledge:write |
| Knowledge.Stats | GET /knowledge/stats | knowledge:read |
| Knowledge.ListSuggestions | GET /knowledge/suggestions | knowledge:read |
| Knowledge.ListAllSuggestions | GET /knowledge/suggestions | knowledge:read |
| Knowledge.IterateSuggestions | GET /knowledge/suggestions | knowledge:read |
| Knowledge.AcceptSuggestion | POST /knowledge/suggestions/{id}/accept | knowledge:write |
| Knowledge.DismissSuggestion | POST /knowledge/suggestions/{id}/dismiss | knowledge:write |
| Knowledge.ListFlags | GET /knowledge/flags | knowledge:read |
| Knowledge.DismissFlag | POST /knowledge/flags/{id}/dismiss | knowledge:write |
| Knowledge.ListConnectors | GET /knowledge/connectors | knowledge:read |
| Knowledge.AddConnector | POST /knowledge/connectors | knowledge:write |
| Knowledge.GetConnector | GET /knowledge/connectors/{id} | knowledge:read |
| Knowledge.UpdateConnector | PATCH /knowledge/connectors/{id} | knowledge:write |
| Knowledge.DeleteConnector | DELETE /knowledge/connectors/{id} | knowledge:write |
| Knowledge.SyncConnector | POST /knowledge/connectors/{id}/sync | knowledge:write |
| Knowledge.DraftFromThread | POST /knowledge/drafts | knowledge:write + threads:read |
| TempMail.ListDomains | GET /temp-mail/domains | Sem credencial |
| TempMail.Create | POST /temp-mail/inboxes | Sem credencial |
| TempMail.Get | GET /temp-mail/inboxes/{id} | Token da caixa de entrada |
| TempMail.Extend | POST /temp-mail/inboxes/{id}/extend | Token da caixa de entrada |
| TempMail.Delete | DELETE /temp-mail/inboxes/{id} | Token da caixa de entrada |
| TempMail.ListMessages | GET /temp-mail/inboxes/{id}/messages | Token da caixa de entrada |
| TempMail.ListAllMessages | GET /temp-mail/inboxes/{id}/messages | Token da caixa de entrada |
| TempMail.IterateMessages | GET /temp-mail/inboxes/{id}/messages | Token da caixa de entrada |
| TempMail.GetMessage | GET /temp-mail/inboxes/{id}/messages/{messageId} | Token da caixa de entrada |
| TempMail.DeleteMessage | DELETE /temp-mail/inboxes/{id}/messages/{messageId} | Token da caixa de entrada |
| TempMail.ListAttachments | GET /temp-mail/inboxes/{id}/messages/{messageId}/attachments | Token da caixa de entrada |
| Tools.CheckDmarc | GET /tools/dmarc | Sem âmbito |
| Tools.CheckBimi | GET /tools/bimi | Sem âmbito |
| Tools.CheckDeliverability | GET /tools/deliverability | Sem âmbito |
| Tools.ReadVerificationCode | POST /tools/verification-code | Sem âmbito |
| Tools.EstimateCost | GET /tools/cost | Sem âmbito |
| Tools.CheckAddress | GET /tools/address | Sem âmbito |
| Tools.CheckAddresses | POST /tools/addresses | Sem âmbito |
| Support.Send | POST /support | Sem âmbito |
| Encryption.ListKeys | GET /encryption/keys | emails:read |
| Encryption.PublishKey | POST /encryption/keys | emails:read |
| Encryption.LookupKeys | GET /encryption/keys/lookup | emails:send |
| Senders.Get | GET /senders/{email} | threads:read |
| Senders.Research | POST /senders/{email}/research | threads:read |
| Chats.List | GET /chats | threads:read |
| Chats.ListAll | GET /chats | threads:read |
| Chats.Iterate | GET /chats | threads: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/mailbox | threads:read |
| Analytics.Sending | GET /analytics/sending | emails:read |
| Subscriptions.List | GET /subscriptions | threads:read |
| Subscriptions.ListDomains | GET /subscriptions/domains | threads:read |
| Subscriptions.Unsubscribe | POST /subscriptions/{id}/unsubscribe | threads:write |
| Subscriptions.UnsubscribeDomain | POST /subscriptions/domains/{domain}/unsubscribe | threads:write |
| Subscriptions.Move | POST /subscriptions/{id}/move | threads:write |
| Exports.Preview | GET /exports/preview | threads:read |
| Exports.List | GET /exports | threads:read |
| Exports.Get | GET /exports/{id} | threads:read |
| Exports.Start | POST /exports | threads:read |
| Exports.Download | GET /exports/{id}/content | threads:read |
| DNSConnections.List | GET /dns-connections | domains:read |
| DNSConnections.Get | GET /dns-connections/{id} | domains:read |
| DNSConnections.Delete | DELETE /dns-connections/{id} | domains:write |
| Billing.Get | GET /billing | billing:read |
| Billing.ListPlans | GET /billing/plans | billing:read |
| Billing.GetUsage | GET /billing/usage | billing:read |
| Billing.ListAlerts | GET /billing/alerts | billing:read |
| Billing.ListCountries | GET /billing/countries | billing:read |
| Billing.GetPayAsYouGo | GET /billing/pay-as-you-go | billing:read |
| Billing.SetPayAsYouGo | PATCH /billing/pay-as-you-go | billing:write |
| Billing.SetPayAsYouGoLimit | PUT /billing/pay-as-you-go/limit | billing:write |
| Billing.ConfirmPayAsYouGo | POST /billing/pay-as-you-go/confirm | billing:write |
| Billing.StartCheckout | POST /billing/checkout | billing:write |
| Billing.OpenPortal | POST /billing/portal | billing:write |
| Billing.ListInvoices | GET /billing/invoices | billing:read |
| Billing.GetInvoice | GET /billing/invoices/{orderId} | billing:read |
| Billing.SaveInvoiceDetails | PUT /billing/invoices/{orderId}/details | billing:write |
| Billing.ListAddOns | GET /billing/add-ons | billing:read |
| Billing.StartAddOnCheckout | POST /billing/add-ons/checkout | billing:write |
| Billing.CancelAddOn | DELETE /billing/add-ons/{addOn} | billing:write |
| Workspaces.List | GET /workspaces | account:read |
| Workspaces.Create | POST /workspaces | account:write |
| Workspaces.GetActive | GET /workspaces/active | account:read |
| Workspaces.SetActive | PUT /workspaces/active | account:write |
| Workspaces.Delete | DELETE /workspaces/{id} | account:write |
| Account.GetNotifications | GET /account/notifications | account:read |
| Account.SetEmailNotification | PUT /account/notifications/email/{category} | account:write |
| Account.SetPushMuted | PUT /account/notifications/push/{workspaceId} | account:write |
| Account.SetPhoto | PUT /account/photo | account:write |
| Account.RemovePhoto | DELETE /account/photo | account:write |
| Account.GetUsername | GET /account/username | account:read |
| Account.CheckUsername | GET /account/username/availability | account:read |
| Account.SetUsername | PUT /account/username | account:write |
| Account.ListConnectedApps | GET /account/connected-apps | account:read |
| Account.RevokeConnectedApp | DELETE /account/connected-apps/{clientId} | account:write |
| Account.ListInvitations | GET /account/invitations | account:read |
| Account.AcceptInvitation | POST /account/invitations/{invitationId}/accept | account:write |
| Account.DeclineInvitation | POST /account/invitations/{invitationId}/decline | account:write |