directiq_account_overview
Account Overview
Summarize the account in one call: total contacts, active/disabled status counts, list count, tag count, and confirmed sender addresses. A good first call in a conversation, and the way to find a valid "from" address for directiq_send_email. Each section that fails to load is returned as { error } without failing the rest.
Takes no parameters.
directiq_get_contact
Get Contact
Get one contact by numeric ID: email, first and last name, status, created and updated dates, tags, lists, and notes. Use when you already have the ID; to find a contact, page through directiq_list_contacts. Returns an error if no contact has that ID.
Parametersidrequired
directiq_list_contacts
List Contacts
List contacts one page at a time, oldest first, with each contact's ID, email, name, status, tags, and lists. Returns { pageNumber, totalCount, result, hasNextPage }; request the next pageNumber while hasNextPage is true. Use to browse contacts or find an ID. For just the total, use directiq_contact_count instead.
ParameterspageSizepageNumber
directiq_contact_count
Contact Count
Return the total number of contacts in the account as a single number. Use for a quick count; for counts plus active/disabled status, lists, tags, and senders, use directiq_account_overview.
Takes no parameters.
directiq_upsert_contact
Add or Update Contact
Add a contact to a list, creating the contact if the email is new or updating its name if it already exists. Optionally applies tags (created if missing). Use this to create contacts; to change other fields on an existing contact, use directiq_update_contact. Returns import counts (inserted, alreadyExisting, addedToList); emails on a suppression or bounce list are counted but not added.
ParameterstagsemailrequiredlistIdrequiredlastNamefirstName
directiq_update_contact
Update Contact
Update fields on an existing contact by ID, such as firstName, lastName, or email. Only the fields you pass change, and they overwrite the current values. To create a contact, use directiq_upsert_contact; to change list or tag membership, use the list and tag tools.
Parametersidrequiredfieldsrequired
directiq_delete_contact
Delete Contact
Permanently delete a contact by ID, removing it from every list and tag. This cannot be undone. Confirm with the user first; to only take a contact off one list, use directiq_remove_contact_from_list.
Parametersidrequired
directiq_list_lists
List Contact Lists
List every contact list in the account with its ID and name. Use to find a list ID before adding contacts, sending campaigns, or calling directiq_get_list.
Takes no parameters.
directiq_get_list
Get Contact List
Get one contact list by ID: name, created and modified dates, and total, active, and disabled contact counts. Use directiq_list_lists to find the ID. Returns an error if no list has that ID.
Parametersidrequired
directiq_create_list
Create Contact List
Create a new, empty contact list and return it with its new ID. Calling it twice creates two lists with the same name, so check directiq_list_lists first. Add contacts afterwards with directiq_upsert_contact or directiq_add_contact_to_list.
Parametersnamerequired
directiq_rename_list
Rename Contact List
Rename a contact list by ID. Its contacts are unchanged; the previous name is overwritten.
Parametersidrequirednamerequired
directiq_delete_list
Delete Contact List
Permanently delete a contact list by ID. The contacts themselves are kept, but their membership in this list is lost. This cannot be undone; confirm with the user first.
Parametersidrequired
directiq_add_contact_to_list
Add Contact to List
Add an existing contact (by contact ID) to a list. Adding a contact that is already on the list has no effect. To add someone by email who may not exist yet, use directiq_upsert_contact.
ParameterslistIdrequiredcontactIdrequired
directiq_remove_contact_from_list
Remove Contact from List
Remove a contact from one list. The contact stays in the account and on its other lists; to delete the contact entirely, use directiq_delete_contact.
ParameterslistIdrequiredcontactIdrequired
directiq_list_segments
List Segments
List saved segments (rule-based groups of contacts) with their IDs and names. Returns an empty array if the account has none. Segments are managed in the DirectIQ dashboard.
Takes no parameters.
directiq_list_tags
List Tags
List every tag in the account with its ID and name. Use to check whether a tag exists or to find its ID before renaming or deleting it.
Takes no parameters.
Get one tag by ID with its name and details. Use directiq_list_tags to find the ID. Returns an error if no tag has that ID.
Parametersidrequired
directiq_create_tag
Create Tag
Create a new tag and return it with its ID. Check directiq_list_tags first to avoid duplicates. To tag a contact, use directiq_tag_contact, which also creates missing tags.
Parametersnamerequired
directiq_rename_tag
Rename Tag
Rename a tag by ID. Contacts keep the tag under its new name; the previous name is overwritten.
Parametersidrequirednamerequired
directiq_delete_tag
Delete Tag
Permanently delete a tag by ID and remove it from every contact. Contacts are kept. This cannot be undone; confirm with the user first.
Parametersidrequired
directiq_tag_contact
Tag Contact
Apply one or more tags to a contact by contact ID. Tags that do not exist yet are created. Applying a tag the contact already has has no effect.
ParameterstagsrequiredcontactIdrequired
directiq_untag_contact
Untag Contact
Remove a tag from a contact, identified by the contact email and the tag name. The tag itself and the contact are kept; to delete the tag everywhere, use directiq_delete_tag.
Parameterstagrequiredemailrequired
directiq_list_campaigns
List Campaigns
List email campaigns and automation flows with ID, name, type (Regular or Flow), status, subject, sender, target lists, recipient count, and scheduled send time. Returns { campaigns, nextPageToken }; pass nextPageToken back to get the next page (null means no more). Use the IDs with directiq_campaign_stats for performance.
ParametersnextPageToken
directiq_get_campaign
Get Campaign
Get one campaign by ID: name, type, status, subject, sender, target lists and segments, template ID, recipient count, and scheduled send time. For opens, clicks, and other results, use directiq_campaign_stats.
Parametersidrequired
directiq_campaign_stats
Campaign Stats
Summarize how a campaign performed: counts of recipients, opens, clicks, bounces, unsubscribes, and complaints, plus open, click, bounce, and unsubscribe rates as percentages of recipients. Use directiq_campaign_report to see which contacts did what. A section that fails to load is returned as an error without failing the rest.
ParameterscampaignIdrequired
directiq_campaign_report
Campaign Report
List the contacts behind one campaign result, one page at a time: who received, opened, clicked, bounced, unsubscribed, or complained. Returns { totalCount, result }. Optionally filter to one email address, or for clicks, to one link. For totals and rates only, use directiq_campaign_stats.
ParameterslinktyperequiredemailpageSizecampaignIdrequiredpageNumber
directiq_send_email
Send Transactional Email
Send one transactional email (a receipt, confirmation, or one-to-one message) immediately. It is delivered to real recipients and cannot be recalled, and it counts toward the account’s sending plan. The from address must be a confirmed sender on the account (see directiq_account_overview). Not for bulk marketing: campaigns are sent from the DirectIQ dashboard.
ParameterscctorequiredbccfromrequiredcontentrequiredsubjectrequiredfromName
directiq_list_endpoints
List DirectIQ Endpoints
List known DirectIQ API operations (HTTP method, API group, path, summary). Optionally filter by a search term. Call GET operations with directiq_read_request and POST/PUT/PATCH/DELETE operations with directiq_write_request.
Parameterssearch
directiq_read_request
DirectIQ Read Request
Issue an authenticated GET request to any DirectIQ endpoint and return the JSON response. Prefer a dedicated directiq_* tool when one exists; use this for read operations without one, found with directiq_list_endpoints (e.g. segments for a contact, email client reports). Full request/response schemas for each group are in the DirectIQ API docs at https://rest.directiq.com/{group}/swagger/index.html (core, contacts, subscription).
Parameterspathrequiredgrouprequiredquery
directiq_write_request
DirectIQ Write Request
Issue an authenticated POST, PUT, PATCH, or DELETE request to any DirectIQ endpoint. May create, modify, or permanently delete account data, including bulk operations. Prefer a dedicated directiq_* tool when one exists; use this only for operations without one, found with directiq_list_endpoints, and confirm destructive calls with the user first. Full request/response schemas for each group are in the DirectIQ API docs at https://rest.directiq.com/{group}/swagger/index.html (core, contacts, subscription).
Parametersbodypathrequiredgrouprequiredquerymethodrequired