Endpoint
PUT https://embedworkflow.com/api/v1/users/{key}
Path Parameters
key string, required
Client-provided unique identifier
Request Body
name string, optional
Name of resource
email string, optional
Email address
data object, optional
Additional user data
groups array, optional
User permission groups. Only available to users with admin role.
time_zone string, optional
Time zone
Response
Returns successful.
Response Properties
key string
Unique identifier for the user
created_at string
Created at in specified timezone
created_at_string string
Created at formatted as human-readable string
created_at_utc string
Created at in UTC
email string
User's email address
groups array
Permission groups the user belongs to
id string
System-generated unique identifier
name string
User's display name
object string
Object type identifier
time_zone string
Time zone setting for the user in IANA timezone format (e.g. 'America/New_York', 'Europe/London', 'Asia/Tokyo', 'Etc/UTC')
user_data_schema array
User's data schema configuration
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40{ "key": "123", "created_at": "2025-08-19T15:19:17Z", "created_at_string": "Aug 19, 2025 03:19 pm UTC", "created_at_utc": "2025-08-19T15:19:17Z", "email": "no-reply+6f5f92a3b3ea3b5e5a4@embedworkflow.com", "groups": [], "id": "0198c2e9-c6b4-71d4-970e-a9e0c5e4e194", "name": "John Doe", "object": "user", "time_zone": "America/New_York", "user_data_schema": [ { "variable": "first_name", "data_path": "first_name", "display_label": "First Name", "format": null, "groups": null, "list_values_variable": null, "object": "data_type", "required": false, "source": "user", "type": "String", "value": null }, { "variable": "last_name", "data_path": "last_name", "display_label": "Last Name", "format": null, "groups": null, "list_values_variable": null, "object": "data_type", "required": false, "source": "user", "type": "String", "value": null } ] }