Servers Playground How we check Add a server Log in

NewsMAN MCP by usefulapi

Working

io.usefulapi/newsmanv1.0.0 Domain verified

Read NewsMAN lists, subscribers, segments, newsletter and automation stats; manage subscribers.

Marketing & SEO

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://newsman.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

newsman_add_subscriber_tags

WRITE: add tags to a subscriber (existing tags stay). POST /v2/subscriber/addTags.

tagsarray, required

Tags to add.

subscriber_idstring, required

NewsMAN subscriber id.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

NewsMAN MCP by usefulapi MCP server | mcptry

Tools (26)

newsman_add_subscriber_tags

WRITE: add tags to a subscriber (existing tags stay). POST /v2/subscriber/addTags.

Argument	Type	Description
tags*	array	Tags to add.
subscriber_id*	any	NewsMAN subscriber id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscriber_id",
    "tags"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "Tags to add."
    },
    "subscriber_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN subscriber id."
    }
  }
}

newsman_add_subscriber_to_segment

WRITE: add a subscriber to a (static) segment. POST /v2/subscriber/addToSegment.

Argument	Type	Description
segment_id*	any	NewsMAN segment id.
subscriber_id*	any	NewsMAN subscriber id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscriber_id",
    "segment_id"
  ],
  "properties": {
    "segment_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN segment id."
    },
    "subscriber_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN subscriber id."
    }
  }
}

newsman_count_list_subscribers

The number of active (subscribed) subscribers of a list. GET /v2/list/count.

read-only

Argument	Type	Description
list_id*	any	NewsMAN list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id"
  ],
  "properties": {
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    }
  }
}

newsman_count_segment_subscribers

The number of active subscribers in a segment. GET /v2/segment/count.

read-only

Argument	Type	Description
segment_id*	any	NewsMAN segment id (from newsman_list_segments).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "segment_id"
  ],
  "properties": {
    "segment_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN segment id (from newsman_list_segments)."
    }
  }
}

newsman_get_automation

One automation workflow: name, type, status, version, recurrence, stats and preview links. GET /v2/automation/getWorkflow.

read-only

Argument	Type	Description
workflow_id*	any	NewsMAN workflow id (from newsman_list_automations).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "workflow_id"
  ],
  "properties": {
    "workflow_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN workflow id (from newsman_list_automations)."
    }
  }
}

newsman_get_automation_stats

Daily stats of the automations of a list: sends, opens, clicks, purchases, bounces, unsubscribes. Optionally for given workflows and a period (last N days, or start_date/stop_date; at most 90 days). GET /v2/automation/stats.

read-only

Argument	Type	Description
days	integer	The last N days, 1-90 (alternative to start_date/stop_date; NewsMAN allows at most 90 days).
list_id*	any	NewsMAN list id.
stop_date	string	End of the period, UTC, YYYY-MM-DD.
start_date	string	Start of the period, UTC, YYYY-MM-DD.
workflow_ids	string	Comma-separated workflow ids (default: all workflows of the list).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id"
  ],
  "properties": {
    "days": {
      "type": "integer",
      "maximum": 90,
      "minimum": 1,
      "description": "The last N days, 1-90 (alternative to start_date/stop_date; NewsMAN allows at most 90 days)."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    },
    "stop_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End of the period, UTC, YYYY-MM-DD."
    },
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start of the period, UTC, YYYY-MM-DD."
    },
    "workflow_ids": {
      "type": "string",
      "pattern": "^[\\w-]+(,[\\w-]+)*$",
      "maxLength": 500,
      "description": "Comma-separated workflow ids (default: all workflows of the list)."
    }
  }
}

newsman_get_import_status

Status of a background subscriber import by import_id: new, running, finished or error, with times and the last error. GET /v2/import/status.

read-only

Argument	Type	Description
import_id*	any	NewsMAN import id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "import_id"
  ],
  "properties": {
    "import_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN import id."
    }
  }
}

newsman_get_list

Properties of one list: sender name and email, owner contact details, site, link parameters, send rate. The list secret is never returned. GET /v2/list/getProps.

read-only

Argument	Type	Description
list_id*	any	NewsMAN list id (from newsman_list_lists).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id"
  ],
  "properties": {
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id (from newsman_list_lists)."
    }
  }
}

