Send event
Send events to trigger emails in Loops.
Request
Body
Provide either an email or userId value or both to identify the contact.
If both are provided, the system will look for a contact with either a
matching email or userId value. If a contact is found for one of the
values (e.g. email), the other value (e.g. userId) will be updated. If a
contact is not found, a new contact will be created using both email and
userId values.
The contact’s email address.
The contact’s unique user ID. This must already have been added to your contact in Loops.
The name of the event.
An object containing event property data for the event. Values can be of type
string, number, boolean or date. Read more
Key-value pairs of mailing list IDs and a boolean denoting if the contact
should be added (true) or removed (false) from the list. Read
more
{
"mailingLists": {
"list_123": true,
"list_456": false
}
}
Contact properties
You can also include default and custom contact properties in your request body, which will update the contact in Loops. These should be added as top-level attributes in the request.
Contact properties can be of type string, number, boolean or date (see allowed date formats).
{
"email": "[email protected]",
"eventName": "signup",
"firstName": "Bob", /* Contact property */
"plan": "pro" /* Custom contact property */
}
There are a few reserved names that you cannot use for custom properties.
To empty or reset the value of a contact property, send a null value.
Response
Was this page helpful?