{"_id":"59a45d2cd12e81000f842f46","category":{"_id":"59a45d2bd12e81000f842eee","version":"59a45d2bd12e81000f842ee2","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"59a45d2bd12e81000f842ee2","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:12:59.168Z","releaseDate":"2017-08-28T18:12:59.168Z","categories":["59a45d2bd12e81000f842ee3","59a45d2bd12e81000f842ee4","59a45d2bd12e81000f842ee5","59a45d2bd12e81000f842ee6","59a45d2bd12e81000f842ee7","59a45d2bd12e81000f842ee8","59a45d2bd12e81000f842ee9","59a45d2bd12e81000f842eea","59a45d2bd12e81000f842eeb","59a45d2bd12e81000f842eec","59a45d2bd12e81000f842eed","59a45d2bd12e81000f842eee","59a45d2bd12e81000f842eef","59a45d2bd12e81000f842ef0","59a45d2bd12e81000f842ef1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T12:42:42.841Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":64,"body":"These **metadata** objects are contained in the **metaData** array in the [transactionMetaData](doc:transaction-meta-data) object.  \n\n###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`metaKey`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Key name of transaction metadata.\\n40 characters max.\",\n    \"1-0\": \"`metaValue`\",\n    \"1-2\": \"**Required**\",\n    \"1-3\": \"Value of transaction metadata.\\n500 characters max.\",\n    \"0-2\": \"**Required**\",\n    \"1-1\": \"*string*\",\n    \"2-0\": \"`metaDescription`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"**Required**\",\n    \"2-3\": \"Description of transaction metadata.\\n40 characters max.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`metaKey`\",\n    \"0-1\": \"*string*\",\n    \"1-0\": \"`metaValue`\",\n    \"1-1\": \"*string*\",\n    \"2-0\": \"`metaDescription`\",\n    \"2-1\": \"*string*\",\n    \"0-2\": \"Key name of transaction metadata.\\n40 characters max.\",\n    \"1-2\": \"Value of transaction metadata.\\n500 characters max.\",\n    \"2-2\": \"Description of transaction metadata.\\n40 characters max.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"Contains metadata keys and values","slug":"meta-data","type":"basic","title":"metadata"}

metadata

Contains metadata keys and values

These metadata objects are contained in the metaData array in the transactionMetaData object.

Request

Property Name
Type
Required
Description

metaKey

string

Required

Key name of transaction metadata.
40 characters max.

metaValue

string

Required

Value of transaction metadata.
500 characters max.

metaDescription

string

Required

Description of transaction metadata.
40 characters max.

Response

Property Name
Type
Description

metaKey

string

Key name of transaction metadata.
40 characters max.

metaValue

string

Value of transaction metadata.
500 characters max.

metaDescription

string

Description of transaction metadata.
40 characters max.