Skip to main content
PATCH
/
accounts
/
{account_id}
/
custom_metadata
/
properties
/
{id}
cURL
curl "https://api.phrase.com/v2/accounts/:account_id/custom_metadata/properties/:id" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -d '{"name":"Fruit","description":"A healthy snack for all ages","project_ids":["1","2","3"],"value_options":["apple","banana","coconut"]}' \
  -H 'Content-Type: application/json'
{
  "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"
  ]
}

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
account_id
string
required

Account ID

​
id
string
required

ID

Body

application/json
​
name
string

name of the property

Example:

"Fruit"

​
project_ids
string[]

ids of projects that the property belongs to

Example:
[
  "abcd1234cdef1234abcd1234cdef1234",
  "abcd1234cdef1234abcd1234cdef4321"
]
​
description
string

description of property

Example:

"A healthy snack for all ages"

​
value_options
string[]

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

Example:
["Apple", "Banana", "Coconut"]

Response

OK

​
id
string
​
name
string
​
description
string
​
data_type
enum<string>

data type of the property

Available options:
boolean,
date,
link,
multi_select,
number,
single_select,
string,
text
Example:

"string"

​
user
user_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}
​
projects
project_short · object[]
​
value_options
string[]
​
created_at
string<date-time>
​
updated_at
string<date-time>