newsman_get_list_growth

Daily evolution of a list: total and eligible subscribers, unsubscribes, spam reports and hard bounces per day. Give `days` (last N days) OR start_date/stop_date; the period is at most 90 days. GET /v2/list/subscribersEvolution.

read-only

Argument	Type	Description
days	integer	The last N days, 1-90 (alternative to start_date/stop_date; NewsMAN allows at most 90 days).
list_id*	any	NewsMAN list id.
stop_date	string	End of the period, UTC, YYYY-MM-DD.
start_date	string	Start of the period, UTC, YYYY-MM-DD.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id"
  ],
  "properties": {
    "days": {
      "type": "integer",
      "maximum": 90,
      "minimum": 1,
      "description": "The last N days, 1-90 (alternative to start_date/stop_date; NewsMAN allows at most 90 days)."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    },
    "stop_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End of the period, UTC, YYYY-MM-DD."
    },
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start of the period, UTC, YYYY-MM-DD."
    }
  }
}

newsman_get_newsletter

Properties of one newsletter: subject, sender, status, dates, segments, links to the online view. Long HTML is clipped. GET /v2/newsletter/getProps.

read-only

Argument	Type	Description
newsletter_id*	any	NewsMAN newsletter id (from newsman_list_newsletters).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "newsletter_id"
  ],
  "properties": {
    "newsletter_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN newsletter id (from newsman_list_newsletters)."
    }
  }
}

newsman_get_newsletter_clicked_links

The links clicked in one newsletter with the number of clicks and the last click time. GET /v2/newsletter/linksClicked.

read-only

Argument	Type	Description
newsletter_id*	any	NewsMAN newsletter id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "newsletter_id"
  ],
  "properties": {
    "newsletter_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN newsletter id."
    }
  }
}

newsman_get_newsletter_stats

Delivery and engagement stats of one newsletter: sent, views, clicks, unsubscribes, bounces, spam reports and rates. GET /v2/newsletter/stats.

read-only

Argument	Type	Description
newsletter_id*	any	NewsMAN newsletter id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "newsletter_id"
  ],
  "properties": {
    "newsletter_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN newsletter id."
    }
  }
}

newsman_get_subscriber

One subscriber of a list by email address: status and dates, name, IP, custom properties and segments. GET /v2/subscriber/getByEmail.

read-only

Argument	Type	Description
email*	string	Email address.
list_id*	any	NewsMAN list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id",
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 320,
      "minLength": 3,
      "description": "Email address."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    }
  }
}

newsman_get_subscriber_by_id

One subscriber by subscriber_id: status and dates, name, IP, custom properties and segments. GET /v2/subscriber/get.

read-only

Argument	Type	Description
subscriber_id*	any	NewsMAN subscriber id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscriber_id"
  ],
  "properties": {
    "subscriber_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN subscriber id."
    }
  }
}

newsman_get_subscriber_history

The last 100 actions of a subscriber: subscribe, unsubscribe, send, view, click, bounce, spam, each with a date and metadata (newsletter, link). GET /v2/subscriber/history.

read-only

Argument	Type	Description
subscriber_id*	any	NewsMAN subscriber id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscriber_id"
  ],
  "properties": {
    "subscriber_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN subscriber id."
    }
  }
}

newsman_list_automations

Automation workflows of a list with workflow_id, name, type, status (0 inactive, 1 active), version and stats. Filter by name, status and last-updated range. GET /v2/automation/all.

read-only

Argument	Type	Description
name	string	Workflow name filter (default: any).
type	string	Workflow type: all (default), sub_date, newsletter_view, newsletter_click, advanced, unsub, manual, ecommerce_cart_update, ecommerce_order_completed, ecommerce_product_view, segment_add, segment_remove, productalert_stock, productalert_price.
status	string	all (default), 0 inactive or 1 active.
list_id*	any	NewsMAN list id.
stop_date	string	Updated on or before, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss.
start_date	string	Updated on or after, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "description": "Workflow name filter (default: any)."
    },
    "type": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Workflow type: all (default), sub_date, newsletter_view, newsletter_click, advanced, unsub, manual, ecommerce_cart_update, ecommerce_order_completed, ecommerce_product_view, segment_add, segment_remove, productalert_stock, productalert_price."
    },
    "status": {
      "enum": [
        "0",
        "1",
        "all"
      ],
      "type": "string",
      "description": "all (default), 0 inactive or 1 active."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    },
    "stop_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$",
      "description": "Updated on or before, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss."
    },
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$",
      "description": "Updated on or after, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss."
    }
  }
}

