Mailsoftly

Changes the role of somebody who already belongs to this workspace, from the user_id list_team_members returns and the new role. The roles this account can assign are documented in the request schema. The workspace owner and the caller keep the role they have. Requires the 'account:write' OAuth scope.

update_team_member_role

Controls the public side of a campaign, from the campaign id with web_version, show_in_archive or regenerate_public_link: taking a delivered campaign off the web, listing it in the account's public archive, or retiring and replacing a public link that leaked. The response carries the new public_url. Requires the 'campaigns:draft' OAuth scope.

update_campaign_sharing

Reports where an email draft stands, given its id: its status ('Draft', 'sending', 'Sent'), its ready_to_send flag and a sender object with the lane, the from address and authorized. It is the readiness check before send_campaign: after draft_campaign with recipients or attachments a background job takes roughly 5 to 15 seconds. list_campaigns and draft_campaign hold the id. Requires the 'campaigns:read' OAuth scope.

get_campaign_status

Copies a campaign into a brand new draft, from the campaign id and an optional name. It is how a campaign is sent again or a new version of an earlier newsletter starts; the returned draft id is what update_campaign edits before a send. Requires the 'campaigns:draft' OAuth scope.

duplicate_campaign

Creates a signup or lead form from name and a fields array, each field with its name, label, type, required flag and options, plus an optional contact_list_id submitters join and a tag_id applied to them. An email field is part of every form. Returns the form with its fields and its embed token. list_forms holds the forms already defined. Requires the 'contacts:write' OAuth scope.

create_form

Creates a landing page as an unpublished draft from complete html, taking name and html plus an optional meta_title, meta_description, goal and contact_list_id for lead capture. Returns the page with its future public url. publish_landing_page puts the page on the web, and list_landing_pages holds the pages already defined. Requires the 'campaigns:draft' OAuth scope.

create_landing_page

Creates one contact on the account. email is required; first_name, last_name, company, job_title, mobile_phone, work_phone, website, address, country, city, state, zip_code and note are optional. email is unique within the account, so a second contact with the same address comes back as a validation error rather than a merge. search_contacts finds an address already on file. Returns the created contact with its new id. Requires the 'contacts:write' OAuth scope.

create_contact

Creates a new, empty contact list under a given name; add_contact_to_contact_list then populates it. List names are not unique, so a second call with the same name leaves two lists sharing it and later sends become ambiguous; list_contact_lists holds the names already in use. Returns the new list including its contact_list_id. Requires the 'contacts:write' OAuth scope.

create_contact_list

Creates a saved segment from conditions on contact fields, from name, an optional description and a conditions object of groups, each group joining its own field conditions. The field operators are documented in the request schema. The member count is calculated in the background, and list_segments carries it once it lands. Requires the 'contacts:write' OAuth scope.

create_segment

Creates a from address on one of the account's verified domains, from `from` plus an optional reply_to and display_name. list_domains carries the verified domains and add_domain starts authenticating a new one. The new address then appears in list_senders for use on a draft. Requires the 'campaigns:draft' OAuth scope.

create_sender

Creates a tag from a name, with an optional color as a hex value. A name already in use comes back as the existing tag with its id, which makes a call before assign_tags_to_contact idempotent. list_tags holds the names already on the account. Returns the tag with its tag_id. Requires the 'contacts:write' OAuth scope.

create_tag

Creates an inbound webhook endpoint by name and returns its POST url. Its id is the trigger.endpoint_id of an automation with a webhook trigger. Requires the 'contacts:write' OAuth scope.

create_webhook_endpoint

Creates an SMS campaign draft: contact_list_id, message_body, optional name, sender_number (a verified number on the account) and tracking_enabled. The response carries the estimated credits. Sending is a separate call. Requires the 'campaigns:draft' OAuth scope.

create_sms_campaign

Creates an automation from the same vocabulary as the in-app builder, saved inactive. Takes name, a trigger object carrying its event and that event's target id, and steps as an ordered array; entry_filter, extra_triggers, run_once_per_contact and time_zone are optional. The events, the step kinds and their fields are documented in the request schema. Ids come from list_contact_lists, list_tags, list_email_templates, list_forms and list_senders. Returns the automation with its steps. Requires the 'campaigns:draft' OAuth scope.

create_automation

Creates an HTML email signature for the connected user, from a name and html, so drafts and replies can carry it. list_signatures holds the signatures already saved, and update_signature changes one in place. Requires the 'campaigns:draft' OAuth scope.

create_signature

Saves a reusable email template from complete HTML: name, subject and html. Its id is what draft_campaign's template_id and an automation's send_email step take. Requires the 'campaigns:draft' OAuth scope.

create_email_template

Creates a subscription category (email type) from a name, an optional description and an optional contact_list_id it feeds. list_email_types holds the categories already defined. Returns the new email type with its id. Requires the 'contacts:write' OAuth scope.

create_email_type

Creates an email campaign in the account as a draft. Takes subject, and usually body with body_format, name and an audience: contact_list_id for an existing list, or a recipients array of objects with email, first_name and last_name. sender_id and email_sender_id come from list_senders, template_id from list_email_templates and contact_list_id from list_contact_lists. Returns status and drafts, each draft with its id. update_campaign edits an existing draft in place. Requires the 'campaigns:draft' OAuth scope.

