Email v1.0

GET Ping the server/pingPing the server arrow_forward

POST Login as user/api/user/loginLogin as user arrow_forward POST Request password reset/api/user/forgot-passwordSends a password reset link to the user's email address if the user exists and is not blocked. arrow_forward POST Refresh user access token/api/user/refreshRefresh user access token arrow_forward POST Reset user password/api/user/reset-passwordResets the user's password using a valid reset token received via email. arrow_forward GET Get authenticated user's own details/api/user/selfReturns the details of the currently authenticated user. arrow_forward GET List sending identities for the authenticated user/api/user/sending-identitiesList sending identities for the authenticated user arrow_forward POST Create a new sending identity for the authenticated user/api/user/sending-identitiesCreate a new sending identity for the authenticated user arrow_forward DELETE Delete a sending identity for the authenticated user/api/user/sending-identities/{id}Delete a sending identity for the authenticated user arrow_forward GET Get the current API key for the authenticated user/api/user/api-keyGet the current API key for the authenticated user arrow_forward POST Generate or rotate the API key for the authenticated user/api/user/api-key/rotateGenerate or rotate the API key for the authenticated user arrow_forward GET Get SMTP settings for the authenticated user/api/user/smtp-settingsGet SMTP settings for the authenticated user arrow_forward PUT Create or update SMTP settings for the authenticated user/api/user/smtp-settingsCreate or update SMTP settings for the authenticated user arrow_forward GET List groups for the authenticated user/api/user/groupsList groups for the authenticated user arrow_forward POST Create a new group for the authenticated user/api/user/groupsCreate a new group for the authenticated user arrow_forward POST Add a contact to a group for the authenticated user/api/user/groups/{groupId}/contactsAdd a contact to a group for the authenticated user arrow_forward PUT Update contact details (name/status) for a contact within a group for the authenticated user/api/user/groups/{groupId}/contacts/{contactId}Update contact details (name/status) for a contact within a group for the authenticated user arrow_forward DELETE Remove a contact from a group for the authenticated user/api/user/groups/{groupId}/contacts/{contactId}Remove a contact from a group for the authenticated user arrow_forward GET List email templates for the authenticated user/api/user/templatesList email templates for the authenticated user arrow_forward POST Create a new email template for the authenticated user/api/user/templatesCreate a new email template for the authenticated user arrow_forward GET Get a single email template for the authenticated user/api/user/templates/{id}Get a single email template for the authenticated user arrow_forward PUT Update an existing email template for the authenticated user/api/user/templates/{id}Update an existing email template for the authenticated user arrow_forward DELETE Archive (soft delete) an email template for the authenticated user/api/user/templates/{id}Archive (soft delete) an email template for the authenticated user arrow_forward POST Get pre-signed URL for template file upload/api/user/templates/{id}/get-pre-signed-urlGenerates a pre-signed URL for uploading a file attachment to a specific template. The template must belong to the authenticated user. A unique file key will be generated automatically and stored as a template attachment. arrow_forward POST Trigger template attachment upload completion/api/user/templates/{id}/triggerMarks template attachments as uploaded after files have been successfully uploaded to S3 using the pre-signed URLs. The template must belong to the authenticated user. arrow_forward GET List all template attachments/api/user/templates/{id}/attachmentsRetrieves all attachments for a specific template. The template must belong to the authenticated user. Returns attachments ordered by creation date (newest first), each with a pre-signed read URL. arrow_forward DELETE Delete a template attachment/api/user/templates/{id}/attachments/{attachmentId}Deletes a template attachment by ID. The attachment must belong to the specified template, and the template must belong to the authenticated user. This will also delete the file from S3. arrow_forward GET Get details of a group for the authenticated user/api/user/groups/{id}Get details of a group for the authenticated user arrow_forward PUT Update an existing group for the authenticated user/api/user/groups/{id}Update an existing group for the authenticated user arrow_forward DELETE Delete a group for the authenticated user/api/user/groups/{id}Delete a group for the authenticated user arrow_forward POST Create a new import job for the authenticated user/api/user/imports/{groupId}Creates an import job for a specific group and returns a presigned URL for uploading a CSV file. The file must be a CSV file. arrow_forward POST Trigger an import job for processing/api/user/imports/{groupId}/{id}/triggerTriggers a pending import job to start processing. The import job must be in PENDING status. Once triggered, the job status will change to QUEUED and will be processed by the worker. arrow_forward GET List all import jobs for a specific group/api/user/imports/{groupId}/allRetrieves a paginated list of all import jobs for a specific group created by the authenticated user. Supports search, sorting, and pagination. Search is performed on the original_name field (case-insensitive). arrow_forward GET List email campaigns for the authenticated user/api/user/campaignsRetrieves a paginated list of campaigns for the authenticated user. Supports search and sorting. arrow_forward POST Create a new email campaign for the authenticated user/api/user/campaignsCreates a new email campaign in DRAFT status. The from_email domain must match a verified (ACTIVE) sending identity for the user. Target groups must belong to the user. arrow_forward GET Get a single email campaign for the authenticated user/api/user/campaigns/{id}Retrieves detailed information about a specific campaign by ID. The campaign must belong to the authenticated user and not be deleted. arrow_forward PUT Update an existing email campaign for the authenticated user/api/user/campaigns/{id}Updates an existing campaign. All fields are optional - only provided fields will be updated. The campaign must be in DRAFT or SCHEDULED status to be edited. The from_email domain must match a verified (ACTIVE) sending identity for the user. Target groups must belong to the user. arrow_forward DELETE Delete (soft delete) an email campaign for the authenticated user/api/user/campaigns/{id}Soft deletes a campaign by setting is_deleted to true. The campaign will no longer appear in list queries but data is preserved. arrow_forward GET Get campaign analytics for the authenticated user/api/user/campaigns/{id}/analyticsReturns delivery status counts and calculated rates for a specific campaign. Queued emails are excluded. arrow_forward GET Get campaign link analytics for the authenticated user/api/user/campaigns/{id}/link-analyticsReturns a paginated list of tracked links for a campaign with click counts. Supports search by URL or token. arrow_forward POST Get pre-signed URL for user file upload/api/user/files/get-pre-signed-urlGenerates a pre-signed URL for uploading a file to S3. The file name and type are required. A unique file key will be generated automatically. arrow_forward GET Get MIS report for the authenticated user/api/user/mis-reportRetrieves a paginated MIS report with email metrics aggregated by date. Automatically filters by the authenticated user's ID. Users can only see their own data. arrow_forward GET Get delivery log report for the authenticated user/api/user/delivery-log-reportRetrieves a paginated delivery log report for the authenticated user. Includes email, status, delivery time, and submission time. arrow_forward GET Get user recharge logs (paginated)/api/user/recharge-logsRetrieves a paginated list of recharge logs for the authenticated user. Supports search and sort by created_at or credit_amount. arrow_forward

POST Send a single transactional email/api/transactional-email/sendSend a transactional email to a single recipient using an API key. arrow_forward