Contentful Component
Use the Contentful component to manage Spaces, Environments, Organizations and more.
Component key: contentfulDescription
Contentful is a content management system (CMS) that allows developers to manage and deliver content across multiple platforms and devices.
Use the Contentful component to manage Spaces, Environments, Organizations and more.
API Reference Documentation: Contentful API Reference Documentation
Connections
OAuth 2.0
Create a new OAuth App:
- Login and navigate to the Developer Account Settings for OAuth applications
- Create a New Application
- Enter the Redirect URI as https://oauth2.prismatic.io/callback
- Additionally check the boxes for the applicable scopes: Content management read, Content management manage, Confidential
- Upon saving the application note the Client ID and Client Secret and enter them in the connection configuration of the integration.
Triggers
Events Based
Get notified when events occur in your space | key: eventsTrigger
Webhook
Receive and validate webhook requests from Contentful for webhooks you configure. | key: webhook
Data Sources
Select Environment
Select an environment from a dropdown menu | key: selectEnvironment | type: picklist
Select Organization
Select an organization from a dropdown menu | key: selectOrganization | type: picklist
Select Space
Select a space from a dropdown menu | key: selectSpace | type: picklist
Actions
Create Asset
Create a new asset | key: createAsset
{
"data": {
"fields": {
"title": {
"en-US": "Playsam Streamliner"
},
"file": {
"en-US": {
"contentType": "image/jpeg",
"fileName": "example.jpeg",
"upload": "https://example.com/example.jpg"
}
}
},
"metadata": {
"tags": [
{
"sys": {
"type": "Link",
"linkType": "Tag",
"id": "nyCampaign"
}
}
]
},
"sys": {
"id": "wtrHxeu3zEoEce2MokCSi",
"type": "Asset",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
}
}
}
Create Content Type
Create a new content type | key: createContentType
{
"data": {
"sys": {
"type": "ContentType",
"id": "3ORKIAOaJqQWWg86MWkyOs",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"displayField": "title",
"name": "Blog Post",
"description": "A blog post",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Text",
"localized": true,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "body",
"name": "Body",
"type": "Text",
"localized": true,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
}
Create Environment
Create a new environment | key: createEnvironment
{
"data": {
"name": "master",
"sys": {
"type": "Environment",
"id": "master",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "fm17kie1n0p4"
}
},
"status": {
"sys": {
"type": "Link",
"linkType": "Status",
"id": "ready"
}
},
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"createdAt": "2024-01-29T18:33:02Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"updatedAt": "2024-01-29T18:33:02Z"
}
}
}
Create Space
Create a new space | key: createSpace
{
"data": {
"sys": {
"type": "Space",
"id": "yadj1kx9rmg0",
"version": 3,
"organization": {
"sys": {
"id": "0D9ZC8rLWiw6x5qizZGiRs",
"type": "Link",
"linkType": "Organization"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "Contentful Example API"
}
}
Create Webhook
Create a new webhook | key: createWebhook
{
"data": {
"sys": {
"type": "WebhookDefinition",
"id": "0KzM2HxYr5O1pZ4SaUzK8h",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "My webhook",
"url": "https://www.example.com",
"topics": [
"Entry.create",
"ContentType.create",
"*.publish",
"Asset.*"
],
"httpBasicUsername": "yolo",
"headers": [
{
"key": "header1",
"value": "value1"
},
{
"key": "header2",
"value": "value2"
}
],
"filters": [],
"active": true
}
}
Delete Asset
Delete an existing asset | key: deleteAsset
{
"data": {}
}
Delete Environment
Delete existing environment | key: deleteEnvironment
{
"data": {}
}
Delete Instanced Webhooks
Delete all webhooks that point to a flow in this instance | key: deleteInstancedWebhooks
Delete Space
Delete an existing space | key: deleteSpace
{
"data": {}
}
Delete Upload
Deletes a file from temporary data storage | key: deleteUpload
{
"data": {}
}
Delete Webhook
Delete a webhook | key: deleteWebhook
{
"data": {}
}
Get Asset
Retrieve a single asset | key: getAsset
{
"data": {
"fields": {
"title": {
"en-US": "Playsam Streamliner"
},
"file": {
"en-US": {
"contentType": "image/jpeg",
"fileName": "example.jpeg",
"upload": "https://example.com/example.jpg"
}
}
},
"metadata": {
"tags": [
{
"sys": {
"type": "Link",
"linkType": "Tag",
"id": "nyCampaign"
}
}
]
},
"sys": {
"id": "wtrHxeu3zEoEce2MokCSi",
"type": "Asset",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
}
}
}
Get Bulk Action
Retrieve a bulk action | key: getBulkAction
{
"data": {
"sys": {
"id": "<bulk_action_id>",
"type": "BulkAction",
"status": "<status>",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"createdAt `2020-01-01T13:00:00.000Z`": "",
"updatedAt `2020-01-01T13:00:00.000Z`": "",
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
}
},
"action": "<action>",
"payload": {
"entities": {
"items": [
{
"sys": {
"id": "<entity_id>",
"type": "Link",
"linkType": "<Entry|Asset>",
"version": 0
}
}
]
}
},
"error": {
"sys": {
"id": "<error_type>",
"type": "Error"
}
}
}
}
Get Environment
Retrieve a single environment | key: getEnvironment
{
"data": {
"name": "master",
"sys": {
"type": "Environment",
"id": "master",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "fm17kie1n0p4"
}
},
"status": {
"sys": {
"type": "Link",
"linkType": "Status",
"id": "ready"
}
},
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"createdAt": "2024-01-29T18:33:02Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"updatedAt": "2024-01-29T18:33:02Z"
}
}
}
Get Organization
Retrieve an organization by ID | key: getOrganization
{
"data": {
"sys": {
"type": "Organization",
"id": "0D9ZC8rLWiw6x5qizZGiRs",
"version": 1,
"createdAt": "2015-05-18T11:29:46.809Z",
"updatedAt": "2015-05-18T11:29:46.809Z"
},
"name": "My organization"
}
}
Get Space
Retrieve a single space | key: getSpace
{
"data": {
"sys": {
"type": "Space",
"id": "yadj1kx9rmg0",
"version": 3,
"organization": {
"sys": {
"id": "0D9ZC8rLWiw6x5qizZGiRs",
"type": "Link",
"linkType": "Organization"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "Contentful Example API"
}
}
Get Upload
Retrieves an unmodified image | key: getUpload
{
"data": {
"sys": {
"type": "Upload",
"id": "2DNvIbYNELgqLJUkgTeIOV",
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"expiresAt": "2015-05-18T11:29:46.809Z",
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
}
}
}
Get Webhook
Retrieve a single webhook | key: getWebhook
{
"data": {
"sys": {
"type": "WebhookDefinition",
"id": "0KzM2HxYr5O1pZ4SaUzK8h",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "My webhook",
"url": "https://www.example.com",
"topics": [
"Entry.create",
"ContentType.create",
"*.publish",
"Asset.*"
],
"httpBasicUsername": "yolo",
"headers": [
{
"key": "header1",
"value": "value1"
},
{
"key": "header2",
"value": "value2"
}
],
"filters": [],
"active": true
}
}
List Assets
Retrieve all assets of a space | key: listAssets
{
"data": [
{
"fields": {
"title": {
"en-US": "Playsam Streamliner"
},
"file": {
"en-US": {
"contentType": "image/jpeg",
"fileName": "example.jpeg",
"upload": "https://example.com/example.jpg"
}
}
},
"metadata": {
"tags": [
{
"sys": {
"type": "Link",
"linkType": "Tag",
"id": "nyCampaign"
}
}
]
},
"sys": {
"id": "wtrHxeu3zEoEce2MokCSi",
"type": "Asset",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
}
}
]
}
List Content Types
Retrieves all content types of a space | key: listContentTypes
{
"data": [
{
"sys": {
"type": "ContentType",
"id": "3ORKIAOaJqQWWg86MWkyOs",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"displayField": "title",
"name": "Blog Post",
"description": "A blog post",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Text",
"localized": true,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "body",
"name": "Body",
"type": "Text",
"localized": true,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
]
}
List Environments
Retrieve all environments in a space | key: listEnvironments
{
"data": [
{
"name": "master",
"sys": {
"type": "Environment",
"id": "master",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "fm17kie1n0p4"
}
},
"status": {
"sys": {
"type": "Link",
"linkType": "Status",
"id": "ready"
}
},
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"createdAt": "2024-01-29T18:33:02Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"updatedAt": "2024-01-29T18:33:02Z"
}
}
]
}
List Organizations
Retrieve all organizations an account has access to | key: listOrganizations
{
"data": [
{
"sys": {
"type": "Organization",
"id": "0D9ZC8rLWiw6x5qizZGiRs",
"version": 1,
"createdAt": "2015-05-18T11:29:46.809Z",
"updatedAt": "2015-05-18T11:29:46.809Z"
},
"name": "My organization"
}
]
}
List Spaces
Retrieve all spaces an account has access to | key: listSpaces
{
"data": [
{
"sys": {
"type": "Space",
"id": "yadj1kx9rmg0",
"version": 3,
"organization": {
"sys": {
"id": "0D9ZC8rLWiw6x5qizZGiRs",
"type": "Link",
"linkType": "Organization"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "Contentful Example API"
}
]
}
List Webhooks
Retrieves all webhooks of a space | key: listWebhooks
{
"data": [
{
"sys": {
"type": "WebhookDefinition",
"id": "0KzM2HxYr5O1pZ4SaUzK8h",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "My webhook",
"url": "https://www.example.com",
"topics": [
"Entry.create",
"ContentType.create",
"*.publish",
"Asset.*"
],
"httpBasicUsername": "yolo",
"headers": [
{
"key": "header1",
"value": "value1"
},
{
"key": "header2",
"value": "value2"
}
],
"filters": [],
"active": true
}
]
}
Process Asset
Process an asset | key: processAsset
{
"data": {}
}
Publish an asset
Publishes an asset | key: publishAnAsset
{
"data": {
"fields": {
"title": {
"en-US": "Playsam Streamliner"
},
"file": {
"en-US": {
"contentType": "image/jpeg",
"fileName": "example.jpeg",
"upload": "https://example.com/example.jpg"
}
}
},
"metadata": {
"tags": [
{
"sys": {
"type": "Link",
"linkType": "Tag",
"id": "nyCampaign"
}
}
]
},
"sys": {
"firstPublishedAt": "2015-05-15T13:38:11.311Z",
"publishedCounter": 2,
"publishedAt": "2015-05-15T13:38:11.311Z",
"publishedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
},
"publishedVersion": 9
}
}
}
Publish Bulk Action
Publish a bulk action | key: publishBulkAction
{
"data": {
"sys": {
"id": "<bulk_action_id>",
"type": "BulkAction",
"status": "<status>",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"createdAt": "2020-01-01T13:00:00.000Z",
"updatedAt": "2020-01-01T13:00:00.000Z",
"space": {
"sys": {
"type": "Link",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"id": "staging"
}
}
},
"action": "<action>",
"payload": {
"entities": {
"items": [
{
"sys": {
"id": "<entity_id>",
"type": "Link",
"linkType": "<Entry|Asset>",
"version": 0
}
}
]
}
},
"error": {
"sys": {
"id": "<error_type>",
"type": "Error"
}
}
}
}
Raw Request
Send raw HTTP request to Contentful | key: rawRequest
Unpublish an asset
Unpublishes an asset | key: unpublishAnAsset
{
"data": {
"fields": {
"title": {
"en-US": "Playsam Streamliner"
},
"file": {
"en-US": {
"contentType": "image/jpeg",
"fileName": "example.jpeg",
"upload": "https://example.com/example.jpg"
}
}
},
"metadata": {
"tags": [
{
"sys": {
"type": "Link",
"linkType": "Tag",
"id": "nyCampaign"
}
}
]
},
"sys": {
"id": "wtrHxeu3zEoEce2MokCSi",
"type": "Asset",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
}
}
}
Unpublish Bulk Action
Unpublish a bulk action | key: unpublishBulkAction
{
"data": {
"sys": {
"id": "<bulk_action_id>",
"type": "BulkAction",
"status": "<status>",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"createdAt": "2020-01-01T13:00:00.000Z",
"updatedAt": "2020-01-01T13:00:00.000Z",
"space": {
"sys": {
"type": "Link",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"id": "staging"
}
}
},
"action": "<action>",
"payload": {
"entities": {
"items": [
{
"sys": {
"id": "<entity_id>",
"type": "Link",
"linkType": "<Entry|Asset>",
"version": 0
}
}
]
}
},
"error": {
"sys": {
"id": "<error_type>",
"type": "Error"
}
}
}
}
Update Asset
Update an existing asset | key: updateAsset
{
"data": {
"fields": {
"title": {
"en-US": "Playsam Streamliner"
},
"file": {
"en-US": {
"contentType": "image/jpeg",
"fileName": "example.jpeg",
"upload": "https://example.com/example.jpg"
}
}
},
"metadata": {
"tags": [
{
"sys": {
"type": "Link",
"linkType": "Tag",
"id": "nyCampaign"
}
}
]
},
"sys": {
"id": "wtrHxeu3zEoEce2MokCSi",
"type": "Asset",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
}
}
}
Update Content Type
Update an existing content type | key: updateContentType
{
"data": {
"sys": {
"type": "ContentType",
"id": "3ORKIAOaJqQWWg86MWkyOs",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"environment": {
"sys": {
"type": "Link",
"linkType": "Environment",
"id": "staging"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"displayField": "title",
"name": "Blog Post",
"description": "A blog post",
"fields": [
{
"id": "title",
"name": "Title",
"type": "Text",
"localized": true,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
},
{
"id": "body",
"name": "Body",
"type": "Text",
"localized": true,
"required": true,
"validations": [],
"disabled": false,
"omitted": false
}
]
}
}
Update Environment
Edit an existing environment | key: updateEnvironment
{
"data": {
"name": "master",
"sys": {
"type": "Environment",
"id": "master",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "fm17kie1n0p4"
}
},
"status": {
"sys": {
"type": "Link",
"linkType": "Status",
"id": "ready"
}
},
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"createdAt": "2024-01-29T18:33:02Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "5QvxuP1Kp8mVrw3PVcOp4t"
}
},
"updatedAt": "2024-01-29T18:33:02Z"
}
}
}
Update Organization
Update an organization security contact an admin or owner has access to | key: updateOrganization
{
"data": {
"email": "example@gmail.com",
"sys": {
"type": "Security Contact",
"id": "srdfsguf8325yusf24",
"version": "1",
"organization": {
"sys": {
"id": "0D9ZC8rLWiw6x5qizZGiRs",
"type": "Link",
"linkType": "Organization"
}
},
"createdBy": {
"sys": {
"id": "1xGZIRXr2WPnsLkKfREo0z",
"type": "Link",
"linkType": "User"
}
},
"updatedBy": {
"sys": {
"id": "1xGZIRXr2WPnsLkKfREo0z",
"type": "Link",
"linkType": "User"
}
},
"createdAt": "2019-05-18T11:39:46.809Z",
"updatedAt": "2019-05-18T11:39:46.809Z"
}
}
}
Update Space
Edit an existing Space | key: updateSpace
{
"data": {
"sys": {
"type": "Space",
"id": "yadj1kx9rmg0",
"version": 3,
"organization": {
"sys": {
"id": "0D9ZC8rLWiw6x5qizZGiRs",
"type": "Link",
"linkType": "Organization"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "Contentful Example API"
}
}
Update Webhook
Update an existing webhook | key: updateWebhook
{
"data": {
"sys": {
"type": "WebhookDefinition",
"id": "0KzM2HxYr5O1pZ4SaUzK8h",
"version": 1,
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "7BslKh9TdKGOK41VmLDjFZ"
}
},
"updatedAt": "2015-05-18T11:29:46.809Z",
"updatedBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
},
"name": "My webhook",
"url": "https://www.example.com",
"topics": [
"Entry.create",
"ContentType.create",
"*.publish",
"Asset.*"
],
"httpBasicUsername": "yolo",
"headers": [
{
"key": "header1",
"value": "value1"
},
{
"key": "header2",
"value": "value2"
}
],
"filters": [],
"active": true
}
}
Upload File
Upload a file to temporary file storage | key: uploadFile
{
"data": {
"sys": {
"type": "Upload",
"id": "2DNvIbYNELgqLJUkgTeIOV",
"space": {
"sys": {
"type": "Link",
"linkType": "Space",
"id": "yadj1kx9rmg0"
}
},
"expiresAt": "2015-05-18T11:29:46.809Z",
"createdAt": "2015-05-18T11:29:46.809Z",
"createdBy": {
"sys": {
"type": "Link",
"linkType": "User",
"id": "4FLrUHftHW3v2BLi9fzfjU"
}
}
}
}
}