Skip to content

API reference

Sendwing’s REST API: contacts, tags, mailing lists, events and webhooks.

Every request is JSON over HTTPS, to https://api.sendwing.app/api. Most routes act in one workspace, named in the path as /organizations/{organizationId}.

Authentication

Send one of these:

  • An API key, in the x-api-key header. Create one in Sendwing under Settings → API keys. A key belongs to one workspace and has the permissions picked when it was made.
  • An OAuth 2.0 access token, as Authorization: Bearer <token>. Apps get one when a member connects them (“Connect with Sendwing”), using the authorization code flow with PKCE. The token acts in the workspace the member picked, with what both its scopes and the member’s role allow. Access tokens last an hour; ask for the offline_access scope to get a refresh token, which lasts 90 days and is replaced each time it’s used. The authorization server’s metadata is at https://api.sendwing.app/.well-known/oauth-authorization-server/api/auth. OAuth apps are registered by Sendwing: contact support to get a client ID.

Versions

Responses are shaped by an API version, a date like 2026-10-27 (the latest). Send it in the Sendwing-Version header to pin your integration to it; without the header, a request uses its API key’s version, else the latest. Every response says its version in the same header. Old versions get Deprecation and Sunset headers at least six months before they’re removed.

Errors

Errors answer with an HTTP status and a JSON body like { "error": "Contact not found" }. A 400 also lists each invalid field in issues, and a 5xx has a requestId to quote to support. A 429 says how many seconds to wait in Retry-After.

Lists

Lists are newest first and paginated by cursor: pass limit (1 to 100, 50 by default), then the response’s nextCursor as cursor for the next page, until it’s null.

Webhooks

Register an endpoint with POST /organizations/{organizationId}/webhooks/endpoints to get events as they happen. Each delivery is a POST with the event as its JSON body, in the same shape GET …/webhooks/events lists, signed with the endpoint’s secret. Failed deliveries are retried, and events are kept for 30 days.

Security scheme type: apiKey

Header parameter name: x-api-key

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://app.sendwing.app/core/api/auth/oauth2/authorize

Token URL: https://api.sendwing.app/api/auth/oauth2/token

Refresh URL: https://api.sendwing.app/api/auth/oauth2/token

Scopes:

  • contacts:read - Read contacts, their custom properties, tags, mailing lists and segments
  • contacts:write - Add and change contacts: their fields, tags (new ones too), lists, subscription and events
  • contacts:delete - Delete contacts, and every record of them
  • audience:write - Create, change and delete custom properties, tags, mailing lists and segments
  • templates:read - Read email templates
  • templates:write - Create, change and delete email templates
  • campaigns:read - Read campaigns
  • campaigns:write - Create, change and delete campaign drafts, without sending them
  • campaigns:send - Send, schedule and cancel campaigns, and send test emails
  • workflows:read - Read workflows
  • workflows:write - Create, change and archive workflows, without publishing them
  • workflows:publish - Publish, pause and resume workflows, and enroll contacts
  • emails:send - Send one-off emails to any address with the emails API, and see what became of them
  • domains:read - Read sending domains and the sending settings
  • domains:write - Add, check and remove sending domains
  • webhooks - Create, read and delete webhook endpoints, and read webhook events
  • offline_access - Get a refresh token, to stay connected after the access token expires