Skip to main content Skip to complementary content

Creating a data type

A data type is a description of the data that is exchanged over the network. It can be reused in the whole API version.

Procedure

  1. Click the + button in the top right corner of the left panel.
    Information noteTip: If you want to create your data type directly in a previously created section, you can do so by clicking the + button to the right of the section name.
  2. Click Data type.
  3. Enter a Name for your data type, Contact for example, and enter a Description if needed.
  4. Optional: Select the Section in which you want to include the data type.
  5. If you have an existing JSON example of your data type, you can use it to generate your properties by clicking Generate from JSON example.
  6. Enter your example and click Generate.

    Example

    Screenshot of using a JSON example to generate a Contact data type.
    All of the properties in the example are created in your data type.
  7. To add your properties manually, select a Type.
    The type is object by default, you can click it to display all the types available.
    Screenshot of the object type expanded with the list of other available types.
  8. Click Add property to create a new property and define the Name and Type.
  9. Optional: Toggle the Required button to Yes if the property is required.
  10. Add a Description if needed, and click more attributes to add more information to your data type.

    Example

    Example of how to define the firstName property, which is a required property of type String and described as "Customer's first name".
  11. Add as many properties as needed, then click Save.

In this section

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here