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



  • POST /metadata/profiles/extensions/


HTTP Headers

Key Value Type Value Description Mandatory Unique Default
X-Genesys-TenantId Integer Integer value of tenant id false true
X-Genesys-Segment String Segment value (not to be provided by customer) false true


Key ValueType Value Description Mandatory Unique Default
name String 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).

true true
type Token "single-valued" or "multi-valued" 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 a given customer.
true true
unique StringList Lists attributes which are unique in the scope of a given customer. The customer profile cannot include several extension records with identical values for these attributes. For example, let's consider a contact extension with the attributes "phone_num", "ext", "time_of_day". To ensure that a given customer does not have two contact extensions with the same phone number, set the following in the extension schema:

unique = ["phone_num", "ext"]

false true
attributes JsonArray The array of zero or more attributes. false false


  "attributes": [
      {"name":"AddressType", "type":"integer", "default":0},
      {"name":"Address", "type":"string", "length":256},
      {"name":"City", "type":"string", "length":32},
      {"name":"County", "type":"string", "length":32},
      {"name":"PostCode", "type":"string", "length":10},
      {"name":"Country", "type":"string", "length":32}



ReturnCode ReturnString Description
201 Created The request has been fulfilled and resulted in a new resource being created


FaultCode FaultString Description
400 Bad Request General error which can be one of the following reasons:
  • Missing required parameter.
  • Parameter value of unexpected type.
  • Invalid object syntax.
  • Missing required attribute
401 Not Authorized Credentials are missing or incorrect, or the given user is not allowed to execute a given service (such as an administrative service method that changes the profile schema).
403 Forbidden The operation is forbidden and the reason is specified in the error message. This error is returned in the following cases:
  • Attempt to alter the schema while the server is in Production Mode.
  • Attempt to add customer profiles prior to the definition of a profile schema.
404 Not Found The specified URI is invalid, or the requested resource (such as a customer, service, state, task, extension, or identification key) does not exist.
405 Method Not Allowed Returned when an unsupported operation is requested. For instance, if a resource supports only PUT and GET operations, a POST request on this resource returns this error.
415 Unsupported Media Type In the header of your request, Content-Type is not set to a valid value. Most operations of Context Services support only "application/json".


201 Created
This page was last edited on May 18, 2018, at 15:05.


Comment on this article:

blog comments powered by Disqus