All methods
Every SDK method, the endpoint it calls and what it returns.
Every method of the @swarmhit/swarmhit-sdk package, grouped as they appear on the client.
Each method links to its endpoint in the API Reference,
which documents every parameter and field. Arguments follow the usual order:
the path ids, then one params object, then the
request options. The list shows params?
when everything in params is optional.
In the Returns column, you can iterate a page of result with for await:
see Lists and pagination. Retry-safe methods send an
idempotency key, so a retry never repeats the action: see
Never twice. The package exports every type named
here: import type { Campaign } from '@swarmhit/swarmhit-sdk'.
swarmhit
| Method | What it does | Returns |
|---|---|---|
swarmhit.info()GET / | API info | GetApiInfoResponse |
swarmhit.health()GET /health | Service health | Health |
swarmhit.stats
| Method | What it does | Returns |
|---|---|---|
swarmhit.stats.get()GET /stats | Workspace stats | Stats |
swarmhit.campaigns
| Method | What it does | Returns |
|---|---|---|
swarmhit.campaigns.list(params?)GET /campaigns | List campaigns | page of Campaign |
swarmhit.campaigns.create(params?)POST /campaigns | Create a campaign | CampaignDetail |
swarmhit.campaigns.get(campaignId)GET /campaigns/{id} | Get a campaign | CampaignDetail |
swarmhit.campaigns.update(campaignId, params)PATCH /campaigns/{id} | Update a campaign | CampaignDetail |
swarmhit.campaigns.delete(campaignId)DELETE /campaigns/{id} | Delete a campaign | DeleteCampaignResponse |
swarmhit.campaigns.duplicate(campaignId)POST /campaigns/{id}/duplicate | Duplicate a campaign | CampaignDetail |
swarmhit.campaigns.updateStep(campaignId, stepId, params)PATCH /campaigns/{id}/sequence/{stepId} | Update one campaign sequence step | CampaignDetail |
swarmhit.campaigns.rebalanceSender(campaignId, accountId)POST /campaigns/{id}/senders/{accountId}/rebalance | Rebalance a sender's leads | RebalanceCampaignSenderResponse |
swarmhit.campaigns.leads
| Method | What it does | Returns |
|---|---|---|
swarmhit.campaigns.leads.list(campaignId, params?)GET /campaigns/{id}/leads | List the leads in a campaign | page of LeadInCampaign |
swarmhit.campaigns.leads.add(campaignId, params)POST /campaigns/{id}/leads | Add leads to a campaign | AddLeadsToCampaignResponse |
swarmhit.campaigns.leads.get(campaignId, leadId)GET /campaigns/{id}/leads/{leadId} | A lead's progress in a campaign | LeadInCampaignDetail |
swarmhit.campaigns.leads.setInterest(campaignId, leadId, params)PATCH /campaigns/{id}/leads/{leadId} | Set a lead's interest in a campaign | LeadInCampaignDetail |
swarmhit.campaigns.leads.remove(campaignId, leadId)DELETE /campaigns/{id}/leads/{leadId} | Remove a lead from a campaign | RemoveLeadFromCampaignResponse |
swarmhit.campaigns.leads.pause(campaignId, leadId)POST /campaigns/{id}/leads/{leadId}/pause | Pause a lead in a campaign | LeadInCampaign |
swarmhit.campaigns.leads.resume(campaignId, leadId)POST /campaigns/{id}/leads/{leadId}/resume | Resume a paused lead in a campaign | LeadInCampaign |
swarmhit.campaigns.leads.retry(campaignId, leadId)POST /campaigns/{id}/leads/{leadId}/retry | Retry a lead in a campaign | LeadInCampaign |
swarmhit.campaigns.leads.stop(campaignId, leadId)POST /campaigns/{id}/leads/{leadId}/stop | Stop a lead in a campaign for good | LeadInCampaign |
swarmhit.leads
| Method | What it does | Returns |
|---|---|---|
swarmhit.leads.list(params?)GET /leads | List leads | page of Lead |
swarmhit.leads.get(leadId)GET /leads/{id} | Get a lead | Lead |
swarmhit.leads.update(leadId, params)PATCH /leads/{id} | Update a lead | Lead |
swarmhit.leads.delete(leadId)DELETE /leads/{id} | Delete a lead | DeleteLeadResponse |
swarmhit.leads.getActivity(leadId)GET /leads/{id}/activity | Get a lead's activity | GetLeadActivityResponse |
swarmhit.leads.enrich(leadId, params?)POST /leads/{id}/enrich | Find a lead's email or phone | Lead |
swarmhit.leads.enrichMany(params)POST /leads/enrich | Find emails or phones for many leads | EnrichLeadsResponse |
swarmhit.lists
| Method | What it does | Returns |
|---|---|---|
swarmhit.lists.list(params?)GET /lists | List lead lists | page of List |
swarmhit.lists.create(params?)POST /lists | Create a lead list | List |
swarmhit.lists.get(listId)GET /lists/{id} | Get a lead list | List |
swarmhit.lists.update(listId, params)PATCH /lists/{id} | Rename a lead list | List |
swarmhit.lists.delete(listId)DELETE /lists/{id} | Delete a lead list | DeleteListResponse |
swarmhit.lists.leads
| Method | What it does | Returns |
|---|---|---|
swarmhit.lists.leads.list(listId, params?)GET /lists/{id}/leads | List a list's leads | page of Lead |
swarmhit.lists.leads.add(listId, params)POST /lists/{id}/leads | Add leads to a list | AddListLeadsResponse |
swarmhit.lists.leads.remove(listId, leadId)DELETE /lists/{id}/leads/{leadId} | Remove a lead from a list | RemoveListLeadResponse |
swarmhit.leadImports
| Method | What it does | Returns |
|---|---|---|
swarmhit.leadImports.create(params)POST /lead-imports | Start a LinkedIn search import | LeadImport |
swarmhit.leadImports.list(params?)GET /lead-imports | List lead imports | page of LeadImport |
swarmhit.leadImports.get(leadImportId)GET /lead-imports/{id} | Get a lead import | LeadImport |
swarmhit.leadImports.delete(leadImportId)DELETE /lead-imports/{id} | Delete a terminal lead import | DeleteLeadImportResponse |
swarmhit.leadImports.cancel(leadImportId)POST /lead-imports/{id}/cancel | Cancel a running lead import | LeadImport |
swarmhit.leadImports.resume(leadImportId)POST /lead-imports/{id}/resume | Resume a paused or failed lead import | LeadImport |
swarmhit.database
| Method | What it does | Returns |
|---|---|---|
swarmhit.database.suggestions(params)POST /database/suggestions | List valid filter values | DatabaseSuggestionsResponse |
swarmhit.database.capabilities()GET /database/capabilities | List supported filters | DatabaseCapabilitiesResponse |
swarmhit.database.people
| Method | What it does | Returns |
|---|---|---|
swarmhit.database.people.search(params)POST /database/people/search | Search people in the database | page of DbPerson |
swarmhit.database.people.enrich(params)POST /database/people/enrich | Enrich a person | DbPersonDetail |
swarmhit.database.people.findEmail(params)POST /database/people/find-email | Find a person's email | FindEmailDatabaseResponse |
swarmhit.database.people.findPhone(params)POST /database/people/find-phone | Find a person's phone | FindPhoneDatabaseResponse |
swarmhit.database.companies
| Method | What it does | Returns |
|---|---|---|
swarmhit.database.companies.search(params)POST /database/companies/search | Search companies in the database | page of DbCompany |
swarmhit.database.companies.enrich(params)POST /database/companies/enrich | Enrich a company | DbCompany |
swarmhit.inbox
| Method | What it does | Returns |
|---|---|---|
swarmhit.inbox.getCounts(params?)GET /inbox/counts | Unread messages and favourites | GetInboxCountsResponse |
swarmhit.inbox.sync(params)POST /inbox/sync | Pull a sender's recent chats from LinkedIn | SyncInboxChatsResponse |
swarmhit.inbox.chats
| Method | What it does | Returns |
|---|---|---|
swarmhit.inbox.chats.list(params?)GET /inbox/chats | List inbox chats | page of Chat |
swarmhit.inbox.chats.get(chatId)GET /inbox/chats/{id} | Get an inbox chat | Chat |
swarmhit.inbox.chats.markRead(chatId)POST /inbox/chats/{id}/read | Mark a chat read | MarkChatReadResponse |
swarmhit.inbox.chats.setFavorite(chatId, params)POST /inbox/chats/{id}/favorite | Star or unstar a chat | Chat |
swarmhit.inbox.chats.sync(chatId, params?)POST /inbox/chats/{id}/sync | Pull a chat's latest messages from LinkedIn | SyncChatMessagesResponse |
swarmhit.inbox.chats.messages
| Method | What it does | Returns |
|---|---|---|
swarmhit.inbox.chats.messages.list(chatId, params?)GET /inbox/chats/{id}/messages | List messages in a chat | page of Message |
swarmhit.inbox.chats.messages.send(chatId, params)POST /inbox/chats/{id}/messages | Send a message in a chat Retry-safe. | SendChatMessageResponse |
swarmhit.accounts
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.list(params?)GET /accounts | List sender accounts | page of ListAccountsItem |
swarmhit.accounts.connect(params)POST /accounts | Connect a sender | ConnectSenderResponse |
swarmhit.accounts.get(accountId)GET /accounts/{id} | Get a sender account | Account |
swarmhit.accounts.update(accountId, params)PATCH /accounts/{id} | Rename a sender | Account |
swarmhit.accounts.disconnect(accountId, params?)DELETE /accounts/{id} | Disconnect a sender | DisconnectSenderResponse |
swarmhit.accounts.restore(accountId, params?)POST /accounts/{id}/restore | Restore an archived account | Account |
swarmhit.accounts.sync(accountId)POST /accounts/{id}/sync | Sync account information | Account |
swarmhit.accounts.reconnect(accountId, params?)POST /accounts/{id}/reconnect | Reconnect a sender account | ReconnectAccountResponse |
swarmhit.accounts.pause(accountId)POST /accounts/{id}/pause | Pause a sender | Account |
swarmhit.accounts.resume(accountId)POST /accounts/{id}/resume | Resume a paused sender | Account |
swarmhit.accounts.getSsi(accountId, params?)GET /accounts/{id}/ssi | Social Selling Index | AccountSsi |
swarmhit.accounts.getStats(accountId, params?)GET /accounts/{id}/stats | Sender performance | AccountStats |
swarmhit.accounts.createLiveView(accountId)POST /accounts/{id}/live-view | Open a live view of the sign-in browser | CreateAccountLiveViewResponse |
swarmhit.accounts.pickNewIp(accountId)POST /accounts/{id}/pick-new-ip | Move a stopped sender onto a new IP | Account |
swarmhit.accounts.checkpoint
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.checkpoint.get(accountId)GET /accounts/{id}/checkpoint | Get the pending sign-in challenge | GetAccountCheckpointResponse |
swarmhit.accounts.checkpoint.solve(accountId, params)POST /accounts/{id}/checkpoint | Answer the pending sign-in challenge | SolveAccountCheckpointResponse |
swarmhit.accounts.checkpoint.resend(accountId)POST /accounts/{id}/checkpoint/resend | Re-send the pending sign-in challenge | ResendAccountCheckpointResponse |
swarmhit.accounts.limits
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.limits.get(accountId)GET /accounts/{id}/limits | Get a sender's limits | AccountLimits |
swarmhit.accounts.limits.update(accountId, params)PATCH /accounts/{id}/limits | Change a sender's limits | AccountLimits |
swarmhit.accounts.warmup
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.warmup.get()GET /accounts/warmup | Get the LinkedIn warm-up settings | AccountWarmupPolicy |
swarmhit.accounts.warmup.update(params)PATCH /accounts/warmup | Change the LinkedIn warm-up settings | AccountWarmupPolicy |
swarmhit.accounts.hostedLinks
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.hostedLinks.create(params)POST /accounts/hosted-link | Create a hosted connect link | HostedLink |
swarmhit.accounts.hostedLinks.get(hostedLinkId)GET /accounts/hosted-link/{id} | Get a hosted connect link | HostedLink |
swarmhit.accounts.connections
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.connections.send(accountId, params)POST /accounts/{id}/connections | Send a connection request Retry-safe. | OutreachAction |
swarmhit.accounts.connections.get(accountId, identifier)GET /accounts/{id}/connections/{identifier} | Check connection status | Connection |
swarmhit.accounts.connections.withdraw(accountId, identifier)DELETE /accounts/{id}/connections/{identifier} | Withdraw a connection request | WithdrawConnectionRequestResponse |
swarmhit.accounts.messages
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.messages.send(accountId, params)POST /accounts/{id}/messages | Message a connection Retry-safe. | OutreachAction |
swarmhit.accounts.inmails
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.inmails.send(accountId, params)POST /accounts/{id}/inmails | Send an InMail Retry-safe. | OutreachAction |
swarmhit.accounts.profiles
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.profiles.get(accountId, identifier)GET /accounts/{id}/profiles/{identifier} | Look up a profile | Profile |
swarmhit.accounts.profiles.visit(accountId, params)POST /accounts/{id}/profile-views | Visit a profile Retry-safe. | OutreachAction |
swarmhit.accounts.profiles.follow(accountId, params)POST /accounts/{id}/follows | Follow a lead Retry-safe. | OutreachAction |
swarmhit.accounts.posts
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.posts.like(accountId, params)POST /accounts/{id}/post-likes | Like a post Retry-safe. | OutreachAction |
swarmhit.accounts.posts.comment(accountId, params)POST /accounts/{id}/post-comments | Comment on a post Retry-safe. | OutreachAction |
swarmhit.accounts.posts.listComments(accountId, params)GET /accounts/{id}/post-comments | List a post's comments | page of PostComment |
swarmhit.accounts.actions
| Method | What it does | Returns |
|---|---|---|
swarmhit.accounts.actions.list(accountId, params?)GET /accounts/{id}/actions | List direct actions | page of OutreachAction |
swarmhit.emailAccounts
| Method | What it does | Returns |
|---|---|---|
swarmhit.emailAccounts.list(params?)GET /email-accounts | List mailboxes | page of MailboxAccount |
swarmhit.emailAccounts.get(emailAccountId)GET /email-accounts/{id} | Get a mailbox | MailboxAccount |
swarmhit.emailAccounts.delete(emailAccountId)DELETE /email-accounts/{id} | Remove a mailbox | RemoveEmailAccountResponse |
swarmhit.emailAccounts.pause(emailAccountId)POST /email-accounts/{id}/pause | Pause a mailbox | MailboxAccount |
swarmhit.emailAccounts.resume(emailAccountId)POST /email-accounts/{id}/resume | Resume a paused mailbox | MailboxAccount |
swarmhit.emailAccounts.checkDns(emailAccountId)POST /email-accounts/{id}/check-dns | Re-check a mailbox's domain | MailboxAccount |
swarmhit.emailAccounts.testDeliverability(emailAccountId)POST /email-accounts/{id}/deliverability-test | Run a deliverability test | MailboxAccount |
swarmhit.emailAccounts.getStats(emailAccountId, params?)GET /email-accounts/{id}/stats | Mailbox performance | MailboxStats |
swarmhit.emailAccounts.cancelManaged(emailAccountId, params?)POST /email-accounts/{id}/cancel-managed | Cancel a bought mailbox | CancelManagedEmailAccountResponse |
swarmhit.emailAccounts.setPicture(emailAccountId, params)POST /email-accounts/{id}/picture | Set a bought mailbox's picture | MailboxAccount |
swarmhit.emailAccounts.emails
| Method | What it does | Returns |
|---|---|---|
swarmhit.emailAccounts.emails.send(emailAccountId, params)POST /email-accounts/{id}/emails | Send an email Retry-safe. | DirectEmail |
swarmhit.emailAccounts.emails.list(emailAccountId, params?)GET /email-accounts/{id}/emails | List emails sent through the API | page of DirectEmail |
swarmhit.emailAccounts.hostedLinks
| Method | What it does | Returns |
|---|---|---|
swarmhit.emailAccounts.hostedLinks.create(params)POST /email-accounts/hosted-link | Create a hosted connect link for a mailbox | HostedLink |
swarmhit.emailAccounts.hostedLinks.get(hostedLinkId)GET /email-accounts/hosted-link/{id} | Get a mailbox hosted connect link | HostedLink |
swarmhit.emailAccounts.warmup
| Method | What it does | Returns |
|---|---|---|
swarmhit.emailAccounts.warmup.get(emailAccountId)GET /email-accounts/{id}/warmup | Get a mailbox's warmup | WarmupState |
swarmhit.emailAccounts.warmup.update(emailAccountId, params)PATCH /email-accounts/{id}/warmup | Change the warmup strategy | WarmupState |
swarmhit.emailAccounts.warmup.start(emailAccountId, params?)POST /email-accounts/{id}/warmup/start | Start warmup | WarmupState |
swarmhit.emailAccounts.warmup.pause(emailAccountId)POST /email-accounts/{id}/warmup/pause | Pause warmup | WarmupState |
swarmhit.emailAccounts.warmup.resume(emailAccountId)POST /email-accounts/{id}/warmup/resume | Resume warmup | WarmupState |
swarmhit.emailAccounts.warmup.stop(emailAccountId)POST /email-accounts/{id}/warmup/stop | Stop warmup | WarmupState |
swarmhit.emailAccounts.warmup.overrideHold(emailAccountId, params)POST /email-accounts/{id}/warmup/hold-override | Send before warmup is done | WarmupState |
swarmhit.emailAccounts.warmup.getStats(emailAccountId, params?)GET /email-accounts/{id}/warmup/stats | Warmup daily series | GetEmailAccountWarmupStatsResponse |
swarmhit.domains
| Method | What it does | Returns |
|---|---|---|
swarmhit.domains.search(params)GET /domains/search | Search domains to buy | SearchDomainsResponse |
swarmhit.managedDomains
| Method | What it does | Returns |
|---|---|---|
swarmhit.managedDomains.list(params?)GET /managed-domains | List the domains you bought | ListManagedDomainsResponse |
swarmhit.mailboxBilling
| Method | What it does | Returns |
|---|---|---|
swarmhit.mailboxBilling.get()GET /mailbox-billing | What you pay for bought mailboxes | MailboxBilling |
swarmhit.mailboxOrders
| Method | What it does | Returns |
|---|---|---|
swarmhit.mailboxOrders.quote(params)POST /mailbox-orders/quote | Price an order | MailboxOrderQuote |
swarmhit.mailboxOrders.list(params?)GET /mailbox-orders | List mailbox orders | page of MailboxOrder |
swarmhit.mailboxOrders.create(params)POST /mailbox-orders | Buy domains and mailboxes Retry-safe. | MailboxOrder |
swarmhit.mailboxOrders.get(mailboxOrderId, params?)GET /mailbox-orders/{id} | Get a mailbox order | MailboxOrder |
swarmhit.callTasks
| Method | What it does | Returns |
|---|---|---|
swarmhit.callTasks.list(params?)GET /call-tasks | List call tasks | page of CallTask |
swarmhit.callTasks.get(callTaskId)GET /call-tasks/{id} | Get a call task | CallTask |
swarmhit.callTasks.complete(callTaskId, params)POST /call-tasks/{id}/complete | Log a call | CallTask |
swarmhit.callTasks.skip(callTaskId)POST /call-tasks/{id}/skip | Skip a call | CallTask |
swarmhit.callTasks.stop(callTaskId, params?)POST /call-tasks/{id}/stop | Stop the lead's sequence | CallTask |
swarmhit.whatsappAccounts
| Method | What it does | Returns |
|---|---|---|
swarmhit.whatsappAccounts.list(params?)GET /whatsapp-accounts | List WhatsApp numbers | page of WhatsappAccount |
swarmhit.whatsappAccounts.link(params)POST /whatsapp-accounts | Link a WhatsApp number | LinkWhatsappAccountResponse |
swarmhit.whatsappAccounts.get(whatsappAccountId)GET /whatsapp-accounts/{id} | Get a WhatsApp number | WhatsappAccount |
swarmhit.whatsappAccounts.update(whatsappAccountId, params)PATCH /whatsapp-accounts/{id} | Change a number's name, caps or warm-up | WhatsappAccount |
swarmhit.whatsappAccounts.delete(whatsappAccountId)DELETE /whatsapp-accounts/{id} | Remove a WhatsApp number | RemoveWhatsappAccountResponse |
swarmhit.whatsappAccounts.getLink(whatsappAccountId)GET /whatsapp-accounts/{id}/link | Follow a link | WhatsappLinkState |
swarmhit.whatsappAccounts.relink(whatsappAccountId, params?)POST /whatsapp-accounts/{id}/relink | Scan again | RelinkWhatsappAccountResponse |
swarmhit.whatsappAccounts.cancelLink(whatsappAccountId)POST /whatsapp-accounts/{id}/cancel-link | Cancel a link | CancelWhatsappLinkResponse |
swarmhit.whatsappAccounts.pause(whatsappAccountId)POST /whatsapp-accounts/{id}/pause | Pause a WhatsApp number | WhatsappAccount |
swarmhit.whatsappAccounts.resume(whatsappAccountId)POST /whatsapp-accounts/{id}/resume | Resume a WhatsApp number | WhatsappAccount |
swarmhit.whatsappAccounts.getStats(whatsappAccountId)GET /whatsapp-accounts/{id}/stats | WhatsApp number performance and health | WhatsappStats |
swarmhit.pendingComments
| Method | What it does | Returns |
|---|---|---|
swarmhit.pendingComments.list(params?)GET /pending-comments | List AI comment drafts | page of PendingComment |
swarmhit.pendingComments.get(pendingCommentId)GET /pending-comments/{id} | Get a comment draft | PendingComment |
swarmhit.pendingComments.update(pendingCommentId, params)PATCH /pending-comments/{id} | Edit a comment draft | PendingComment |
swarmhit.pendingComments.approve(pendingCommentId, params?)POST /pending-comments/{id}/approve | Approve a comment draft | PendingComment |
swarmhit.pendingComments.reject(pendingCommentId)POST /pending-comments/{id}/reject | Reject a comment draft | PendingComment |
swarmhit.pendingComments.regenerate(pendingCommentId, params?)POST /pending-comments/{id}/regenerate | Re-draft a comment | PendingComment |
swarmhit.pendingVoiceNotes
| Method | What it does | Returns |
|---|---|---|
swarmhit.pendingVoiceNotes.list(params?)GET /pending-voice-notes | List AI voice notes awaiting review | page of PendingVoiceNote |
swarmhit.pendingVoiceNotes.get(pendingVoiceNoteId)GET /pending-voice-notes/{id} | Get a voice note awaiting review | PendingVoiceNote |
swarmhit.pendingVoiceNotes.approve(pendingVoiceNoteId)POST /pending-voice-notes/{id}/approve | Approve a voice note | PendingVoiceNote |
swarmhit.pendingVoiceNotes.reject(pendingVoiceNoteId)POST /pending-voice-notes/{id}/reject | Reject a voice note | PendingVoiceNote |
swarmhit.pendingVoiceNotes.regenerate(pendingVoiceNoteId, params?)POST /pending-voice-notes/{id}/regenerate | Re-record a voice note | PendingVoiceNote |
swarmhit.workspaces
| Method | What it does | Returns |
|---|---|---|
swarmhit.workspaces.list()GET /workspaces | List workspaces | OrganizationWorkspaces |
swarmhit.workspaces.create(params)POST /workspaces | Create a workspace | OrganizationWorkspaceDetail |
swarmhit.workspaces.get(workspaceId)GET /workspaces/{id} | Get a workspace | OrganizationWorkspaceDetail |
swarmhit.workspaces.update(workspaceId, params)PATCH /workspaces/{id} | Update a workspace | OrganizationWorkspaceDetail |
swarmhit.workspaces.delete(workspaceId)DELETE /workspaces/{id} | Delete a workspace | DeleteWorkspaceResponse |
swarmhit.workspaces.members
| Method | What it does | Returns |
|---|---|---|
swarmhit.workspaces.members.list(workspaceId)GET /workspaces/{id}/members | List a workspace's members | ListWorkspaceMembersResponse |
swarmhit.workspaces.members.invite(workspaceId, params)POST /workspaces/{id}/members | Invite a member to a workspace | InviteWorkspaceMemberResponse |
swarmhit.workspaces.members.update(workspaceId, memberId, params)PATCH /workspaces/{id}/members/{memberId} | Update a workspace member's role | UpdateWorkspaceMemberResponse |
swarmhit.workspaces.members.remove(workspaceId, memberId, params?)DELETE /workspaces/{id}/members/{memberId} | Remove a workspace member or revoke an invite | RemoveWorkspaceMemberResponse |
swarmhit.webhooks
| Method | What it does | Returns |
|---|---|---|
swarmhit.webhooks.list(params?)GET /webhooks | List webhook endpoints | page of Webhook |
swarmhit.webhooks.create(params)POST /webhooks | Create a webhook endpoint | Webhook |
swarmhit.webhooks.get(webhookId)GET /webhooks/{id} | Get a webhook endpoint | Webhook |
swarmhit.webhooks.update(webhookId, params)PATCH /webhooks/{id} | Update a webhook endpoint | Webhook |
swarmhit.webhooks.delete(webhookId)DELETE /webhooks/{id} | Delete a webhook endpoint | DeleteWebhookResponse |
swarmhit.webhooks.test(webhookId)POST /webhooks/{id}/test | Send a test delivery | TestWebhookResponse |
swarmhit.webhooks.listDeliveries(webhookId, params?)GET /webhooks/{id}/deliveries | List recent deliveries | page of WebhookDelivery |
swarmhit.webhooks.deliveries
| Method | What it does | Returns |
|---|---|---|
swarmhit.webhooks.deliveries.list(params?)GET /webhooks/deliveries | List the delivery log | page of WebhookDelivery |
swarmhit.webhooks.deliveries.resend(deliveryId)POST /webhooks/deliveries/{id}/resend | Replay a delivery | WebhookDelivery |
swarmhit.countries
| Method | What it does | Returns |
|---|---|---|
swarmhit.countries.list()GET /countries | List countries | ListCountriesResponse |
swarmhit.timezones
| Method | What it does | Returns |
|---|---|---|
swarmhit.timezones.list()GET /timezones | List timezones | ListTimezonesResponse |
swarmhit.voices
| Method | What it does | Returns |
|---|---|---|
swarmhit.voices.list()GET /voices | List voices | ListVoicesResponse |
Webhook events
swarmhit.webhooks.unwrap() returns one of these, typed by its event: message.received, message.sent, connection.accepted, lead.status_changed, campaign.finished, lead.imported, lead.enriched, comment.pending, voice_note.pending, call_task.pending, account.connected, account.connection_failed, account.status_changed, account.checkpoint_required, email.sent, email.received, email.bounced, email.opened, email.clicked, email.unsubscribed, account.paused, account.resumed, account.archived, account.restored, account.deleted, webhook.test, account.warmup_completed, whatsapp.sent, whatsapp.received, whatsapp.read, mailbox_order.completed, mailbox_order.failed, mailbox_billing.payment_failed, mailbox_billing.payment_recovered, warmup.status_changed, warmup.ready, warmup.health_changed.