Skip to navigation
APIsMetadata ResourcesMetadata Option

Update a metadata option

Updates the specific metadata option.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

metadataIdstringRequiredformat: "^mgl_[a-zA-Z0-9]{10,22}$"
The unique identifier of the metadata.

Headers

X-Studies-Api-VersionstringOptional

Request

The option rename.
old_valuestring or nullRequired<=255 characters
The old value of the option.
new_valuestring or nullRequired<=255 characters
The new value of the option.

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The metadata option was updated.
successboolean

Always true on a successful response.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error