Upsert a Channel by ID

PUT

https://api.contentful.com/organizations/:organizationId/channels/:channelId

PUT

/organizations/:organizationId/channels/:channelId

curl -X PUT https://api.contentful.com/organizations/1PLOOEmTI2S1NYald2TemO/channels/71dC9lwYk3p6MkM4GoSc8t \
     -H "X-Contentful-Version: 1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "name": "Website",
  "description": "Website routing model",
  "properties": [
    {
      "name": "Base URL",
      "id": "baseUrl",
      "type": "String"
    }
  ],
  "nodeProperties": [
    {
      "name": "Path",
      "type": "Path"
    }
  ]
}'

200Updated

{
  "name": "name",
  "description": "description",
  "properties": [
    {
      "name": "Base URL",
      "id": "baseUrl",
      "type": "String"
    }
  ],
  "nodeProperties": [
    {
      "name": "Path",
      "type": "Path"
    }
  ],
  "sys": {
    "createdAt": "createdAt",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "firstPublishedAt": "firstPublishedAt",
    "id": "id",
    "organization": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "publishedAt": "publishedAt",
    "publishedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "publishedCounter": 1,
    "publishedVersion": 1,
    "type": "Channel",
    "updatedAt": "updatedAt",
    "updatedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "version": 1
  }
}

Updates a Channel by ID, or creates a new one with the specified ID if the Channel does not exist. Omit X-Contentful-Version to create; send the current version to update.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

ID of the organization the Channel belongs to.

channelIdstringRequired

ID of the Channel.

Request

This endpoint expects an object.

namestringRequired

Human-readable name of the Channel.

descriptionstringRequired

What this Channel is for.

propertieslist of objectsRequired

Properties every linked Destination must supply. Property IDs must be unique within the Channel.

nodePropertieslist of objectsRequired

Properties carried by Destination Nodes. Destination Node property names must be unique, and at most one property of type Path is allowed.

Response

OK - Channel updated

namestring

descriptionstring

propertieslist of objects

nodePropertieslist of objects

sysobject

Authentication

Path parameters

Headers

Request

Response