Actions that requests all items of a resource will be paginated. The pagination can be customized to tour liking by changing the limit parameter to only fetch a desired amount of items. The limit can Not exceed 100 items.

Exceeding the limit limitation will result in a 400 response:

{
"error": "LimitExceed",
"message": "Limit can't exceed 100."}

Each paginated action will return a meta section in the response. The meta section will consist of a link to get the next page.

The link is populated with all necessary attributes so you can simply follow the link directly to get the next set of items.

The “field key” have to formatted as: GroupName.FieldName. Both the group and the field will be created if they don’t exist. The field name can’t consist of email, phone_number or contain a .

The field type attribute is not required and will default to text if omitted.

Valid field types are:

text

date

datetime

multiple

json

When using the multiple type you have to pass in the values as an array. E.g ['Item1', 'Item2']

To be certain of correct phone number formatting the phone_number attribute should be prefixed with an valid country code. E.g +46
If no prefix is given we will try to parse the number as a Swedish number.

An opt in flow can be trigger by passing require_opt_in: true as an attribute. For this to work a sign up flow in Rule have to be created first. On or more tag used to create the subscriber have to be tied to a sign up flow in Rule fot the optin to function.

Consult the Rule manual for more information about createing sign up flows.

If no opt in flow can be found the subscriber will be automatically opted in.

By passing automation: reset in the request, automation flows will be reset for all tags and segments based on the tags in the request that matches, even if the subscriber already belongs to provided tags.
For each automation flow that gets reset, previously scheduled messages will be removed.

Passing automation: force in the request, will trigger a new automation flow for all tags and matching segments based on the request tags, even if the subscriber already belongs to provided tags. Previously scheduled messages from the automation flows triggered will not be removed.