Skip to main content
SureContact logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 26
  • Triggers: 0
  • Slug: SURECONTACT
  • Version: 20261101_00

Tools

Slug: SURECONTACT_CREATE_CAMPAIGN_DRAFTCreate a campaign in draft status without sending or scheduling email. Optionally configure content, sender details, and tracking for later review in SureContact.

Input Parameters

string
required
Campaign name, up to 255 characters.
string
Email subject. When omitted, the selected template may supply it.
string
Reply-to email address.
string
Sender display name.
string
Sender email address.
boolean
Whether a future send of this campaign should track opens.
string
HTML email content. When omitted, the selected template may supply it.
string
Inbox preview text. When omitted, the selected template may supply it.
boolean
Whether a future send of this campaign should track link clicks.
string
Email-template UUID used to seed the subject, preview text, and HTML.
array
Tag UUIDs to exclude from the campaign audience.
array
Tag UUIDs to include in the campaign audience.
array
List UUIDs to exclude from the campaign audience.
array
List UUIDs to include in the campaign audience.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_CREATE_LANDING_PAGE_DRAFTCreate a landing page in draft status without publishing it or making a public URL live. Optionally initialize the draft from page-builder design JSON or an existing page template.

Input Parameters

string
required
Landing-page name, up to 255 characters.
string
Short description of the landing page, up to 1000 characters.
string
SureContact page-builder design JSON used to initialize the draft. The official reference labels this an object but sends an array in every request example; the internal page-builder schema is not published.
string
Page-template UUID used to initialize the draft.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_CREATE_SEGMENTCreate a tag or contact list. A dynamic list continuously evaluates its filters; a static list is manually managed.

Input Parameters

string
required
Unique display name, up to 255 characters.
string
Six-digit hex color for a tag; valid only when segment_type is tag.
object
Filter criteria object for a dynamic list. SureContact does not publish the object’s condition schema. Valid only for dynamic lists.
string ("static" | "dynamic")
List type: static or dynamic; used only when segment_type is list.
string
Optional explanation of the segment, up to 1000 characters.
string ("tag" | "list")
required
Segment to create: tag or list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_CREATE_TASKCreate an actionable workspace task linked to one or more contacts and optionally assign it. Workspace notification settings may notify the assignee.

Input Parameters

string
required
Task title, up to 255 characters.
string
Due date as an ISO-8601 date (YYYY-MM-DD) or date-time. SureContact’s documented date-time example omits a timezone.
string
Task details, up to 10,000 characters.
array
required
One or more existing contact UUIDs to associate with the task. SureContact requires every task to be linked to an entity.
string
UUID of an existing task type.
string
UUID of an existing workspace user to assign the task to.
integer
Reminder lead time in minutes; must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_ENROLL_CONTACT_IN_SEQUENCEEnroll one contact in an active sequence by UUID or email. This irreversible operation is asynchronous and can trigger sequence actions, including real external email, shortly after the request is accepted.

Input Parameters

string
Contact UUID. Provide exactly one of contact_uuid or contact_email.
string
Contact email. Provide exactly one of contact_email or contact_uuid.
string
required
UUID of the active sequence to enroll the contact in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_GET_CAMPAIGN_PERFORMANCEGet campaign details, live sending progress, or one page of per-contact delivery and engagement results without changing campaign state. Live progress is available only while the campaign is sending.

Input Parameters

string ("details" | "progress" | "contacts")
Result view: details, progress, or contacts.
string
For contacts view, continuation cursor from a previous call.
boolean
For contacts view, filter by whether the email was opened.
For contacts view, search recipient identity fields.
string ("pending" | "queued" | "sent" | "delivered" | "failed" | "bounced")
For contacts view, filter by delivery status.
boolean
For contacts view, filter by whether a link was clicked.
integer
For contacts view, maximum recipients on this page (1-100).
string
required
UUID of the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_GET_CONTACTRetrieve one contact by UUID or email address without changing it.

Input Parameters

