DocumentationTutorialsUse Cases & Blueprints

Create Schema

Last update: September 14, 2026

CREATED FOR:

  • Developer
  • User

Modify the body of the API

CAUTION
Do not execute the call yet

  1. Click on the Step 4 - Create Customer Account Schema API call in the XDM Schema Lab -> Create Schema folder.

    Step 4 - Create Customer Account Schema API call in the Postman collection

  2. Open the body of the call and view the structure of how a schema is defined. Remember a schema is always composed of only one (1) class and one or more field groups.

  3. Populate the title and description fields in the body of the schema with the following:

    • Title -> Sample Customer Schema - <your sandbox number>
    • Description -> Sample Customer Schema - <your sandbox number>

  4. Populate the $ref fields with the $ids you saved from the previous lab sections that you completed: Create Custom Field Groups and Get Profile Class. You have $ids for each of the following items:

    • Class -> XDM Individual Profile
    • Field Group -> Demographic Details
    • Field Group -> Personal Contact Details
    • Field Group -> Consent and Preference Details
    • Field Group (custom) -> Customer Account Details

    Empty schema request body before adding class and field group references

  5. Review your final body and ensure it looks similar to this

Completed schema request body with title, description, and all $ref values populated

NOTE
The order of the $refs does not matter nor does the location of the title and description within the body.

Execute the API

  1. Save your modifications to the API request before continuing.
  2. Execute the API by clicking the Send button

A successful response for creating the schema should result in a 201 Created status and should look like the image below

WARNING
Do not execute the request again if successful

201 Created response after successfully creating the schema via Step 4 API

Locate and save the schema $id

  1. After you execute the API request copy the $id and $meta:altId from the response
  2. Save the values somewhere so that you can reuse them later
WARNING
Do not continue until you have saved the $id and $meta:altId somewhere. They are required in future lab steps
SUCCESS
Congratulations! You created a schema using only the APIs
recommendation-more-help
blueprints-learn-help-blueprints