SIGNUP OBJECT

Represents one whitelist or blacklist entry used for app signup access control.

💡 signup_id is the identity itself — a mobile number or an email, depending on how the app is configured. id is the record's own key and appears only after the record exists.

Fields

Field	Type	Required	Description
`signup_id`	String	Yes	The identity being allowed or blocked.
`id`	String	Conditional	The signup record's id. Returned after the record is added. This is not a user id.
`tags`	Array of String	Optional	Whitelist only. App tags to assign to the user when they sign up.

Used in

List	Methods
Whitelist	addToWhitelist, removeFromWhitelist, getWhitelistUsers
Blacklist	addToBlacklist, removeFromBlacklist, getBlacklistUsers — without `tags`

Example

json
{
  "id": "488",
  "signup_id": "name@example.com",
  "tags": ["4"]
}