Skip to content

Update type

PUT
/v2/metadata/types/{typeId}

Update an existing metadata type.

typeId
required
string format: uuid

The ID of the metadata type

Example
0ebec69f-cde5-4abf-83eb-595f8f023c80
X-API-Key
string

API Key

X-API-Secret
string

API Secret

object
displayName

The name of the metadata type and how it will be displayed to the user

string
User Preferences
key

The key that will be used to reference the metadata type

string
user_preferences
description

A description of the metadata type

string
Stores user preferences and settings

The resource has been successfully updated.

object
typeId
required

The type ID

string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80
displayName
required

The display name for the metadata type

string
User Preferences
key
required

The key for the metadata type

string
user_preferences
description
required

The description of the metadata type

string
Stores user preferences and settings
type
required

The data type for this metadata

string
Allowed values: string number boolean array
string

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error