Sign in

Delete custom field

DELETE https://{organization}.myguper.com/api/register/custom-field

Removes a metadata key from the organization and deletes all of its values across every person (person_custom_field). Destructive and irreversible — confirm before calling. Returns how many person values were removed.

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.

Request body

Content-Type: application/json

{
    "metaKey": "shirt_size"
}

Responses

{
    "metaKey": "shirt_size",
    "valuesRemoved": 42
}
Copied to clipboard