Back to KustomerUpdate Custom Attribute Metadata
Set the metadata for custom attributes on any of the available resources. The options
are included in the below schema and are dependent on the data type, as specified by the
suffix of the property name. The default displayName will be the "Title Cased" version of
the property name and the type will be automatically determined (i.e. a property named
"totalOrdersNum" will have a displayName of "Total Orders" if no alternative displayName is set
and a type "number").
Any one of the following roles is required for this endpoint:
|Legacy Role|Equivalent Permission Set Role|
|-----|--------|
|org.admin.metadata.write|org.permission.metadata.update|
Note
Unlike the other property types, metadata for custom properties ending in "Id" must be configured before they can be used. When updating these properties, the values will be validated to ensure that the related object exists in Kustomer and is of the specified "target" type.
Input
type: object
properties:
parameters:
type: object
properties:
resource:
type: string
description: >-
(Required) Resource Name **required**
Valid Values: "company", "conversation", "customer", "message",
"kobject.*"
required:
- resource
title: Parameters
data:
type: string
example: >-
"{\n \"standardProperties\": \"<object>\",\n \"relationships\":
\"<object>\",\n \"properties\": \"<object>\",\n \"validations\":
[\n \"<object-id>\"\n ]\n}"
title: Data
Output
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
properties:
type: object
properties:
shopifyCustomerIdNum:
type: object
properties:
type:
type: string
displayName:
type: string
myCustomStr:
type: object
properties:
modifiedBy:
type: string
modifiedAt:
type: string
updatedAt:
type: string
type:
type: string
enumeration:
type: array
items:
type: string
displayName:
type: string
ordersId:
type: object
properties:
modifiedBy:
type: string
modifiedAt:
type: string
updatedAt:
type: string
type:
type: string
target:
type: string
multi:
type: string
displayName:
type: string
relationships:
type: object
properties:
org:
type: object
properties:
links:
type: object
properties:
self:
type: string
data:
type: object
properties:
type:
type: string
id:
type: string
links:
type: object
properties:
self:
type: string