draft_campaign

Updates the contact whose contact_id is passed. Without contact_id, updates the contact that already has the given email (matched without regard to case), or creates one when none does. Returns status, a message of 'Contact created' or 'Contact updated', and the contact. Requires the 'contacts:write' OAuth scope.

create_or_update_contact

Defines a new custom field for contacts (name, type text|number|date|select|multi_select, options for select types). Values are then set in the app or through the REST endpoint add_custom_field_to_contact, which is not one of these tools. Idempotent for an existing name. Requires the 'contacts:write' OAuth scope.

create_custom_field

Deletes one contact by contact_id, along with its list memberships, tags and activity. unsubscribe_contact stops mail to the address and keeps the record. search_contacts supplies the id. Requires the 'contacts:write' OAuth scope.

delete_contact

Deletes a list by contact_list_id. The contacts on the list stay in the account and keep their other list memberships. Requires the 'contacts:write' OAuth scope.

delete_contact_list

Deletes a saved block by custom_block_id. Campaigns already built from it keep their HTML, but the block itself is gone. Requires the 'campaigns:draft' OAuth scope.

delete_custom_block

Deletes a form by form_id, along with its embed and its stored submissions. Contacts the form created stay on the account, and a form an automation starts from stays in place instead. list_forms holds the ids. Requires the 'contacts:write' OAuth scope.

delete_form

Deletes a custom segment by segment_id, and the contacts in it stay on the account. A system segment stays in place instead. list_segments holds the ids, and update_segment changes a custom segment's rules. Requires the 'contacts:write' OAuth scope.

delete_segment

Deletes a tag by tag_id, taking it off every contact that carries it. A tag an automation starts from stays in place instead. list_tags holds the ids, and remove_tags_from_contact takes a tag off one contact. Requires the 'contacts:write' OAuth scope.

delete_tag

Deletes a webhook endpoint by endpoint_id. Its url stops receiving events as soon as the call returns. Requires the 'contacts:write' OAuth scope.

delete_webhook_endpoint

Deletes an automation by id. The automation has to be inactive first, which update_automation_status makes it. Requires the 'campaigns:draft' OAuth scope.

delete_automation

Deletes an email signature by signature_id. It leaves the signature picker, and campaigns already sent keep the signature in their content. Requires the 'campaigns:draft' OAuth scope.

delete_signature

Deletes a saved template by template_id. A template an automation step still sends stays in place instead, and drafts already built from the template keep their content. list_email_templates holds the ids. Requires the 'campaigns:draft' OAuth scope.

delete_email_template

Deletes an unsent (draft or trashed) campaign by id for good, unlike trash_campaign, which restore_campaign can undo. A sent campaign keeps its reports and stays; trash it instead. It also frees a contact list that delete_contact_list keeps while a draft campaign still targets it. Requires the 'campaigns:draft' OAuth scope.

delete_campaign

Enrolls one contact in an active automation, from automation_id and either contact_id or email. The automation steps then run in the background. list_automations holds the automation id and search_contacts the contact id. Returns status, message, automation_id, contact_id and enrollment_id. Requires the 'campaigns:send' OAuth scope.

enroll_contact_in_automation

Reports what one contact still receives from this account, from the contact id: each email type with its subscribed flag, opted_out_by and opted_out_at, plus email_sending_status, globally_unsubscribed and suppressed. update_contact_subscriptions changes the email types a contact takes. Requires the 'contacts:read' OAuth scope.

get_contact_subscriptions

Reads one signup or lead form by id: its fields, the contact list it feeds, its submission count and its embed token. list_forms holds the ids, and get_form_responses pages through the submissions themselves. Requires the 'contacts:read' OAuth scope.

get_form

Reports the full performance picture for one sent campaign, from the campaign id: opens, clicks, bounces, unsubscribes and complaints with their rates, the account average alongside them, the mailbox providers and recipient domains that engaged, and a timeline of how fast opens and clicks arrived. get_campaign_stats carries the headline numbers on their own. Requires the 'campaigns:read' OAuth scope.

get_campaign_report

Reads one landing page by id: its public url, meta title and description, goal, and the contact list it captures leads into. list_landing_pages holds the ids, and update_landing_page changes these values. Requires the 'campaigns:read' OAuth scope.

get_landing_page

Reads one contact by its numeric id, which search_contacts returns for a person named in words. The default response holds id, first_name, last_name and email; type='detailed' adds company, job title, address, subscription state, custom fields and timestamps. It reports what is currently on file, which is the state an update would change. Requires the 'contacts:read' OAuth scope.

get_contact

Reads the account: plan tier, sending limits with their usage, contact count against the plan limit, connected sending channels, plan entitlements and the current rate limits. list_senders covers the from addresses the account can send campaigns from, and list_team_members the people on it. Requires the 'account:read' OAuth scope.

get_account

Reads one SMS campaign by id, including its message body, status, audience list and send date. list_sms_campaigns holds the ids, update_sms_campaign changes a draft and send_sms_campaign submits one. Requires the 'campaigns:read' OAuth scope.

get_sms_campaign

Reads one automation by id: its name, status, trigger and the ordered steps it runs. Read-only; it describes what a specific automation does and whether it is active. Requires the 'campaigns:read' OAuth scope.

get_automation