This page was last edited on July 17, 2020, at 15:47.
Comments or questions about this documentation? Contact us for support!
Purpose: Describes an extension. |
Each extension fulfills the contract of an Extension Schema that your application created in anterior operations. Your application can create schemas for the following extensions:
Once the extension schema is defined, your application can create and add extension records when dealing with standard profile, services, states, and task operations. For instance, if you start a task, you can specify extension records in your operation body as shown in the example section.
Field | Type | Mandatory | Description |
---|---|---|---|
customer_id | string | yes if not nested in a profile | The unique ID of the given customer.
|
name | string | yes | The unique, case-insensitive name of the extension.
|
<attribute n> |
|
yes | Individual attributes, defined in the Extension Schema. <attribute n> corresponds to the attribute name defined in the schema. |
<references />