# Create or update a person

**PUT** `/api/embed/v1/users/{userId}`

Creates a person by your ID, or updates their name or email.

Needs a partner key: `Authorization: Bearer gre_…`, from [Platform › Partner keys](https://docs.gorunner.io/embed/platform-screens#partner-keys). Call it from your server only.

Embed · Self-hosted with an Embed license

## Parameters

### Path

- `userId` · Required · string: Your ID for the person.

### Body

- `name` · Optional · string: Up to 200 characters. Needed to create.
- `email` · Optional · string or null: Up to 320 characters. Contact only: never who they are, never a sign-in. `null` clears it.

## Responses

- 200 OK

  Updated.

- 201 Created

  Created.

- 400 `VALIDATION_ERROR`

  A field isn’t valid. `details.field` names it.

- 500 `INTERNAL_ERROR`

  Something failed on the installation’s side. Try again.

Any call can also answer: [`401 UNAUTHORIZED`](https://docs.gorunner.io/errors#UNAUTHORIZED) · [`403 EMBED_NOT_LICENSED`](https://docs.gorunner.io/errors#EMBED_NOT_LICENSED) · [`403 IP_NOT_ALLOWED`](https://docs.gorunner.io/errors#IP_NOT_ALLOWED) · [`413 PAYLOAD_TOO_LARGE`](https://docs.gorunner.io/errors#PAYLOAD_TOO_LARGE) · [`415 INVALID_CONTENT_TYPE`](https://docs.gorunner.io/errors#INVALID_CONTENT_TYPE) · [`429 RATE_LIMITED`](https://docs.gorunner.io/errors#RATE_LIMITED) · [`503 BUSY`](https://docs.gorunner.io/errors#BUSY). See [Errors](https://docs.gorunner.io/embed/api#errors).

Request

**curl**

```bash
GORUNNER="https://automations.example.com"
GORUNNER_EMBED_KEY="YOUR_PARTNER_KEY"  # gre_…
USER_ID="ada-123"

curl -X PUT "$GORUNNER/api/embed/v1/users/$USER_ID" \
  -H "Authorization: Bearer $GORUNNER_EMBED_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ada Lovelace",
    "email": "ada@bakery.example"
  }'
```

**JavaScript**

```js
const GORUNNER = "https://automations.example.com";
const KEY = process.env.GORUNNER_EMBED_KEY; // gre_…
const USER_ID = encodeURIComponent("ada-123");

const res = await fetch(
  `${GORUNNER}/api/embed/v1/users/${USER_ID}`,
  {
    method: "PUT",
    headers: {
        Authorization: `Bearer ${KEY}`,
        "Content-Type": "application/json",
      },
    body: JSON.stringify({
        name: "Ada Lovelace",
        email: "ada@bakery.example",
      }),
  },
);
const { data } = await res.json();
```

**Python**

```python
import os, requests
from urllib.parse import quote

GORUNNER = "https://automations.example.com"
KEY = os.environ["GORUNNER_EMBED_KEY"]  # gre_…
USER_ID = quote("ada-123", safe="")

res = requests.put(
    f"{GORUNNER}/api/embed/v1/users/{USER_ID}",
    headers={"Authorization": f"Bearer {KEY}"},
    json={
      "name": "Ada Lovelace",
      "email": "ada@bakery.example",
    },
)
data = res.json()["data"]
```

Response · 200 OK

```json
{
  "data": {
    "id": "ada-123",
    "name": "Ada Lovelace",
    "email": "ada@bakery.example",
    "memberships": [],
    "createdAt": "2026-10-20T08:00:00Z",
    "updatedAt": "2026-10-25T09:00:00Z"
  }
}
```

**Every field**

### Body

- `name` · Optional · string: Required to create. Left out or null: left as it is.
- `email` · Optional · string or null: Contact data only. Left out: left as it is. Null or empty clears it. Must look like an email address.

### Response · 200 OK, 201 Created

- `data` · object
  - `id` · string
  - `name` · string
  - `email` · string or null
  - `memberships` · array of objects
    - `account` · object
      - `id` · string
      - `name` · string
    - `workspace` · object
      - `id` · string or null: The partner’s workspace id; null for the default workspace.
      - `default` · boolean
    - `role` · string: One of `viewer`, `operator`, `editor`.
  - `createdAt` · time
  - `updatedAt` · time

Related: [Give a person a role](https://docs.gorunner.io/embed/api/people/put-member) · [Get a person](https://docs.gorunner.io/embed/api/people/get-user)

Source: https://docs.gorunner.io/embed/api/people/put-user