GoRunner docs
Search or askSearch⌘K

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. Call it from your server only.

Embed · Self-hosted with an Embed license

Parameters

Path

userIdRequired · string

Your ID for the person.

Body

nameOptional · string

Up to 200 characters. Needed to create.

emailOptional · string or null

Up to 320 characters. Contact only: never who they are, never a sign-in. null clears it.

Responses

  • 200OK

    Updated.

  • 201Created

    Created.

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

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

Any call can also answer: 401 UNAUTHORIZED · 403 EMBED_NOT_LICENSED · 403 IP_NOT_ALLOWED · 413 PAYLOAD_TOO_LARGE · 415 INVALID_CONTENT_TYPE · 429 RATE_LIMITED · 503 BUSY. See Errors.

Request

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"
  }'

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

nameOptional · string

Required to create. Left out or null: left as it is.

emailOptional · 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

dataobject
idstring
namestring
emailstring or null
membershipsarray of objects
accountobject
idstring
namestring
workspaceobject
idstring or null

The partner’s workspace id; null for the default workspace.

defaultboolean
rolestring

One of viewer, operator, editor.

createdAttime
updatedAttime