Sign in

Upsert customer metadata

PUT https://{organization}.myguper.com/api/register/customer/{id}/metadata

Partial upsert of a person's metadata. The body is a flat { metaKey: value } object — each key is created or updated. Send a null or empty-string value to delete a key. Keys not present in the body are left untouched.

Each metaKey is slugified to [a-z0-9_] (max 64 chars) and rejected (422) if it collides with a fixed person column (e.g. email, name, gender). Values are stored as text; a numeric value also populates valueNumber and a YYYY-MM-DD value also populates valueDate (best-effort, for future segmentation). New keys are auto-registered so they appear in the custom-field catalog.

Returns the person's fresh, normalized metadata map.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Path parameters

Name Type Description
id * integer Person id.

Request body

Content-Type: application/json

{
    "shirt_size": "G",
    "kid_birthday": "2015-03-01",
    "old_key": null
}

Responses

{
    "shirt_size": "G",
    "kid_birthday": "2015-03-01"
}
Copied to clipboard