WoyraDocs
Get an API key

API reference

152 endpoints under https://api.woyra.io/v1, generated from the OpenAPI description the server is tested against. An endpoint missing here is an endpoint that fails the build.

Countries

Country endpoints, billing currencies and messaging rules.

GET/v1/productsWhat this deployment sells
GET/v1/countriesList country endpoints
GET/v1/countries/{code}Retrieve a country
GET/v1/statusWhether Woyra is working

Accounts

Account creation and identity.

POST/v1/accountsCreate an account
GET/v1/accountDescribe the calling account

Messages

Send and inspect SMS.

POST/v1/dlr/{carrier}/{secret}Carrier delivery receipt

Emails

Send and inspect email.

GET/v1/emailsList emails
POST/v1/emailsSend an email
GET/v1/emails/{id}Retrieve an email
POST/v1/emails/{id}/cancelCancel a scheduled email
POST/v1/emails/batchSend a batch of emails
GET/v1/templatesList templates
POST/v1/templatesSave an email template
GET/v1/templates/{id}Retrieve a template
PATCH/v1/templates/{id}Change a template
DELETE/v1/templates/{id}Delete a template
GET/t/o/{token}Open tracking image
GET/t/c/{token}Click tracking redirect
GET/v1/emails/inboundMail received on your domains
GET/v1/emails/inbound/{id}Retrieve a received email
GET/v1/emails/inbound/{id}/attachments/{attachment_id}Download an attachment
GET/v1/emails/threads/{id}A conversation

Domains

Sending domains, DKIM keys and DNS verification.

GET/v1/domainsList sending domains
POST/v1/domainsAdd a sending domain
POST/v1/domains/{id}/verifyVerify a domain's DNS
DELETE/v1/domains/{id}Remove a sending domain

Mailboxes

Woyra Mail mailboxes and aliases on a verified domain.

GET/v1/mailboxesList mailboxes
POST/v1/mailboxesCreate a mailbox
GET/v1/mailboxes/{id}Get a mailbox
PATCH/v1/mailboxes/{id}Change a mailbox's quota, suspension or password
DELETE/v1/mailboxes/{id}Delete a mailbox and its mail
GET/v1/mailboxes/usageUsage per mailbox for a period
GET/v1/mailboxes/{id}/messagesList the messages in a folder
GET/v1/mailboxes/{id}/messages/{message_id}Read a message
GET/v1/mailboxes/{id}/messages/{message_id}/attachments/{attachment_id}Download an attachment by signed link
POST/v1/mailboxes/{id}/messages/flagsMark messages read, unread, flagged or unflagged
POST/v1/mailboxes/{id}/messages/moveMove messages to another folder
POST/v1/mailboxes/{id}/messages/deleteDelete messages for good
GET/v1/mailboxes/{id}/changesWhat changed in a mailbox since a cursor
POST/v1/mailboxes/{id}/sendSend a message from a mailbox
GET/v1/mailboxes/{id}/profileA mailbox's profile
PATCH/v1/mailboxes/{id}/profileChange a mailbox's display name, letterhead or signature
PUT/v1/mailboxes/{id}/profile/pictureSet a mailbox's picture
GET/v1/mailboxes/sending_limitsWhat the account may send today, and why
POST/v1/mail/auth/tokenGet a mailbox token for Woyra Mail's apps
POST/v1/mail/devicesRegister this native device for mailbox notifications
DELETE/v1/mail/devicesRemove a push destination belonging to this device session
POST/v1/mail/auth/refreshRotate a mailbox device session
POST/v1/mail/auth/revokeRevoke this mailbox device session
GET/v1/mail/sync/changesWhat changed in the mailbox since a cursor
GET/v1/mail/sync/messagesSeveral messages at once
GET/v1/mail/messagesA folder's messages, newest first
GET/v1/mail/searchSearch the whole mailbox, newest first
GET/v1/mail/rulesThe mailbox's rules and blocked senders
POST/v1/mail/rulesAdd a rule, or block a sender
DELETE/v1/mail/rules/{id}Remove a rule, or unblock a sender
GET/v1/mail/autoreplyThe out-of-office reply
PUT/v1/mail/autoreplySet the out-of-office reply
POST/v1/mail/messages/{id}/unsubscribeLeave the list a message came from
POST/v1/mail/messages/{id}/cancel-sendCall back a message sent for later
POST/v1/mail/messages/sendSend from the token's mailbox
GET/v1/mail/profileThe token's mailbox profile
PATCH/v1/mail/profileChange the display name, letterhead or signature
PUT/v1/mail/profile/pictureSet the mailbox's picture
DELETE/v1/mail/profile/pictureRemove the mailbox's picture
PUT/v1/mail/profile/letterhead-imageSet the picture at the head of the letterhead
DELETE/v1/mail/profile/letterhead-imageRemove the letterhead picture
GET/v1/mail/letterheads/{id}A mailbox's letterhead picture, by signed link
GET/v1/mail/avatarsPictures, names and company logos for the addresses a client shows
GET/v1/mail/logos/{domain}A company's logo, by signed link
GET/v1/mail/pictures/{id}A mailbox's picture, by signed link
GET/v1/mail/messages/{id}One message with its body, marking it read
PATCH/v1/mail/messages/{id}Mark a message read or unread, star it, or file it in another folder
GET/v1/mail/messages/{id}/attachments/{attachment_id}A short-lived link to one attachment
GET/v1/mail/unreadHow many messages in INBOX are unread
GET/v1/aliasesList aliases
POST/v1/aliasesCreate or repoint an alias
DELETE/v1/aliases/{id}Delete an alias

