getContactMetadata

get

/ccadmin/v1/selfservice/contacts/metadata

Get contact meta data which represents the attributes which are mapped to customer data master contact attributes . Note : This endpoint is operational only when customer data sync is enabled.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : GetContactMetaData_response
Type: object
Show Source
Example:
{
    "metadata":{
        "firstName":{
            "editable":true
        },
        "lastName":{
            "editable":true
        },
        "email":{
            "editable":false
        }
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/selfservice/contacts/metadata"
        }
    ]
}
Nested Schema : metadata
Type: object
Meta data of attributes mapped to the customer master data
Show Source
Nested Schema : Attribute Name
Type: object
Name of the contact attribute mapped
Show Source
  • A boolean value which describes whether the attribute is editable or not

400 Response

When request payload is not correct or properties are missing.
Body ()
Root Schema : errorModel400
Type: object
Show Source

Default Response

The default error response. The following are the internal error codes thrown by this API: |Error Code|Description| |------------------|------------------| |58001|Internal server error.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top