Update an Experience in a preview session | Documentation

curl -X POST https://api.contentful.com/spaces/spaceId/environments/environmentId/preview_sessions/sessionId/experiences/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "description": "string",
  "designProperties": {}
}'

{
  "sys": {
    "type": "string",
    "id": "string",
    "archivedAt": "string",
    "archivedBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "archivedVersion": 1.1,
    "automationTags": [
      {
        "sys": {
          "id": "string",
          "linkType": "string",
          "type": "string"
        }
      }
    ],
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "environment": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "experienceTemplate": {
      "sys": {
        "linkType": "string",
        "type": "string",
        "urn": "string"
      }
    },
    "firstPublishedAt": "string",
    "localeStatus": {},
    "publishedAt": "string",
    "publishedBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "string"
      }
    },
    "publishedCounter": 1.1,
    "publishedVersion": 1.1,
    "space": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "updatedAt": "string",
    "updatedBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "variant": "string",
    "variantDimension": "string",
    "variantType": "string",
    "version": 1.1
  },
  "name": "string",
  "description": "string",
  "designProperties": {},
  "parameters": {},
  "contentBindings": {
    "sys": {
      "type": "string",
      "linkType": "string",
      "urn": "string"
    },
    "parameters": {}
  },
  "metadata": {
    "tags": [
      {
        "sys": {
          "type": "string",
          "linkType": "string",
          "id": "string"
        }
      }
    ],
    "concepts": [
      {
        "sys": {
          "type": "string",
          "linkType": "string",
          "id": "string"
        }
      }
    ],
    "annotations": {
      "DesignSystem": {
        "source": {
          "sys": {
            "type": "string",
            "linkType": "string",
            "urn": "string"
          }
        }
      },
      "ComponentType": [
        {
          "sys": {
            "id": "string",
            "type": "string",
            "linkType": "string"
          },
          "parameters": {}
        }
      ],
      "Template": [
        {
          "sys": {
            "id": "string",
            "type": "string",
            "linkType": "string"
          },
          "parameters": {}
        }
      ]
    },
    "name": "string"
  },
  "slots": {}
}

Update an experience using its ID in the path. Send the complete entity configuration without sys; any supplied sys is overwritten with the route’s entity ID and type. Use the same Content Management API token that created the session.

Authentication

AuthorizationBearer

A Content Management API token, sent as Authorization: Bearer <token>.

Path parameters

spaceIdstringRequired

environmentIdstringRequired

sessionIdstringRequired

idstringRequired

Request

Body

namestringRequired

descriptionstringRequired

designPropertiesmap from strings to objectsRequired

parametersmap from strings to objectsOptional

contentBindingsobjectOptional

metadataobjectOptional

slotsmap from strings to lists of objectsOptional

sysanyOptional

Response

200

sysobject

namestring

descriptionstring

designPropertiesmap from strings to objects

parametersmap from strings to objectsOptional

contentBindingsobjectOptional

metadataobjectOptional

slotsmap from strings to lists of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error