Update a Component in a preview session | Documentation

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

{
  "sys": {
    "type": "string",
    "id": "string",
    "automationTags": [
      {
        "sys": {
          "id": "string",
          "linkType": "string",
          "type": "string"
        }
      }
    ],
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "designSystemSource": {
      "sys": {
        "linkType": "string",
        "type": "string",
        "urn": "string"
      }
    },
    "environment": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "fieldStatus": {},
    "firstPublishedAt": "string",
    "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",
  "contentProperties": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "type": "String"
    }
  ],
  "designProperties": [
    {
      "description": "string",
      "fallbackValue": {
        "type": "string",
        "value": "string"
      },
      "id": "string",
      "name": "string",
      "type": "string",
      "validations": [
        {
          "regexp": {
            "pattern": "string"
          }
        }
      ]
    }
  ],
  "componentTree": [
    {
      "component": {
        "sys": {
          "linkType": "string",
          "type": "string",
          "urn": "string"
        }
      },
      "contentProperties": {},
      "designProperties": {},
      "id": "string",
      "name": "string",
      "nodeType": "string",
      "slots": {}
    }
  ],
  "slots": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "validations": [
        {
          "size": {
            "min": 1.1,
            "max": 1.1
          }
        }
      ],
      "allowedResources": [
        {
          "type": "string",
          "source": "string",
          "allowedTypes": [
            "string"
          ]
        }
      ]
    }
  ],
  "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"
          }
        }
      },
      "Component": [
        {
          "sys": {
            "id": "string",
            "type": "string",
            "linkType": "string"
          },
          "parameters": {}
        }
      ],
      "ExperienceTemplate": [
        {
          "sys": {
            "id": "string",
            "type": "string",
            "linkType": "string"
          },
          "parameters": {}
        }
      ]
    }
  },
  "dataAssemblies": [
    {
      "sys": {
        "type": "string",
        "linkType": "string",
        "urn": "string"
      }
    }
  ]
}

Update a component 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

contentPropertieslist of objectsRequired

designPropertieslist of objectsRequired

componentTreelist of objects or nullOptional

slotslist of objectsOptional

metadataobjectOptional

dataAssemblieslist of objectsOptional

sysanyOptional

Response

200

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

413

Content Too Large Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error