Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.

Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Profile Extension Schema

ApiRef2.png Purpose: Describes a type of extension available for the customer profiles.


Describes one of the Profile Extension resources. Before your application can start adding extensions to a given profile, your application must define this extension's schema, which includes its nested attributes.


Field Type Mandatory Description
name string yes The unique, case-insensitive name of the extension. The name must start with a letter, and can be followed with letters, numbers, or underscores.

The name is restricted to a maximum of 26 characters (Maximum RDBMS shared limit on creation of index).

type token yes Extensions come in the following forms:
  • Single-valued: a single extension record is associated with a given customer.
  • Multi-valued: multiple extension records can be associated with any given customer.
  • Classifier: the single-valued extension has no attribute.

Important.png Only single-valued profile extensions are supported for now.

attributes array no The array of zero or more attribute objects. Empty when type="classifier".


The following schema describes the Address extension.

  "attributes": [
      {"name":"PostCode","type":"string", "length":10},

Related Operations


This page was last edited on November 23, 2017, at 16:00.


Comment on this article:

blog comments powered by Disqus