(Optional if user_email or user_login is defined) Include the numeric id of the user. (Note that the user_id has a higher priority than the user_email.)
(Optional if user_id or user_login is defined) Include the email correlated to the account.
(Optional if user_email or user_id is defined) A string with which the user can log in to your site. This value can also be used ot update a user.
The first name of the user.
The last name of the user.
The nickname. Please note that the nickname will be sanitized by WordPress automatically.
The name that will be seen on the frontend of your site.
A URL-friendly name. Default is user' username.
A description for the user that will be available on the profile page.
Wether the user should be able to use the Rich editor. Set it to "yes" or "no". Default "no".
The date the user got registered. Date structure: Y-m-d H:i:s
Include a website url.
The main user role. If set, all additional roles are removed.
This allows to add/remove multiple roles on a user. For more information, please read the description.
The user password. If not defined, we don't generate a new one.
DEPRECATED! Please use manage_meta_data instead.
Update (or add) meta keys/values.
In case you want to add more complex meta data, this field is for you. Check out some examples within our post meta blog post.
Update (or add) Advanced Custom Fields meta keys/values.
In case you want to add more complex Advanced Custom Fields data, this field is for you. Check out some examples within our post meta blog post.
Set this field to "yes" to send a email to the user with the data.
Advanced: Register a custom action after the plugin fires this webhook. More infos are in the description.
Wether you want to create the user if it does not exists or not. Set it to "yes" or "no" Default is "no".
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
More available WordPress endpoints
To learn more about a specific endpoint, simply click on it.