> For the complete documentation index, see [llms.txt](https://api.senderwiz.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.senderwiz.com/customer.md). # Customer - [Contact List](https://api.senderwiz.com/customer/contact-list.md) - [Get All Lists](https://api.senderwiz.com/customer/contact-list/quickstart.md): Retrieve a paginated list of all subscriber lists associated with your SenderWiz account using this endpoint. Useful for managing and referencing available list records. - [Get One List](https://api.senderwiz.com/customer/contact-list/get-one-list.md): Fetch detailed information about a specific subscriber list by providing its unique list UID. Includes general, default, and notification configuration data. - [Create a List](https://api.senderwiz.com/customer/contact-list/create-a-list.md): Create a new subscriber list by submitting general details, optional sender defaults, notification preferences information. Required fields must be included for a successful request. - [Update a List](https://api.senderwiz.com/customer/contact-list/update-a-list.md): Update the details of an existing subscriber list using its unique list UID. This includes modifying sender info, list settings, and optional default, notification data. - [Copy a List](https://api.senderwiz.com/customer/contact-list/copy-a-list.md): Create an exact duplicate of an existing list, including settings but excluding subscribers. A new unique list UID is returned in the response. - [Delete a List](https://api.senderwiz.com/customer/contact-list/delete-a-list.md): Permanently delete a specific subscriber list by its unique list UID. This action removes all associated list data and cannot be undone. - [Fields](https://api.senderwiz.com/customer/fields.md) - [Get All List Fields](https://api.senderwiz.com/customer/fields/get-all-list-fields.md): Retrieve all subscriber fields (default and custom) for a specific list using its unique ID. Fields include metadata such as tag, label, type, visibility, and order. - [Get One List Field](https://api.senderwiz.com/customer/fields/get-one-list-field.md): Fetch the complete configuration of a specific field from a list using its list UID and field ID. Response includes tag, label, visibility, and type metadata. - [Create a List Field](https://api.senderwiz.com/customer/fields/create-a-list-field.md): Add a custom field to a subscriber list by specifying field type, label, tag, and optional validation or options. Useful for capturing personalized subscriber data. - [Update a List Field](https://api.senderwiz.com/customer/fields/update-a-list-field.md) - [Delete a List Field](https://api.senderwiz.com/customer/fields/delete-a-list-field.md): Permanently delete a custom field from a subscriber list using its list UID and field ID. This is useful for cleaning up unused or outdated fields. - [Get All List Field Types](https://api.senderwiz.com/customer/fields/get-all-list-field-types.md): Fetch the full list of supported field types for list customization. This includes standard input fields like text, email, and dropdown, as well as advanced types such as geolocation, ratings, etc. - [Segments](https://api.senderwiz.com/customer/segments.md) - [Get All List Segments](https://api.senderwiz.com/customer/segments/get-all-list-segments.md): Retrieve all segments created within a specific subscriber list. Each segment includes a unique identifier, name, and the number of subscribers it contains. - [Get One List Segment](https://api.senderwiz.com/customer/segments/get-one-list-segment.md): Retrieve the full details of a single segment, including conditions, match type, subscriber count, and creation timestamp. Ideal for viewing dynamic list filters configured for targeted sending. - [Get All Subscribers](https://api.senderwiz.com/customer/segments/get-all-subscribers.md): Retrieve paginated subscribers from a specific segment within a list. This endpoint is helpful for filtering contacts based on segment rules and viewing their status and metadata. - [Create a List Segment](https://api.senderwiz.com/customer/segments/create-a-list-segment.md): Create a new list segment using custom field conditions, campaign behavior filters, or both. Ideal for targeting subscribers with highly specific criteria for campaigns or automation workflows. - [Update a List Segment](https://api.senderwiz.com/customer/segments/update-a-list-segment.md): Update an existing list segment using new field or campaign conditions. Only the submitted conditions will be retained; any existing ones not included will be removed. - [Delete a List Segment](https://api.senderwiz.com/customer/segments/delete-a-list-segment.md): Permanently delete a segment from a subscriber list. This action will remove the segment and its conditions from the list. - [Get All List Segment Condition Operators](https://api.senderwiz.com/customer/segments/get-all-list-segment-condition-operators.md) - [Subscribers](https://api.senderwiz.com/customer/subscribers.md) - [Get All Subscribers](https://api.senderwiz.com/customer/subscribers/get-all-subscribers.md): Retrieve all subscribers associated with a specific list. This endpoint supports pagination and returns subscriber details such as email, status, and source. - [Get One Subscriber](https://api.senderwiz.com/customer/subscribers/get-one-subscriber.md): Retrieve details of a specific subscriber from a list using their unique subscriber UID and list UID. Useful for viewing the subscriber's status, source, and personal information. - [Search Subscriber by Email](https://api.senderwiz.com/customer/subscribers/search-subscriber-by-email.md): Search and retrieve subscriber information from a specific list using the subscriber's email address. This is helpful for quickly locating a contact without knowing their UID. - [Search by Email in All Lists](https://api.senderwiz.com/customer/subscribers/search-by-email-in-all-lists.md): Search for a subscriber by email across all lists associated with the authenticated account. This is helpful when you don’t know which list a subscriber belongs to. - [Search by Custom Fields in a List](https://api.senderwiz.com/customer/subscribers/search-by-custom-fields-in-a-list.md): Search for a subscriber within a specific list using one or more custom field values. This is useful for advanced filtering beyond just email. - [Search Subscribers by Status](https://api.senderwiz.com/customer/subscribers/search-subscribers-by-status.md): Search subscribers by their status (e.g., confirmed, unsubscribed, blacklisted) within a specific list. This is useful for filtering active or inactive contacts. - [Get Blacklisted Subscribers](https://api.senderwiz.com/customer/subscribers/get-blacklisted-subscribers.md): Retrieve all subscribers marked as blacklisted within a specific list. Useful for list cleanup, suppression handling, or filtering. - [Get Confirmed Subscribers](https://api.senderwiz.com/customer/subscribers/get-confirmed-subscribers.md): Retrieve all subscribers with the status confirmed from a specified list. Useful for targeting active and verified contacts. - [Get Unconfirmed Subscribers](https://api.senderwiz.com/customer/subscribers/get-unconfirmed-subscribers.md): Retrieve all subscribers with the status unconfirmed from a specific list. Ideal for tracking pending or inactive opt-in subscribers. - [Get Unsubscribed Subscribers](https://api.senderwiz.com/customer/subscribers/get-unsubscribed-subscribers.md): Retrieve all subscribers with the status unsubscribed from a specific list. Useful for managing opt-outs and analyzing churn. - [Create a Subscriber](https://api.senderwiz.com/customer/subscribers/create-a-subscriber.md): Create a new subscriber in a specific list by submitting their email and any additional custom fields. A confirmation email will be triggered based on the list configuration. - [Create Subscribers in Bulk](https://api.senderwiz.com/customer/subscribers/create-subscribers-in-bulk.md): Create multiple subscribers at once within a specific list using their email and any optional custom fields. Efficient for large list imports or API-driven syncs. - [Update a Subscriber](https://api.senderwiz.com/customer/subscribers/update-a-subscriber.md): Update the details of an existing subscriber in a specific list by using their unique subscriber ID. Useful for correcting or modifying stored subscriber data. - [Update a Subscriber by Email](https://api.senderwiz.com/customer/subscribers/update-a-subscriber-by-email.md): Update the details of a subscriber by searching with their email address within a specific list. This method is ideal when the subscriber UID is not known in advance. - [Create or Update a Subscriber](https://api.senderwiz.com/customer/subscribers/create-or-update-a-subscriber.md): Create a new subscriber or update an existing one in a specific list. This unified endpoint handles both creation and update operations based on the email provided. - [Unsubscribe a Subscriber](https://api.senderwiz.com/customer/subscribers/unsubscribe-a-subscriber.md): Silently unsubscribe a subscriber from a list using their unique subscriber and list identifiers. No notification email is sent. - [Unsubscribe a Subscriber by Email](https://api.senderwiz.com/customer/subscribers/unsubscribe-a-subscriber-by-email.md): Silently unsubscribe a subscriber from a specific list by using their email address. No email notification will be sent. - [Unsubscribe Subscriber from All Lists](https://api.senderwiz.com/customer/subscribers/unsubscribe-subscriber-from-all-lists.md): Unsubscribe a subscriber from all lists using their email address. This is a silent operation — no confirmation email is sent. - [Delete One Subscriber](https://api.senderwiz.com/customer/subscribers/delete-one-subscriber.md): Permanently delete a subscriber from a specific list. This operation is silent — no notification email will be sent. - [Delete Subscriber by Email](https://api.senderwiz.com/customer/subscribers/delete-subscriber-by-email.md): Delete a subscriber from a list using their email address. This is a silent operation — no email will be sent to the user. - [Campaigns](https://api.senderwiz.com/customer/campaigns.md) - [Get All Campaigns](https://api.senderwiz.com/customer/campaigns/get-all-campaigns.md): Retrieve a paginated list of all campaigns associated with your SenderWiz account. You can optionally filter campaigns by a specific list UID. - [Get One Campaign](https://api.senderwiz.com/customer/campaigns/get-one-campaign.md): Retrieve full details of a specific campaign using its unique campaign identifier. - [Create a Campaign](https://api.senderwiz.com/customer/campaigns/create-a-campaign.md): Create a new campaign using the API. This can be a regular or autoresponder campaign, and allows advanced customization like segments, template content, scheduling, and optional configurations. - [Update a Campaign](https://api.senderwiz.com/customer/campaigns/update-a-campaign.md): Update an existing campaign's configuration, content, or metadata using its unique campaign UID. - [Copy a Campaign](https://api.senderwiz.com/customer/campaigns/copy-a-campaign.md): Duplicate an existing campaign using its unique campaign UID. This is useful when reusing previous campaign settings and templates. - [Pause/Unpause a Campaig](https://api.senderwiz.com/customer/campaigns/pause-unpause-a-campaig.md): Toggle the status of a campaign between "paused" and "sending" using its unique campaign UID. - [Mark a Campaign as SENT](https://api.senderwiz.com/customer/campaigns/mark-a-campaign-as-sent.md): Forcefully mark a campaign as "sent" using its unique identifier. This is useful for testing, debugging, or manually closing campaigns that are stuck. - [Delete a Campaign](https://api.senderwiz.com/customer/campaigns/delete-a-campaign.md): Permanently delete a campaign using its unique campaign UID. This action is irreversible. - [Get Stats of a Campaign](https://api.senderwiz.com/customer/campaigns/get-stats-of-a-campaign.md): Retrieve in-depth performance metrics and delivery statistics for a specific campaign using its unique identifier. - [Reports](https://api.senderwiz.com/customer/reports.md) - [Track Subscriber Click for Campaign](https://api.senderwiz.com/customer/reports/track-subscriber-click-for-campaign.md): Simulate or log a subscriber's click on a tracked campaign link using the unique campaign, subscriber, and URL hash values. - [Track Subscriber Open](https://api.senderwiz.com/customer/reports/track-subscriber-open.md): Track when a subscriber opens a campaign email using their unique subscriber and campaign identifiers. - [Track Subscriber Unsubscribe](https://api.senderwiz.com/customer/reports/track-subscriber-unsubscribe.md): Log an unsubscribe action from a subscriber for a specific campaign, optionally capturing metadata such as IP address, user agent, and reason. - [Bounces](https://api.senderwiz.com/customer/bounces.md) - [Get All Bounces](https://api.senderwiz.com/customer/bounces/get-all-bounces.md): Retrieve all bounce reports (hard and soft) related to a specific campaign using its unique identifier. - [Create a Campaign Bounce](https://api.senderwiz.com/customer/bounces/create-a-campaign-bounce.md): Manually register a bounce event for a subscriber within a campaign. Useful for syncing external bounce events into SenderWiz. - [Countries](https://api.senderwiz.com/customer/countries.md) - [Get All Countries](https://api.senderwiz.com/customer/countries/get-all-countries.md): Retrieve the list of all countries supported by SenderWiz, including country name, code, and ID. - [Get All Zones of a Country](https://api.senderwiz.com/customer/countries/get-all-zones-of-a-country.md): Retrieve all zones (states/provinces) associated with a specific country by its country ID. - [Templates](https://api.senderwiz.com/customer/templates.md) - [Get All Templates](https://api.senderwiz.com/customer/templates/get-all-templates.md): Retrieve a paginated list of email templates available for the authenticated customer account. - [Get One Template](https://api.senderwiz.com/customer/templates/get-one-template.md): Retrieve the full details of a specific email template using its unique template ID. - [Search Templates](https://api.senderwiz.com/customer/templates/search-templates.md): Search email templates based on specific filter criteria like template name. - [Create a Template](https://api.senderwiz.com/customer/templates/create-a-template.md): Create a new email template in SenderWiz using HTML content or a zip archive. - [Update a Template](https://api.senderwiz.com/customer/templates/update-a-template.md): Update an existing email template in SenderWiz by its unique identifier. - [Delete a Template](https://api.senderwiz.com/customer/templates/delete-a-template.md): Permanently delete a specific email template using its unique identifier in SenderWiz. - [Subaccounts](https://api.senderwiz.com/customer/subaccounts.md) - [Get All Subaccounts](https://api.senderwiz.com/customer/subaccounts/get-all-subaccounts.md): Retrieve all subaccounts (team members) associated with the current customer account. - [Create a Subaccount](https://api.senderwiz.com/customer/subaccounts/create-a-subaccount.md): Create a new subaccount (child user) under the current customer account. - [Update a Subaccount](https://api.senderwiz.com/customer/subaccounts/update-a-subaccount.md): Update details of an existing subaccount (child user) under your SenderWiz customer account. - [Delete a Subaccount](https://api.senderwiz.com/customer/subaccounts/delete-a-subaccount.md): Delete a subaccount (child user) from your SenderWiz customer account. - [Get Subaccount Permissions](https://api.senderwiz.com/customer/subaccounts/get-subaccount-permissions.md): Retrieve the current permission settings of a subaccount (child user) under your SenderWiz account. - [Update Subaccount Permissions](https://api.senderwiz.com/customer/subaccounts/update-subaccount-permissions.md): Update the permission settings for a specific subaccount using its unique child UID. - [Transactional Emails](https://api.senderwiz.com/customer/transactional-emails.md) - [Get All Transactional Emails](https://api.senderwiz.com/customer/transactional-emails/get-all-transactional-emails.md): Retrieve a paginated list of all transactional emails sent via the SenderWiz platform. - [Get One Transactional Email](https://api.senderwiz.com/customer/transactional-emails/get-one-transactional-email.md): Retrieve the full details of a specific transactional email by using its unique identifier. - [Create a Transactional Email](https://api.senderwiz.com/customer/transactional-emails/create-a-transactional-email.md): Create and schedule a new transactional email, with optional attachments and plain text content. - [Delete a Transactional Email](https://api.senderwiz.com/customer/transactional-emails/delete-a-transactional-email.md): Remove a specific transactional email from the system using its unique email identifier. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api.senderwiz.com/customer.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.