Userlist

Userlist integration (Marketing, Communication). Imported from open-connector.

API key5 toolshttps://push.userlist.com

POST

userlist_push_user

Create or update a Userlist user through the Push API.

/users

8 parameters

Param	Type	Required	Description
identifier	string	optional	A Userlist resource identifier.
email	string	optional	The email address of the user.
signed_up_at	string	optional	When the user signed up.
properties	object	optional	Custom properties stored by Userlist. Keys are normalized to snake_case by User…
relationships	array	optional	Relationships to companies for this user.
company	string	optional	A Userlist company identifier or embedded company object.
companies	array	optional	Company identifiers or embedded companies.
preferences	array	optional	Subscription preference updates for this user.

POST

userlist_push_company

Create or update a Userlist company through the Push API.

/companies

7 parameters

Param	Type	Required	Description
identifier	string	required	A Userlist resource identifier.
name	string	optional	The company name.
signed_up_at	string	optional	When the company signed up.
properties	object	optional	Custom properties stored by Userlist. Keys are normalized to snake_case by User…
relationships	array	optional	Relationships to users for this company.
user	string	optional	A Userlist user identifier or embedded user object.
users	array	optional	User identifiers or embedded users.

POST

userlist_push_relationship

Create or update a Userlist relationship between a user and a company.

/relationships

3 parameters

Param	Type	Required	Description
user	string	required	A Userlist user identifier or embedded user object.
company	string	required	A Userlist company identifier or embedded company object.
properties	object	optional	Custom properties stored by Userlist. Keys are normalized to snake_case by User…

POST

userlist_create_event

Create a Userlist event for a user, company, or both.

/events

5 parameters

Param	Type	Required	Description
name	string	required	The event name.
user	string	optional	A Userlist user identifier or embedded user object.
company	string	optional	A Userlist company identifier or embedded company object.
occurred_at	string	optional	When the event occurred.
properties	object	optional	Custom properties stored by Userlist. Keys are normalized to snake_case by User…

POST

userlist_send_message

Send a Userlist transactional message to a user or email address.

/messages

14 parameters

Param	Type	Required	Description
template	string	optional	The transactional message template identifier.
user	string	optional	A Userlist user identifier or embedded user object.
company	string	optional	A Userlist company identifier or embedded company object.
properties	object	optional	Custom properties stored by Userlist. Keys are normalized to snake_case by User…
channel	string	optional	The delivery channel for the message.
to	string	optional	The recipient email address for email messages.
from	string	optional	The sender email address for email messages.
reply_to	string	optional	The reply-to email address for email messages.
subject	string	optional	The custom message subject. Required when template is omitted.
preheader	string	optional	The custom email preheader text.
body	object	optional	The Userlist transactional message body.
sender	string	optional	The sender identifier configured in Userlist.
theme	string	optional	The theme identifier to apply, or false to disable theming.
topic	string	optional	The topic identifier configured in Userlist.