Upsert user

Upsert user

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.

Response

Returns successful.

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-07-13T05:01:16Z",
  "created_at_string": "Jul 13, 2025 05:01 am UTC",
  "created_at_utc": "2025-07-13T05:01:16Z",
  "email": "no-reply+4c6359fad665981ce12@embedworkflow.com",
  "groups": [],
  "hashid": "wy56q",
  "id": "01980228-acf2-777a-a5ec-3929d3a1a14f",
  "name": "John Doe",
  "object": "user",
  "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
    }
  ]
}