Create a new Channel

POST

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

POST

/organizations/:organizationId/channels

curl -X POST https://api.contentful.com/organizations/1PLOOEmTI2S1NYald2TemO/channels \
     -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"
    }
  ]
}'

201Created

{
  "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
  }
}

Creates a Channel and returns it. Contentful generates the ID.

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.

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

Created - Channel created

namestring

descriptionstring

propertieslist of objects

nodePropertieslist of objects

sysobject