Create a new template | Documentation

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

{
  "sys": {
    "id": "string",
    "type": "string",
    "space": {
      "sys": {
        "type": "string",
        "linkType": "string",
        "id": "string"
      }
    },
    "environment": {
      "sys": {
        "type": "string",
        "linkType": "string",
        "id": "string"
      }
    },
    "version": 1.1,
    "fieldStatus": {},
    "publishedAt": "string",
    "publishedVersion": 1.1,
    "publishedCounter": 1.1,
    "firstPublishedAt": "string",
    "publishedBy": {
      "sys": {
        "type": "string",
        "linkType": "User",
        "id": "string"
      }
    },
    "variant": "string",
    "variantType": "string",
    "variantDimension": "string",
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "type": "string",
        "linkType": "string",
        "id": "string"
      }
    },
    "updatedAt": "string",
    "updatedBy": {
      "sys": {
        "type": "string",
        "linkType": "string",
        "id": "string"
      }
    }
  },
  "name": "string",
  "description": "string",
  "viewports": [
    {
      "id": "string",
      "query": "string",
      "displayName": "string",
      "previewSize": "string"
    }
  ],
  "contentProperties": [
    {
      "name": "string",
      "required": true,
      "type": "String",
      "id": "string"
    }
  ],
  "designProperties": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "type": "string",
      "fallbackValue": {
        "type": "string",
        "value": "string"
      },
      "validations": [
        {
          "regexp": {
            "pattern": "string"
          }
        }
      ]
    }
  ],
  "dimensionKeyMap": {
    "designProperties": {}
  },
  "componentTree": [
    {
      "id": "string",
      "nodeType": "string",
      "componentType": {
        "sys": {
          "type": "string",
          "linkType": "string",
          "urn": "string"
        }
      },
      "contentProperties": {},
      "designProperties": {},
      "slots": {},
      "name": "string"
    }
  ],
  "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"
        }
      }
    ]
  },
  "dataAssemblies": [
    {
      "sys": {
        "type": "string",
        "linkType": "string",
        "urn": "string"
      }
    }
  ]
}

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

environmentIdstringRequired

Query parameters

access_tokenstringOptional

Request

Body

namestringRequired

descriptionstringRequired

viewportslist of objectsRequired

contentPropertieslist of objectsRequired

designPropertieslist of objectsRequired

dimensionKeyMapobjectRequired

componentTreelist of objectsOptional

slotslist of objectsOptional

metadataobjectOptional

dataAssemblieslist of objectsOptional

Response

201

sysobject

namestring

descriptionstring

viewportslist of objects

contentPropertieslist of objects

designPropertieslist of objects

dimensionKeyMapobject

componentTreelist of objects

slotslist of objects

metadataobject

dataAssemblieslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

1	{
2	"sys": {
3	"id": "string",
4	"type": "string",
5	"space": {
6	"sys": {
7	"type": "string",
8	"linkType": "string",
9	"id": "string"
10	}
11	},
12	"environment": {
13	"sys": {
14	"type": "string",
15	"linkType": "string",
16	"id": "string"
17	}
18	},
19	"version": 1.1,
20	"fieldStatus": {},
21	"publishedAt": "string",
22	"publishedVersion": 1.1,
23	"publishedCounter": 1.1,
24	"firstPublishedAt": "string",
25	"publishedBy": {
26	"sys": {
27	"type": "string",
28	"linkType": "User",
29	"id": "string"
30	}
31	},
32	"variant": "string",
33	"variantType": "string",
34	"variantDimension": "string",
35	"createdAt": "string",
36	"createdBy": {
37	"sys": {
38	"type": "string",
39	"linkType": "string",
40	"id": "string"
41	}
42	},
43	"updatedAt": "string",
44	"updatedBy": {
45	"sys": {
46	"type": "string",
47	"linkType": "string",
48	"id": "string"
49	}
50	}
51	},
52	"name": "string",
53	"description": "string",
54	"viewports": [
55	{
56	"id": "string",
57	"query": "string",
58	"displayName": "string",
59	"previewSize": "string"
60	}
61	],
62	"contentProperties": [
63	{
64	"name": "string",
65	"required": true,
66	"type": "String",
67	"id": "string"
68	}
69	],
70	"designProperties": [
71	{
72	"id": "string",
73	"name": "string",
74	"description": "string",
75	"type": "string",
76	"fallbackValue": {
77	"type": "string",
78	"value": "string"
79	},
80	"validations": [
81	{
82	"regexp": {
83	"pattern": "string"
84	}
85	}
86	]
87	}
88	],
89	"dimensionKeyMap": {
90	"designProperties": {}
91	},
92	"componentTree": [
93	{
94	"id": "string",
95	"nodeType": "string",
96	"componentType": {
97	"sys": {
98	"type": "string",
99	"linkType": "string",
100	"urn": "string"
101	}
102	},
103	"contentProperties": {},
104	"designProperties": {},
105	"slots": {},
106	"name": "string"
107	}
108	],
109	"slots": [
110	{
111	"id": "string",
112	"name": "string",
113	"required": true,
114	"validations": [
115	{
116	"size": {
117	"min": 1.1,
118	"max": 1.1
119	}
120	}
121	],
122	"allowedResources": [
123	{
124	"type": "string",
125	"source": "string",
126	"allowedTypes": [
127	"string"
128	]
129	}
130	]
131	}
132	],
133	"metadata": {
134	"tags": [
135	{
136	"sys": {
137	"type": "string",
138	"linkType": "string",
139	"id": "string"
140	}
141	}
142	],
143	"concepts": [
144	{
145	"sys": {
146	"type": "string",
147	"linkType": "string",
148	"id": "string"
149	}
150	}
151	]
152	},
153	"dataAssemblies": [
154	{
155	"sys": {
156	"type": "string",
157	"linkType": "string",
158	"urn": "string"
159	}
160	}
161	]
162	}