PATTERN OBJECT

Represents one whitelist or blacklist pattern — a rule that matches many signup identities at once.

💡 A pattern is a regular expression, so .*@company.com matches every address at that domain. Use patterns instead of listing identities one by one.

Fields

Field	Type	Required	Description
`pattern`	String	Yes	The rule users must match — e.g. `.@company.com`, `\+1.`.
`id`	String	Optional	The pattern record's id. Returned after the pattern is added.
`example`	String	Optional	A sample value that matches the rule, shown to help admins understand it.
`tags`	Array of String	Optional	Whitelist only. App tags to assign to users who sign up through this pattern.

List	Methods
Whitelist	addWhitelistPatterns, removeWhitelistPatterns
Blacklist	addBlacklistPatterns, removeBlacklistPatterns — without `tags`

json
{
  "id": "495",
  "pattern": ".*@gmail.com",
  "example": "ss@gmail.com",
  "tags": ["4"]
}

Remove operations take plain pattern strings rather than this object.