string
Contact email address; provide exactly one of email or contact_uuid.
string
Contact UUID; provide exactly one of contact_uuid or email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_GET_REPORTRead one SureContact analytics report for a selected date range: overview, contact growth, email sending, email engagement, link clicks, unsubscribes, bounces, ecommerce revenue, products, or campaign summary.

Input Parameters

integer
For link_clicks or products, maximum ranked items (up to 500 or 100 respectively).
string ("all" | "wordpress" | "shopify" | "api" | "manual")
For revenue, filter by purchase source.
string ("all" | "sent" | "draft" | "scheduled" | "sending")
For campaigns, filter by campaign status.
string
ISO date required when date_range is custom.
string ("day" | "week" | "month")
Time grouping: day, week, or month.
string ("today" | "yesterday" | "7_days" | "30_days" | "90_days" | "12_months" | "custom")
Date range: today, yesterday, 7_days, 30_days, 90_days, 12_months, or custom.
string
ISO date required when date_range is custom.
string ("all" | "hard" | "soft")
For bounces, filter all, hard, or soft bounces.
string ("overall" | "tag" | "list")
For contacts_growth, filter overall contacts, one tag, or one list.
string
Tag or list UUID required for a tag/list contacts_growth filter.
string ("overview" | "contacts_growth" | "emails_sending" | "emails_engagement" | "link_clicks" | "unsubscribes" | "bounces" | "revenue" | "products" | "campaigns")
required
Report to return: overview, contacts_growth, emails_sending, emails_engagement, link_clicks, unsubscribes, bounces, revenue, products, or campaigns.
string ("none" | "previous_period" | "previous_month" | "previous_year" | "custom")
Comparison: none, previous_period, previous_month, previous_year, or custom.
string
For link_clicks, optionally restrict results to this campaign UUID.
string
ISO comparison end date required when compare_with is custom.
string
ISO comparison start date required when compare_with is custom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_CAMPAIGNSSearch and page through email campaigns by lifecycle status without changing them.

Input Parameters

