Create a new experience template | Documentation

curl -X POST https://api.contentful.com/spaces/spaceId/environments/environmentId/experience_templates \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "string",
  "contentProperties": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "type": "String"
    }
  ],
  "designProperties": [
    {
      "id": "string",
      "name": "string",
      "type": "String"
    }
  ],
  "componentTree": [
    {
      "component": {
        "sys": {
          "linkType": "Contentful:Component",
          "type": "ResourceLink",
          "urn": "string"
        }
      },
      "contentProperties": {},
      "designProperties": {},
      "id": "string",
      "nodeType": "Component",
      "slots": {}
    }
  ]
}'

{
  "sys": {
    "id": "string",
    "type": "ExperienceTemplate",
    "automationTags": [
      {
        "sys": {
          "id": "string",
          "linkType": "Tag",
          "type": "Link"
        }
      }
    ],
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "environment": {
      "sys": {
        "id": "string",
        "linkType": "Environment",
        "type": "Link"
      }
    },
    "fieldStatus": {},
    "firstPublishedAt": "string",
    "publishedAt": "string",
    "publishedBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "publishedCounter": 1.1,
    "publishedVersion": 1.1,
    "space": {
      "sys": {
        "id": "string",
        "linkType": "Space",
        "type": "Link"
      }
    },
    "updatedAt": "string",
    "updatedBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "variant": "string",
    "variantDimension": "string",
    "variantType": "string",
    "version": 1.1
  },
  "name": "string",
  "description": "string",
  "contentProperties": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "type": "String"
    }
  ],
  "designProperties": [
    {
      "description": "string",
      "fallbackValue": {
        "type": "ManualDesignValue",
        "value": "string"
      },
      "id": "string",
      "name": "string",
      "type": "String",
      "validations": [
        {
          "regexp": {
            "pattern": "string"
          }
        }
      ]
    }
  ],
  "componentTree": [
    {
      "component": {
        "sys": {
          "linkType": "Contentful:Component",
          "type": "ResourceLink",
          "urn": "string"
        }
      },
      "contentProperties": {},
      "designProperties": {},
      "id": "string",
      "name": "string",
      "nodeType": "Component",
      "slots": {}
    }
  ],
  "slots": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "validations": [
        {
          "size": {
            "min": 1.1,
            "max": 1.1
          }
        }
      ],
      "allowedResources": [
        {
          "type": "Contentful:Component",
          "source": "crn:contentful:::experience:spaces/$self/environments/$self",
          "allowedTypes": [
            "string"
          ]
        }
      ]
    }
  ],
  "metadata": {
    "tags": [
      {
        "sys": {
          "type": "Link",
          "linkType": "Tag",
          "id": "string"
        }
      }
    ],
    "concepts": [
      {
        "sys": {
          "type": "Link",
          "linkType": "TaxonomyConcept",
          "id": "string"
        }
      }
    ],
    "annotations": {
      "DesignSystem": {
        "source": {
          "sys": {
            "type": "ResourceLink",
            "linkType": "Contentful:DesignSystemSource",
            "urn": "string"
          }
        }
      },
      "Component": [
        {
          "sys": {
            "id": "string",
            "type": "Link",
            "linkType": "Annotation"
          },
          "parameters": {}
        }
      ],
      "ExperienceTemplate": [
        {
          "sys": {
            "id": "string",
            "type": "Link",
            "linkType": "Annotation"
          },
          "parameters": {}
        }
      ]
    }
  },
  "dataAssemblies": [
    {
      "sys": {
        "type": "ResourceLink",
        "linkType": "Contentful:DataAssembly",
        "urn": "string"
      }
    }
  ]
}

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

environmentIdstringRequired

Query parameters

access_tokenstringOptional

Request

Body

descriptionstringRequired

contentPropertieslist of objectsRequired

designPropertieslist of objectsRequired

componentTreelist of objectsRequired

The experience template’s component tree. Send an array of nodes for a composed experience template (an empty array is allowed), or send null for a coded experience template that has no component tree. The field is required: a request that omits it is rejected with a 422 ComponentTreeRequired error. On update, null removes the stored tree.

The experience template's component tree. Send an array of nodes for a composed experience template (an empty array is allowed), or send null for a coded experience template that has no component tree. The field is required: a request that omits it is rejected with a 422 ComponentTreeRequired error. On update, null removes the stored tree.

namestringOptional

slotslist of objectsOptional

metadataobjectOptional

dataAssemblieslist of objectsOptional

Response

201

sysobject

namestring

descriptionstring

contentPropertieslist of objects

designPropertieslist of objects

componentTreelist of objects or nullOptional

slotslist of objectsOptional

metadataobjectOptional

dataAssemblieslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error