---
title: "Set scoped userdata"
method: GET
path: "/set_scoped_userdata"
tags: ["UserData"]
---

# Set scoped userdata

`GET /set_scoped_userdata`

This function sets (creates or updates) a userdata key/value pair within the specified scope and returns the full updated mapping.

## Query parameters

- `scope` string, required
- `json` string
- `key` string
- `value` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object — The updated mapping of all userdata in the scope.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)