newsman_list_lists

All email lists (and SMS lists) this key can access, each with list_id, list_name and list_type. Start here: most other tools need a list_id. GET /v2/list/all.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

newsman_list_newsletters

Newsletters (campaigns) of a list with newsletter_id, subject, status, dates, segments and headline stats. Filter by status (-1 cancelled, 0 new, 1 confirmed, 2 sending, 3 paused, 4 resumed, 5 sent; or a comma list such as 1,5; default all), by creation date range, or the last N days. Paged. GET /v2/newsletter/all.

read-only

Argument	Type	Description
days	integer	Created in the last N days (alternative to start_date/stop_date).
page	integer	Page number, starting at 0 (default 0).
limit	integer	Results per page, 1-1000 (default 100).
status	string	Newsletter status: all, -1..5 or a comma list (default all).
list_id*	any	NewsMAN list id.
stop_date	string	Created on or before, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss.
start_date	string	Created on or after, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id"
  ],
  "properties": {
    "days": {
      "type": "integer",
      "maximum": 3650,
      "minimum": 1,
      "description": "Created in the last N days (alternative to start_date/stop_date)."
    },
    "page": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Page number, starting at 0 (default 0)."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "status": {
      "type": "string",
      "pattern": "^(all|-?[0-5](,-?[0-5])*)$",
      "description": "Newsletter status: all, -1..5 or a comma list (default all)."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    },
    "stop_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$",
      "description": "Created on or before, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss."
    },
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$",
      "description": "Created on or after, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss."
    }
  }
}

newsman_list_segment_subscribers

The subscribers of a segment (subscriber_id and email). Paged (page from 0, up to 1000 per page). GET /v2/segment/getSubscribers.

read-only

Argument	Type	Description
page	integer	Page number, starting at 0 (default 0).
limit	integer	Results per page, 1-1000 (default 100).
segment_id*	any	NewsMAN segment id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "segment_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Page number, starting at 0 (default 0)."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "segment_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN segment id."
    }
  }
}

newsman_list_segments

The segments of a list with segment_id, segment_name, subscriber count and status (0 idle, 1 import running, 2 counting, 3 searching). NewsMAN allows 20 calls a minute for this method. GET /v2/segment/all.

read-only

Argument	Type	Description
list_id*	any	NewsMAN list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id"
  ],
  "properties": {
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    }
  }
}

newsman_list_subscribers

Subscribers of a list with a given status (subscribed, unsubscribed, bounced, spam, inactivated), optionally only those who joined since a UTC date. Each item has subscriber_id, email and the date of that status. Paged (page from 0, up to 1000 per page). GET /v2/list/getSubscribers.

read-only

Argument	Type	Description
page	integer	Page number, starting at 0 (default 0).
limit	integer	Results per page, 1-1000 (default 100).
since	string	Only subscribers who joined on or after this moment, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss.
status*	string	Subscriber status.
list_id*	any	NewsMAN list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id",
    "status"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Page number, starting at 0 (default 0)."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "since": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$",
      "description": "Only subscribers who joined on or after this moment, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss."
    },
    "status": {
      "enum": [
        "subscribed",
        "unsubscribed",
        "bounced",
        "spam",
        "inactivated"
      ],
      "type": "string",
      "description": "Subscriber status."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    }
  }
}

newsman_remove_subscriber_from_segment

WRITE: remove a subscriber from a segment (the subscriber stays on the list). POST /v2/subscriber/removeFromSegment.

destructive

Argument	Type	Description
segment_id*	any	NewsMAN segment id.
subscriber_id*	any	NewsMAN subscriber id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscriber_id",
    "segment_id"
  ],
  "properties": {
    "segment_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN segment id."
    },
    "subscriber_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN subscriber id."
    }
  }
}

