Create a new experience

POST

https://api.contentful.com/spaces/:spaceId/environments/:environmentId/experiences

POST

/spaces/:spaceId/environments/:environmentId/experiences

curl -X POST https://api.contentful.com/spaces/spaceId/environments/environmentId/experiences \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "description": "string",
  "designProperties": {},
  "experienceTemplate": {
    "sys": {
      "type": "ResourceLink",
      "linkType": "Contentful:ExperienceTemplate",
      "urn": "string"
    }
  }
}'

{
  "sys": {
    "id": "string",
    "type": "Experience",
    "archivedAt": "string",
    "archivedBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "archivedVersion": 1.1,
    "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"
      }
    },
    "experienceTemplate": {
      "sys": {
        "linkType": "Contentful:ExperienceTemplate",
        "type": "ResourceLink",
        "urn": "string"
      }
    },
    "firstPublishedAt": "string",
    "localeStatus": {},
    "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",
  "designProperties": {},
  "parameters": {},
  "contentBindings": {
    "sys": {
      "type": "ResourceLink",
      "linkType": "Contentful:DataAssembly",
      "urn": "string"
    },
    "parameters": {}
  },
  "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"
          }
        }
      },
      "ComponentType": [
        {
          "sys": {
            "id": "string",
            "type": "Link",
            "linkType": "Annotation"
          },
          "parameters": {}
        }
      ],
      "Template": [
        {
          "sys": {
            "id": "string",
            "type": "Link",
            "linkType": "Annotation"
          },
          "parameters": {}
        }
      ]
    },
    "name": "string"
  },
  "slots": {},
  "viewports": [
    {
      "id": "string",
      "query": "string",
      "displayName": "string",
      "previewSize": "string"
    }
  ]
}

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

environmentIdstringRequired

Query parameters

access_tokenstringOptional

Request

Body

namestringRequired

descriptionstringRequired

designPropertiesmap from strings to maps from strings to objectsRequired

Each assignment can use either a direct value or a legacy dimension-keyed map of values. Use direct values for new experiences. Legacy maps remain supported for existing viewport-based experiences.

experienceTemplateobjectRequired

parametersmap from strings to objectsOptional

contentBindingsobjectOptional

metadataobjectOptional

slotsmap from strings to lists of objectsOptional

viewportslist of objectsOptionalDeprecated

Deprecated. This optional field will be removed in a future release. When it is absent, use flattened design-property values.

Response

201

sysobject

namestring

descriptionstring

designPropertiesmap from strings to maps from strings to objects

parametersmap from strings to objectsOptional

contentBindingsobjectOptional

metadataobjectOptional

slotsmap from strings to lists of objectsOptional

viewportslist of objectsOptionalDeprecated

Deprecated. This optional field will be removed in a future release. When it is absent, use flattened design-property values.

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