{"info":{"name":"CloudSend REST API Collection","description":"Official Postman Collection for CloudSend Audience CRM, Email Outreach, File Transfers & MCP API.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"variable":[{"key":"baseUrl","value":"https://cloudsend.n3tw0rk.co.uk","type":"string"},{"key":"token","value":"","type":"string"},{"key":"accountId","value":"","type":"string"}],"item":[{"name":"System","description":"Platform health and service status","item":[{"name":"GET Health check and platform status","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/health","host":["{{baseUrl}}"],"path":["api","health"]},"description":"Returns the health status of CloudSend services, current version, and outbound email maintenance status."}}]},{"name":"Auth","description":"User authentication and session tokens","item":[{"name":"POST Register new user","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\",\n  \"name\": \"Jane Doe\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/auth/register","host":["{{baseUrl}}"],"path":["api","auth","register"]},"description":"Registers a new user account and automatically initializes their primary workspace."}},{"name":"POST Confirm user registration","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"user@example.com\",\n  \"code\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/auth/confirm","host":["{{baseUrl}}"],"path":["api","auth","confirm"]},"description":"Confirms a newly registered user account using the 6-digit verification code sent via email."}},{"name":"POST Authenticate and obtain JWT Bearer token","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/auth/login","host":["{{baseUrl}}"],"path":["api","auth","login"]},"description":"Validates user credentials and issues a Bearer JWT token required for authenticated operations."}}]},{"name":"Accounts","description":"Tenant workspace account discovery and membership","item":[{"name":"GET List accessible workspace accounts","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"url":{"raw":"{{baseUrl}}/api/accounts","host":["{{baseUrl}}"],"path":["api","accounts"]},"description":"Returns all workspace accounts the authenticated user belongs to. The returned `accountId` must be supplied in subsequent `X-Account-Id` headers."}},{"name":"POST Create a new workspace account","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Marketing Workspace\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/accounts","host":["{{baseUrl}}"],"path":["api","accounts"]},"description":"Creates a new workspace account isolated with blank-slate transfers and registers the calling user as the account owner."}},{"name":"GET List account team members","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/accounts/members","host":["{{baseUrl}}"],"path":["api","accounts","members"]},"description":"Returns all members and pending invitations for the workspace specified by X-Account-Id."}},{"name":"POST Invite or add user to workspace account","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"colleague@example.com\",\n  \"role\": \"member\",\n  \"name\": \"Alex Smith\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/accounts/members","host":["{{baseUrl}}"],"path":["api","accounts","members"]},"description":"Invites a user by email to join the workspace with a specified role (owner, admin, or member). If the user is already registered, they are immediately granted access; otherwise, an invitation is recorded and resolved on signup."}},{"name":"PATCH Update member role","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"sub\": \"\",\n  \"email\": \"\",\n  \"role\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/accounts/members","host":["{{baseUrl}}"],"path":["api","accounts","members"]},"description":"Updates a workspace member role. Requires owner or admin permissions. Owners cannot be demoted if they are the sole owner."}},{"name":"DELETE Remove user or cancel invite","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"sub\": \"\",\n  \"email\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/accounts/members","host":["{{baseUrl}}"],"path":["api","accounts","members"]},"description":"Removes a user from the workspace or cancels a pending invite. Sole owner cannot be removed."}}]},{"name":"Transfers","description":"Ephemeral encrypted package sharing and downloads","item":[{"name":"GET List workspace file transfers","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/transfers","host":["{{baseUrl}}"],"path":["api","transfers"]},"description":"Lists all active, expired, or exhausted ephemeral file packages in the workspace."}},{"name":"POST Create ephemeral file transfer package","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/transfers","host":["{{baseUrl}}"],"path":["api","transfers"]},"description":"Creates a new short-lived, encrypted file package with configurable expiration (up to 7 days) and download limits."}},{"name":"DELETE Delete transfer package","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/transfers/{id}","host":["{{baseUrl}}"],"path":["api","transfers",":id"]},"description":"Permanently removes a transfer package and invalidates its public download token."}},{"name":"GET Public recipient transfer lookup","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/share/{shareToken}","host":["{{baseUrl}}"],"path":["api","share",":shareToken"]},"description":"Allows unauthenticated recipients to look up transfer package metadata prior to downloading."}},{"name":"POST Record recipient download","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/share/{shareToken}/download","host":["{{baseUrl}}"],"path":["api","share",":shareToken","download"]},"description":"Records a successful download for the transfer package, decrementing remaining downloads."}}]},{"name":"CRM Targets","description":"Contact management, attributes, mail groups, and GDPR consent","item":[{"name":"GET List & filter contacts","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/targets","host":["{{baseUrl}}"],"path":["api","crm","targets"]},"description":"Lists all contacts in the CRM workspace with flexible attribute filtering, search, group matching, and GDPR marketing status filters."}},{"name":"POST Add or upsert contact","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/targets","host":["{{baseUrl}}"],"path":["api","crm","targets"]},"description":"Creates a new contact or updates an existing contact by email address. Encrypted under AES-256-GCM with tenant-bound AAD."}},{"name":"GET Get single contact","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/targets/{id}","host":["{{baseUrl}}"],"path":["api","crm","targets",":id"]},"description":"Get single contact"}},{"name":"PUT Update contact profile","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"attributes\": {},\n  \"replace\": false,\n  \"mailGroups\": {},\n  \"gdprLawfulBasis\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/targets/{id}","host":["{{baseUrl}}"],"path":["api","crm","targets",":id"]},"description":"Update contact profile"}},{"name":"DELETE Delete contact (GDPR Art. 17 Erasure)","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/targets/{id}","host":["{{baseUrl}}"],"path":["api","crm","targets",":id"]},"description":"Permanently removes the contact and anonymizes their email address in historical delivery logs in compliance with GDPR Article 17."}},{"name":"GET Get marketing preferences","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/targets/{id}/preferences","host":["{{baseUrl}}"],"path":["api","crm","targets",":id","preferences"]},"description":"Get marketing preferences"}},{"name":"PUT Update marketing preferences","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"marketingStatus\": \"\",\n  \"mailGroups\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/targets/{id}/preferences","host":["{{baseUrl}}"],"path":["api","crm","targets",":id","preferences"]},"description":"Update marketing preferences"}}]},{"name":"CRM Templates","description":"Email template editor, variable tags, and free starter templates","item":[{"name":"GET List built-in free starter templates","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/crm/templates/free","host":["{{baseUrl}}"],"path":["api","crm","templates","free"]},"description":"Returns the catalog of ready-to-use, professionally crafted starter templates available to all workspaces."}},{"name":"GET List all workspace templates","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/templates","host":["{{baseUrl}}"],"path":["api","crm","templates"]},"description":"Returns all custom saved templates for the workspace along with unlocked free starter templates."}},{"name":"POST Create custom email template","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/templates","host":["{{baseUrl}}"],"path":["api","crm","templates"]},"description":"Creates a custom HTML/text template with dynamic mustache placeholder tags (e.g. {{firstName}}, {{company}})."}},{"name":"GET Get single template","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/templates/{id}","host":["{{baseUrl}}"],"path":["api","crm","templates",":id"]},"description":"Get single template"}},{"name":"PUT Update template","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/templates/{id}","host":["{{baseUrl}}"],"path":["api","crm","templates",":id"]},"description":"Update template"}},{"name":"DELETE Delete custom template","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/templates/{id}","host":["{{baseUrl}}"],"path":["api","crm","templates",":id"]},"description":"Delete custom template"}}]},{"name":"CRM Campaigns","description":"Campaign drafts, preview interpolation, and live email dispatch","item":[{"name":"GET List campaigns","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/campaigns","host":["{{baseUrl}}"],"path":["api","crm","campaigns"]},"description":"Returns all saved campaign drafts, scheduled campaigns, and historical dispatches."}},{"name":"POST Save or schedule campaign draft","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/campaigns","host":["{{baseUrl}}"],"path":["api","crm","campaigns"]},"description":"Save or schedule campaign draft"}},{"name":"GET List scheduled campaigns","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/campaigns/scheduled","host":["{{baseUrl}}"],"path":["api","crm","campaigns","scheduled"]},"description":"Returns upcoming scheduled campaigns for the workspace sorted by scheduledAt ascending."}},{"name":"POST Process due scheduled campaigns for workspace","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/campaigns/scheduled/process","host":["{{baseUrl}}"],"path":["api","crm","campaigns","scheduled","process"]},"description":"Immediately checks and dispatches any scheduled campaigns in the workspace whose scheduledAt timestamp has passed."}},{"name":"POST Schedule or reschedule a campaign send","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/campaigns/{campaignId}/schedule","host":["{{baseUrl}}"],"path":["api","crm","campaigns",":campaignId","schedule"]},"description":"Schedules a draft, new, or existing campaign for automated future dispatch at scheduledAt via EventBridge and SQS."}},{"name":"POST Cancel a scheduled campaign send","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/campaigns/{campaignId}/unschedule","host":["{{baseUrl}}"],"path":["api","crm","campaigns",":campaignId","unschedule"]},"description":"Cancels the scheduled send and reverts the campaign back to draft status."}},{"name":"POST Immediately dispatch a saved or scheduled campaign","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/campaigns/{campaignId}/send-now","host":["{{baseUrl}}"],"path":["api","crm","campaigns",":campaignId","send-now"]},"description":"Clears any pending schedule and immediately queues or dispatches the saved campaign."}},{"name":"POST Dry-run preview campaign rendering","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/preview","host":["{{baseUrl}}"],"path":["api","crm","preview"]},"description":"Renders the campaign template with dynamic audience variables and evaluates segmentation filters without sending any emails or consuming quotas."}},{"name":"POST Dispatch live outreach campaign via AWS SES","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/send","host":["{{baseUrl}}"],"path":["api","crm","send"]},"description":"Sends personalized emails to all matched contacts. Strictly suppresses unsubscribed contacts, injects GDPR one-click unsubscribe links and engagement tracking pixels, and checks hourly rate limits and global maintenance kill-switches."}},{"name":"GET Get outbound email rate limit status","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/quota","host":["{{baseUrl}}"],"path":["api","crm","quota"]},"description":"Returns the current hourly and daily send counts, remaining email allowance, and rolling window reset time."}},{"name":"GET Get account Emergency Stop & active send status","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/send-control","host":["{{baseUrl}}"],"path":["api","crm","send-control"]},"description":"Returns whether outbound sends are paused for the account along with active, queued, and paused dispatch summaries."}},{"name":"POST Activate Emergency Stop (pause all active sends)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/send-control/emergency-stop","host":["{{baseUrl}}"],"path":["api","crm","send-control","emergency-stop"]},"description":"Immediately pauses all queued, processing, and scheduled sends for the specified account and blocks new dispatches until resumed."}},{"name":"POST Resume paused sends for account","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/send-control/resume","host":["{{baseUrl}}"],"path":["api","crm","send-control","resume"]},"description":"Deactivates Emergency Stop for the account and re-queues all paused sends."}},{"name":"POST Clear all active and paused sends for account","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/send-control/clear","host":["{{baseUrl}}"],"path":["api","crm","send-control","clear"]},"description":"Permanently cancels all queued, processing, paused, and scheduled sends for the account and purges parked queue jobs."}}]},{"name":"CRM Engagement","description":"Open tracking pixels, click redirects, and CTR analytics","item":[{"name":"GET Email open tracking pixel","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/crm/track/open","host":["{{baseUrl}}"],"path":["api","crm","track","open"]},"description":"Embeddable 1x1 GIF tracking pixel that registers unique email opens, increments recipient open counters, and logs client telemetry."}},{"name":"GET Email link click redirect & CTR tracking","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/crm/track/click","host":["{{baseUrl}}"],"path":["api","crm","track","click"]},"description":"Redirects recipient to the destination URL while atomically registering a click event and updating campaign CTR metrics."}},{"name":"GET Get workspace engagement summary & KPIs","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/engagement","host":["{{baseUrl}}"],"path":["api","crm","engagement"]},"description":"Returns Open Rates, Click-Through Rates (CTR), Click-to-Open Rates, per-campaign engagement statistics, and recent activity logs."}},{"name":"POST Record or simulate engagement event","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"campaignId\": \"\",\n  \"targetId\": \"\",\n  \"targetEmail\": \"\",\n  \"eventType\": \"\",\n  \"url\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/engagement","host":["{{baseUrl}}"],"path":["api","crm","engagement"]},"description":"Manually records an open or click event for testing and telemetry pipelines."}},{"name":"POST Ingest website tracking event (Public Key + Integrity Verified)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"publicKey\": \"cs_pk_9f4b2a1c8e7d6f5a4b3c2d1e\",\n  \"event\": \"purchase_completed\",\n  \"attributionToken\": \"\",\n  \"timestamp\": 1794362400000,\n  \"nonce\": \"a1b2c3d4e5f6\",\n  \"properties\": {\n    \"orderId\": \"ORD-1024\",\n    \"value\": 149,\n    \"currency\": \"GBP\"\n  },\n  \"integrity\": {},\n  \"signature\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/track/event","host":["{{baseUrl}}"],"path":["api","crm","track","event"]},"description":"Public ingestion endpoint called by the hosted CloudSend JS SDK (`/sdk/cloudsend-track.js`) or server backends. Resolves the workspace via `publicKey`, verifies origin allowlists, client SHA-256 payload digest, optional/required HMAC-SHA256 signature (`X-CloudSend-Signature`), and HMAC-signed `cs_tid` link attribution token, then updates `events.<campaign_slug>.<event_name>` attributes on the matched contact."}},{"name":"GET Get hosted JS SDK Subresource Integrity (SRI) hashes","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/sdk/integrity","host":["{{baseUrl}}"],"path":["api","sdk","integrity"]},"description":"Returns the exact SHA-384 and SHA-256 Subresource Integrity digests for `/sdk/cloudsend-track.js`."}},{"name":"GET Get workspace website tracking config, publicKey & SRI snippet","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/tracking/config","host":["{{baseUrl}}"],"path":["api","crm","tracking","config"]},"description":"Get workspace website tracking config, publicKey & SRI snippet"}},{"name":"PUT Update website tracking settings","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"enabled\": true,\n  \"autoAppendLinks\": true,\n  \"allowedOrigins\": {},\n  \"requireSignedEvents\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/tracking/config","host":["{{baseUrl}}"],"path":["api","crm","tracking","config"]},"description":"Update website tracking settings"}},{"name":"POST Rotate workspace tracking Public Key","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/tracking/rotate-key","host":["{{baseUrl}}"],"path":["api","crm","tracking","rotate-key"]},"description":"Rotate workspace tracking Public Key"}},{"name":"POST Rotate write-only HMAC event signing secret (returned once)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/tracking/rotate-secret","host":["{{baseUrl}}"],"path":["api","crm","tracking","rotate-secret"]},"description":"Rotate write-only HMAC event signing secret (returned once)"}},{"name":"GET List attributed website tracking events and conversion revenue","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/tracking/events","host":["{{baseUrl}}"],"path":["api","crm","tracking","events"]},"description":"List attributed website tracking events and conversion revenue"}}]},{"name":"GDPR Compliance","description":"One-click public unsubscribe and Article 15 SAR dossiers","item":[{"name":"GET Export subject dossier (GDPR Art. 15 Right of Access)","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/targets/{id}/export","host":["{{baseUrl}}"],"path":["api","crm","targets",":id","export"]},"description":"Generates a complete, portable JSON dossier of all personal data, consent history, dynamic attributes, and outbound dispatch records held on the subject."}},{"name":"GET One-click unsubscribe (GET link)","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/crm/unsubscribe","host":["{{baseUrl}}"],"path":["api","crm","unsubscribe"]},"description":"One-click unsubscribe (GET link)"}},{"name":"POST One-click unsubscribe (RFC 8058 POST)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/unsubscribe","host":["{{baseUrl}}"],"path":["api","crm","unsubscribe"]},"description":"One-click unsubscribe (RFC 8058 POST)"}}]},{"name":"Sending Domains","description":"Custom sender domains, SPF, 2048-bit RSA DKIM, and DMARC verification","item":[{"name":"GET List custom sending domains","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/domains","host":["{{baseUrl}}"],"path":["api","crm","domains"]},"description":"Lists all registered sending domains and their DNS verification statuses."}},{"name":"POST Register custom sending domain","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"domain\": \"example.com\",\n  \"defaultFromUser\": \"hello\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/domains","host":["{{baseUrl}}"],"path":["api","crm","domains"]},"description":"Registers a new sending domain and generates SPF TXT, 2048-bit RSA DKIM TXT, 3x Easy-DKIM CNAMEs, DMARC TXT, and Return-Path MX records."}},{"name":"POST Verify domain DNS records","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"forceVerify\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/domains/{domain}/verify","host":["{{baseUrl}}"],"path":["api","crm","domains",":domain","verify"]},"description":"Queries DNS servers to verify SPF, DKIM, and DMARC configuration."}}]},{"name":"Billing","description":"Subscription tiers, usage quotas, and plan upgrades","item":[{"name":"GET List available pricing tiers","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/billing/tiers","host":["{{baseUrl}}"],"path":["api","billing","tiers"]},"description":"Returns the catalog of plans (Free, Personal, Business, Enterprise) with resource limits and feature matrix."}},{"name":"GET Get workspace billing status & usage quotas","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/billing","host":["{{baseUrl}}"],"path":["api","billing"]},"description":"Get workspace billing status & usage quotas"}},{"name":"PUT Upgrade or change subscription tier","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"tierId\": \"\",\n  \"billingCycle\": \"monthly\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/billing/tier","host":["{{baseUrl}}"],"path":["api","billing","tier"]},"description":"Upgrade or change subscription tier"}}]},{"name":"MCP","description":"Model Context Protocol (JSON-RPC 2.0) for AI assistants","item":[{"name":"GET MCP server discovery","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"url":{"raw":"{{baseUrl}}/api/mcp","host":["{{baseUrl}}"],"path":["api","mcp"]},"description":"Returns Model Context Protocol (2024-11-05) server info, available AI tools count, and SSE endpoints."}},{"name":"POST Execute MCP JSON-RPC 2.0 call","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"tools/call\",\n  \"params\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/mcp","host":["{{baseUrl}}"],"path":["api","mcp"]},"description":"Handles MCP methods: initialize, tools/list, tools/call, resources/list, resources/read, prompts/list."}}]},{"name":"CRM Mail Groups","item":[{"name":"GET List dynamic mail groups","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/groups","host":["{{baseUrl}}"],"path":["api","crm","groups"]},"description":"Lists all audience mail groups in the workspace with member target counts and default group status."}},{"name":"POST Create dynamic mail group","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"VIP Clients\",\n  \"description\": \"High-value enterprise clients\",\n  \"isDefault\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/groups","host":["{{baseUrl}}"],"path":["api","crm","groups"]},"description":"Creates a new audience mail group. Optionally designates it as the workspace default group."}},{"name":"GET Get mail group details","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/groups/{id}","host":["{{baseUrl}}"],"path":["api","crm","groups",":id"]},"description":"Retrieves details and member counts for a specific mail group."}},{"name":"PUT Update mail group","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"\",\n  \"description\": \"\",\n  \"isDefault\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/crm/groups/{id}","host":["{{baseUrl}}"],"path":["api","crm","groups",":id"]},"description":"Updates a mail group name, description, or default status."}},{"name":"DELETE Delete mail group","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/groups/{id}","host":["{{baseUrl}}"],"path":["api","crm","groups",":id"]},"description":"Deletes a dynamic mail group. The default workspace group CANNOT be deleted."}},{"name":"POST Set default mail group","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"X-Account-Id","value":"{{accountId}}"}],"url":{"raw":"{{baseUrl}}/api/crm/groups/{id}/default","host":["{{baseUrl}}"],"path":["api","crm","groups",":id","default"]},"description":"Designates a specific mail group as the workspace default group, unsetting the previous default."}}]}]}