Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Custom Metadata

Update a property

Update an existing custom metadata property.

patch/accounts/{account_id}/custom_metadata/properties/{id}

Path parameters

account_idstring required

Account ID

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

namestring

name of the property

project_idsstring[]

ids of projects that the property belongs to

descriptionstring

description of property

value_optionsstring[]

value options of property (only applies to single or multi select properties)

Example request

{
  "name": "Fruit",
  "project_ids": [
    "abcd1234cdef1234abcd1234cdef1234",
    "abcd1234cdef1234abcd1234cdef4321"
  ],
  "description": "A healthy snack for all ages",
  "value_options": [
    "Apple",
    "Banana",
    "Coconut"
  ]
}

Response

OK

idstring
namestring
descriptionstring
data_type'boolean' | 'date' | 'link' | 'multi_select' | 'number' | 'single_select' | 'string' | 'text'

data type of the property

value_optionsstring[]
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "Nuts",
  "description": "A healthy snack for all ages",
  "data_type": "multi_select",
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "projects": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "My Android Project",
      "main_format": "xml",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    }
  ],
  "value_options": [
    "apple",
    "banana",
    "coconut"
  ]
}