newsman_search_subscribers

Search the subscribers of a list by keywords (email or name) and status, optionally only those who joined since a UTC date. Paged (page from 0, up to 1000 per page). GET /v2/subscriber/search.

read-only

Argument	Type	Description
page	integer	Page number, starting at 0 (default 0).
limit	integer	Results per page, 1-1000 (default 100).
since	string	Only subscribers who joined on or after this moment, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss.
status	string	Subscriber status (default subscribed).
list_id*	any	NewsMAN list id.
keywords*	string	Text to search for, for example part of an email address.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id",
    "keywords"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Page number, starting at 0 (default 0)."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "since": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}:\\d{2})?$",
      "description": "Only subscribers who joined on or after this moment, UTC, YYYY-MM-DD or YYYY-MM-DD HH:mm:ss."
    },
    "status": {
      "enum": [
        "subscribed",
        "unsubscribed",
        "bounced",
        "spam",
        "inactivated"
      ],
      "type": "string",
      "description": "Subscriber status (default subscribed)."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    },
    "keywords": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Text to search for, for example part of an email address."
    }
  }
}

newsman_subscribe_email

WRITE: subscribe an email address to a list (or update it if it exists), with optional name and custom properties. A property key with the tag_ prefix sets a tag. Only use for people who gave consent. The subscriber is active at once, with no confirmation email. Returns the subscriber_id. POST /v2/subscriber/saveSubscribe.

destructive

Argument	Type	Description
ip	string	IP address to record for this action (NewsMAN requires one). Defaults to 0.0.0.0 when omitted.
email*	string	Email address.
props	object	Custom properties, for example {"city": "Paris", "tag_vip": "1"}.
list_id*	any	NewsMAN list id.
lastname	string	Last name.
firstname	string	First name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id",
    "email"
  ],
  "properties": {
    "ip": {
      "type": "string",
      "pattern": "^[0-9a-fA-F:.]{3,45}$",
      "maxLength": 45,
      "description": "IP address to record for this action (NewsMAN requires one). Defaults to 0.0.0.0 when omitted."
    },
    "email": {
      "type": "string",
      "maxLength": 320,
      "minLength": 3,
      "description": "Email address."
    },
    "props": {
      "type": "object",
      "description": "Custom properties, for example {\"city\": \"Paris\", \"tag_vip\": \"1\"}.",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 1000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    },
    "lastname": {
      "type": "string",
      "maxLength": 200,
      "description": "Last name."
    },
    "firstname": {
      "type": "string",
      "maxLength": 200,
      "description": "First name."
    }
  }
}

newsman_unsubscribe_email

WRITE: unsubscribe an email address from a list, so it no longer receives campaigns from that list. Returns the subscriber_id. POST /v2/subscriber/saveUnsubscribe.

destructive

Argument	Type	Description
ip	string	IP address to record for this action (NewsMAN requires one). Defaults to 0.0.0.0 when omitted.
email*	string	Email address.
list_id*	any	NewsMAN list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_id",
    "email"
  ],
  "properties": {
    "ip": {
      "type": "string",
      "pattern": "^[0-9a-fA-F:.]{3,45}$",
      "maxLength": 45,
      "description": "IP address to record for this action (NewsMAN requires one). Defaults to 0.0.0.0 when omitted."
    },
    "email": {
      "type": "string",
      "maxLength": 320,
      "minLength": 3,
      "description": "Email address."
    },
    "list_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN list id."
    }
  }
}

newsman_update_subscriber

WRITE: change the email, first name or last name of a subscriber. Give only the fields to change; the others are left as they are. POST /v2/subscriber/update.

destructive

Argument	Type	Description
email	string	New email address.
lastname	string	New last name.
firstname	string	New first name.
subscriber_id*	any	NewsMAN subscriber id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscriber_id"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 320,
      "minLength": 3,
      "description": "New email address."
    },
    "lastname": {
      "type": "string",
      "maxLength": 200,
      "description": "New last name."
    },
    "firstname": {
      "type": "string",
      "maxLength": 200,
      "description": "New first name."
    },
    "subscriber_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": 0
        }
      ],
      "description": "NewsMAN subscriber id."
    }
  }
}