Suppressions

Recipients this account will not send to.

GET/v1/suppressionsList suppressed recipients
POST/v1/suppressionsSuppress a recipient
DELETE/v1/suppressions/{recipient}Unsuppress a recipient

Webhooks

Endpoint registration for outbound events.

GET/v1/webhook_endpointsList webhook endpoints
POST/v1/webhook_endpointsRegister a webhook endpoint
DELETE/v1/webhook_endpoints/{id}Remove a webhook endpoint
GET/v1/webhook_deliveriesList webhook deliveries
GET/v1/webhook_deliveries/{id}Inspect one delivery
POST/v1/webhook_deliveries/{id}/replaySend a delivery again
POST/v1/webhook_endpoints/{id}/releaseTake an endpoint out of quarantine

API keys

Minting, listing and revoking API keys.

GET/v1/api_keysList API keys
POST/v1/api_keysMint an API key
DELETE/v1/api_keys/{id}Revoke an API key

Billing

Balance, top-ups and the account statement.

POST/v1/topupsAdd funds by card
GET/v1/topups/{id}One top-up
POST/v1/subscriptionsStart a product subscription
GET/v1/subscriptions/{product}Current product subscription
POST/v1/payments/stripe/webhookStripe's webhook
GET/v1/ledgerThe account statement
GET/v1/billing/payment_optionsHow this account can pay
PUT/v1/billing/payment_currencyChoose to pay in birr or in US dollars
GET/v1/billing/bank_depositsRecent birr bank deposits
POST/v1/billing/bank_depositsRequest a birr bank deposit
POST/v1/billing/bank_deposits/{id}/receiptUpload the bank receipt for a deposit
POST/v1/billing/bank_deposits/{id}/cancelCancel a deposit that has not been submitted or was returned
GET/v1/balanceRetrieve account balance
GET/v1/billing/email_tariffThe email price this account pays
GET/v1/billing/email_subscriptionThis account's monthly email plan
PUT/v1/billing/email_subscriptionTake an email plan, or change it
POST/v1/billing/email_subscription/cancelStop the email plan renewing
GET/v1/pricing/emailThe published email tariff

Console

Session authentication, two-factor, the dashboard and the audit trail.

POST/v1/auth/signupCreate an account and sign in
POST/v1/auth/loginSign in with email and password
POST/v1/auth/logoutEnd the session
GET/v1/auth/configWhat a sign-in page needs before anyone signs in
GET/v1/auth/meThe signed-in user, account and MFA state
POST/v1/auth/mfa/verifyFinish signing in with a TOTP code or a recovery code
POST/v1/auth/passkeys/login/beginStart signing in with a passkey
POST/v1/auth/passkeys/login/finishFinish signing in with a passkey
GET/v1/auth/passkeysThe signed-in user's passkeys
POST/v1/auth/passkeys/register/beginStart adding a passkey
POST/v1/auth/passkeys/register/finishFinish adding a passkey
DELETE/v1/auth/passkeys/{id}Remove a passkey
POST/v1/auth/recovery_codesMake a fresh set of recovery codes
POST/v1/auth/mfa/enrolStart TOTP enrolment
POST/v1/auth/mfa/confirmConfirm TOTP enrolment with a code
DELETE/v1/auth/mfaDisable TOTP
POST/v1/auth/verify-emailConfirm an email address from its link
POST/v1/auth/resend-verificationSend the verification email again
POST/v1/auth/forgot-passwordRequest a password reset link
POST/v1/auth/reset-passwordSet a new password from a reset link
POST/v1/auth/change-passwordChange the password while signed in
GET/v1/auth/invites/{token}Describe an invitation before accepting it
POST/v1/auth/invites/acceptAccept an invitation and sign in
GET/v1/console/overviewDashboard counts
GET/v1/console/analyticsDaily series and the route view
GET/v1/console/streamLive message events
GET/v1/audit_eventsThe account's audit trail

Team

Members, roles and invitations.

GET/v1/team/membersList the team
PATCH/v1/team/members/{id}Change a member's role
DELETE/v1/team/members/{id}Remove a member
GET/v1/team/invitesList pending invitations
POST/v1/team/invitesInvite someone by email
DELETE/v1/team/invites/{id}Cancel an invitation

Waitlist

Interest from markets that are not open yet.

POST/v1/waitlistJoin the waitlist for a market that is not open yet

Health

Liveness and readiness. No authentication.

GET/healthLiveness
GET/readyReadiness

Mail

GET/v1/mail/addressesThe addresses this mailbox can send as

Email

GET/v1/dedicated_ipsThe account's dedicated sending IP
POST/v1/dedicated_ipsRequest a dedicated sending IP
DELETE/v1/dedicated_ips/{id}Release a dedicated IP

Numbers

POST/v1/inbound/{provider}/{secret}A provider's inbound-SMS webhook

Voice

POST/v1/voice/{provider}/{secret}A voice provider's event webhook