string
Continuation cursor returned by a previous call.
string
Search campaign names or subjects.
string ("draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "failed")
Campaign lifecycle status to return.
string ("name" | "status" | "send_at" | "scheduled_at" | "completed_at" | "created_at" | "updated_at")
Campaign field used to sort the results.
integer
Maximum campaigns to return on this page (1-100).
string ("asc" | "desc")
Sort direction: asc or desc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_CONTACTSSearch and page through contacts in the connected workspace without changing them.

Input Parameters

string
Continuation cursor returned by a previous call.
string
Search text for matching contacts, up to 100 characters.
integer
Maximum contacts to return on this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_CONTACT_TIMELINEPage through either notes or activities for one contact, newest first, without changing the timeline.

Input Parameters

integer
For activities, restrict results to the last N days.
string
Continuation cursor returned by a previous call.
string
For activities, include entries through this ISO-8601 date or date-time.
integer
Maximum entries to return on this page (1-100).
string
For activities, include entries from this ISO-8601 date or date-time.
string ("note" | "activity")
required
Timeline entries to return: note or activity.
string
required
UUID of the contact.
string ("email_sent" | "email_opened" | "email_clicked" | "form_submitted" | "note_added" | "note_updated" | "note_deleted" | "tag_added" | "tag_removed" | "contact_created" | "contact_updated" | "list_added" | "list_removed" | "custom_field_added" | "custom_field_updated" | "custom_field_deleted" | "purchase_completed" | "purchase_cancelled" | "purchase_refunded")
For activities, filter by a documented SureContact activity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_FORM_SUBMISSIONSSearch and page through submissions captured by one form without changing them.

Input Parameters

string
Continuation cursor returned by a previous call.
string
Search submission fields, up to 100 characters.
string
Exact submission status to return. SureContact exposes this filter but does not publish accepted values; omit it unless the status is known from the workspace.
string
Include submissions on or before this valid date or date-time.
integer
Maximum submissions to return on this page (1-100).
string
required
UUID of the form whose submissions to return.
string
Include submissions on or after this valid date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_MARKETING_ASSETSList one page of forms, email templates, or landing pages available for campaigns and lead capture.

Input Parameters

string
Continuation cursor returned by a previous call.
string
Search assets by name or provider-supported text fields.
string ("draft" | "published" | "scheduled" | "archived")
For forms, filter by draft or published. For landing pages, filter by draft, published, scheduled, or archived.
string ("name" | "subject" | "created_at" | "updated_at" | "submission_count" | "view_count" | "status")
Provider-supported sort field for the selected asset type.
integer
Maximum assets on this page (1-100).
string ("form" | "email_template" | "landing_page")
required
Asset resource: form, email_template, or landing_page.
string ("asc" | "desc")
Sort direction: asc or desc.
string ("drag_drop" | "html" | "rich_text")
For email templates, filter by drag_drop, html, or rich_text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_PURCHASESPage through tracked purchases with optional contact, status, and source filters.

Input Parameters

string
Continuation cursor returned by a previous call.
string
Exact purchase source to return. SureContact exposes this filter but does not publish its accepted values.
string
Exact purchase status to return. SureContact exposes this filter but does not publish its accepted values.
integer
Maximum purchases to return on this page (1-100).
string
Only return purchases associated with this contact UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_SEGMENTSList tags or lists used to segment contacts, with search and archive filtering where supported.

Input Parameters

string
Continuation cursor returned by a previous call.
string
For tags, search by name or slug.
string ("false" | "true" | "all")
Archive filter: false for active, true for archived, or all.
integer
Maximum segments on this page (1-100).
string ("tag" | "list")
required
Segment resource to list: tag or list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_TASKSPage through workspace tasks without changing completion or assignment state.

Input Parameters

string
Continuation cursor returned by a previous call.
integer
Maximum tasks to return on this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LIST_WORKFLOWSList automations or email sequences available in the workspace without starting them.

Input Parameters

string
Continuation cursor returned by a previous call.
string
For sequences, filter by sequence name.
string ("draft" | "active" | "inactive")
For sequences, filter by status.
integer
Maximum workflows on this page (1-100).
string ("automation" | "sequence")
required
Workflow resource to list: automation or sequence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_LOG_CONTACT_INTERACTIONCreate a note or activity on a contact’s timeline, attributed to the API-key owner.

Input Parameters

string
Optional note title, up to 255 characters. Valid only for notes.
string
required
Note content or activity description. Notes allow up to 10,000 characters; activities allow up to 1,000 characters.
object
Optional activity metadata as key-value pairs. Valid only for activities.
string ("note" | "activity")
required
Timeline entry to create: note or activity.
string
required
UUID of the contact receiving the timeline entry.
string ("email_sent" | "email_opened" | "email_clicked" | "form_submitted" | "note_added" | "note_updated" | "note_deleted" | "tag_added" | "tag_removed" | "contact_created" | "contact_updated" | "list_added" | "list_removed" | "custom_field_added" | "custom_field_updated" | "custom_field_deleted" | "purchase_completed" | "purchase_cancelled" | "purchase_refunded")
SureContact activity type. Required for activities and invalid for notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_RECORD_PURCHASERecord an external purchase in SureContact without charging a payment method. Identifying the buyer by email may create a new contact.

Input Parameters

string ("completed" | "cancelled" | "refunded" | "pending")
Purchase status: completed, cancelled, refunded, or pending.
string
Three-character currency code.
number
Total discount amount in the purchase currency.
object
Additional purchase metadata as key-value pairs.
string
required
Unique order identifier from the source system. SureContact names this field order_id in create requests and responses.
array
Structured product line items included in the purchase.
number
Tax amount in the purchase currency.
string
Applied coupon code.
string
Existing contact UUID; provide exactly one contact identifier.
string
ISO-8601 timestamp when the purchase occurred.
number
required
Total order amount in the specified currency.
string
Contact email address; SureContact may create the contact if it does not exist. Provide exactly one contact identifier.
string
Payment transaction identifier.
number
Shipping amount in the purchase currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_SEND_EMAILQueue one email for immediate asynchronous delivery to one external recipient. Executing this action sends a real external email and may create engagement tracking events; it does not create a draft or preview and cannot be undone.

Input Parameters

string
Subject sent in the external email. Required with html_body when no template is used; this is delivery content, not draft or preview content.
string
Reply-to address placed on the external email that this action sends; no draft or preview is created.
string
Sender display name used on the external email that this action sends; no draft or preview is created.
string
HTML delivered in the external email. Required with subject when no template is used; calling this action sends it rather than saving a draft or preview.
object
Variables substituted into the template before the external email is sent; these values are not used for a draft or preview.
string
Sender address used on the external email that this action sends; no draft or preview is created.
boolean
Whether to track opens of the externally delivered email; execution sends rather than drafts or previews the message.
string
UUID of the recipient who will receive the real external email. Provide exactly one recipient identifier; this action does not create a draft or preview.
boolean
Whether to track link clicks in the externally delivered email; execution sends rather than drafts or previews the message.
string
Address that will receive the real external email. Provide exactly one recipient identifier; this action does not create a draft or preview.
string
Workspace email-template UUID whose content will be sent externally. Inline subject or HTML overrides template values; no draft or preview is created.
string
SMTP configuration used for the real external send. Omit to use the workspace default; this action does not create a draft or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_SET_CONTACT_STATUSChange a contact’s deliverability or subscription status. Setting unsubscribed, bounced, invalid, or complained can stop future messaging.

Input Parameters

string ("pending" | "active" | "unsubscribed" | "bounced" | "invalid" | "complained")
required
New status: pending, active, unsubscribed, bounced, invalid, or complained.
string
required
UUID of the contact to change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_SET_TASK_COMPLETIONMark a task done or reopen it as not done. This immediately changes the task’s completion state.

Input Parameters

boolean
required
Set true to mark the task done, or false to reopen it as not done.
string
required
UUID of the task whose completion state should change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_START_CONTACT_AUTOMATIONStart an active automation for one contact. This irreversible operation is asynchronous and can trigger actions, including real external email, shortly after the request is accepted; it does not wait for those actions to finish.

Input Parameters

string
required
UUID of the contact to start the automation for.
string
required
UUID of the active automation to start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_UNENROLL_CONTACT_FROM_SEQUENCESynchronously cancel a contact’s active executions in a sequence and mark its subscriber state as cancelled. The response reports cancelled_executions; zero means the idempotent request found no active execution. Actions already sent or completed cannot be undone.

Input Parameters

string
Contact UUID. Provide exactly one of contact_uuid or contact_email.
string
Contact email. Provide exactly one of contact_email or contact_uuid.
string
required
UUID of the sequence to unenroll the contact from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_UPDATE_CONTACT_MEMBERSHIPSAttach or detach one or more tags or lists from a contact, then verify the memberships by reading the contact. The update can affect segmentation and targeting; verification can fail after the change has been submitted.

Input Parameters

string ("attach" | "detach")
required
Whether to attach or detach the memberships.
string
required
UUID of the contact whose memberships change.
string ("tag" | "list")
required
Membership type to update: tag or list.
array
required
One or more tag or list UUIDs matching resource_type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SURECONTACT_UPSERT_CONTACTCreate a contact when the email is new or update the existing contact with supplied fields. Supplied tag and list UUIDs are appended and never replace existing memberships.

Input Parameters

string
required
Email address that uniquely identifies the contact.
string
Contact phone number.
string
Acquisition source such as api, manual, import, form, or integration.
string ("pending" | "active" | "unsubscribed" | "bounced" | "invalid" | "complained")
Contact status: pending, active, unsubscribed, bounced, invalid, or complained.
string
Contact company name. This does not use the paid Companies resource.
string
Preferred ISO 639-1 two-letter language code.
object
Additional contact metadata as key-value pairs.
string
Preferred IANA timezone identifier.
string
Contact job title.
string
Contact last name.
array
Tag UUIDs to append to the contact without replacing existing tags.
string
Contact first name.
array
Static-list UUIDs to append to the contact without replacing existing list memberships.
object
Custom field values keyed by field name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not