webflow-api 3.3.0-beta → 3.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (563) hide show
  1. package/BaseClient.d.ts +1 -1
  2. package/Client.d.ts +1 -7
  3. package/Client.js +31 -41
  4. package/LICENSE +18 -18
  5. package/README.md +55 -28
  6. package/api/resources/assets/client/Client.d.ts +4 -4
  7. package/api/resources/assets/client/Client.js +7 -8
  8. package/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
  9. package/api/resources/collections/client/Client.d.ts +2 -2
  10. package/api/resources/collections/client/Client.js +3 -6
  11. package/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
  12. package/api/resources/collections/resources/fields/client/Client.js +4 -6
  13. package/api/resources/collections/resources/items/client/Client.d.ts +6 -6
  14. package/api/resources/collections/resources/items/client/Client.js +24 -12
  15. package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
  16. package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
  17. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
  18. package/{dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
  19. package/api/resources/collections/resources/items/types/index.d.ts +1 -1
  20. package/api/resources/collections/resources/items/types/index.js +1 -1
  21. package/api/resources/components/client/Client.d.ts +8 -8
  22. package/api/resources/components/client/Client.js +10 -12
  23. package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
  24. package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
  25. package/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
  26. package/api/resources/ecommerce/client/Client.d.ts +2 -2
  27. package/api/resources/ecommerce/client/Client.js +2 -6
  28. package/api/resources/forms/client/Client.d.ts +6 -6
  29. package/api/resources/forms/client/Client.js +7 -10
  30. package/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
  31. package/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  32. package/api/resources/index.d.ts +0 -6
  33. package/api/resources/index.js +1 -7
  34. package/api/resources/inventory/client/Client.d.ts +2 -2
  35. package/api/resources/inventory/client/Client.js +3 -6
  36. package/api/resources/orders/client/Client.d.ts +4 -4
  37. package/api/resources/orders/client/Client.js +8 -8
  38. package/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
  39. package/api/resources/pages/client/Client.d.ts +6 -6
  40. package/api/resources/pages/client/Client.js +8 -10
  41. package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  42. package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  43. package/api/resources/pages/resources/scripts/client/Client.d.ts +2 -2
  44. package/api/resources/pages/resources/scripts/client/Client.js +3 -6
  45. package/api/resources/products/client/Client.d.ts +4 -4
  46. package/api/resources/products/client/Client.js +8 -8
  47. package/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
  48. package/api/resources/scripts/client/Client.d.ts +2 -2
  49. package/api/resources/scripts/client/Client.js +4 -6
  50. package/api/resources/sites/client/Client.d.ts +2 -2
  51. package/api/resources/sites/client/Client.js +5 -6
  52. package/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
  53. package/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
  54. package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
  55. package/api/resources/sites/resources/comments/client/Client.d.ts +8 -8
  56. package/api/resources/sites/resources/comments/client/Client.js +14 -12
  57. package/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
  58. package/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
  59. package/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
  60. package/api/resources/sites/resources/forms/client/Client.d.ts +6 -6
  61. package/api/resources/sites/resources/forms/client/Client.js +7 -10
  62. package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
  63. package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  64. package/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
  65. package/api/resources/sites/resources/plans/client/Client.js +2 -6
  66. package/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
  67. package/api/resources/sites/resources/redirects/client/Client.js +6 -8
  68. package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
  69. package/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
  70. package/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
  71. package/api/resources/sites/resources/scripts/client/Client.js +5 -8
  72. package/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
  73. package/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
  74. package/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
  75. package/api/resources/token/client/Client.d.ts +2 -2
  76. package/api/resources/token/client/Client.js +2 -6
  77. package/api/resources/webhooks/client/Client.d.ts +2 -2
  78. package/api/resources/webhooks/client/Client.js +3 -6
  79. package/api/resources/workspaces/client/Client.d.ts +1 -1
  80. package/api/resources/workspaces/client/Client.js +1 -1
  81. package/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
  82. package/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
  83. package/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
  84. package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
  85. package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  86. package/api/types/AssetVariant.d.ts +6 -6
  87. package/api/types/ComponentDom.d.ts +1 -1
  88. package/api/types/ForbiddenErrorBody.d.ts +1 -1
  89. package/api/types/ProductFieldData.d.ts +1 -1
  90. package/api/types/SettingChange.d.ts +7 -0
  91. package/api/types/SettingChangeAuditLogItem.d.ts +5 -0
  92. package/api/types/TriggerType.d.ts +0 -3
  93. package/api/types/TriggerType.js +0 -3
  94. package/api/types/WorkspaceAuditLogItem.d.ts +4 -1
  95. package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
  96. package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
  97. package/api/types/index.d.ts +3 -13
  98. package/api/types/index.js +3 -13
  99. package/dist/BaseClient.d.ts +1 -1
  100. package/dist/Client.d.ts +1 -7
  101. package/dist/Client.js +31 -41
  102. package/dist/api/resources/assets/client/Client.d.ts +4 -4
  103. package/dist/api/resources/assets/client/Client.js +7 -8
  104. package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
  105. package/dist/api/resources/collections/client/Client.d.ts +2 -2
  106. package/dist/api/resources/collections/client/Client.js +3 -6
  107. package/dist/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
  108. package/dist/api/resources/collections/resources/fields/client/Client.js +4 -6
  109. package/dist/api/resources/collections/resources/items/client/Client.d.ts +6 -6
  110. package/dist/api/resources/collections/resources/items/client/Client.js +24 -12
  111. package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
  112. package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
  113. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
  114. package/{api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
  115. package/dist/api/resources/collections/resources/items/types/index.d.ts +1 -1
  116. package/dist/api/resources/collections/resources/items/types/index.js +1 -1
  117. package/dist/api/resources/components/client/Client.d.ts +8 -8
  118. package/dist/api/resources/components/client/Client.js +10 -12
  119. package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
  120. package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
  121. package/dist/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
  122. package/dist/api/resources/ecommerce/client/Client.d.ts +2 -2
  123. package/dist/api/resources/ecommerce/client/Client.js +2 -6
  124. package/dist/api/resources/forms/client/Client.d.ts +6 -6
  125. package/dist/api/resources/forms/client/Client.js +7 -10
  126. package/dist/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
  127. package/dist/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  128. package/dist/api/resources/index.d.ts +0 -6
  129. package/dist/api/resources/index.js +1 -7
  130. package/dist/api/resources/inventory/client/Client.d.ts +2 -2
  131. package/dist/api/resources/inventory/client/Client.js +3 -6
  132. package/dist/api/resources/orders/client/Client.d.ts +4 -4
  133. package/dist/api/resources/orders/client/Client.js +8 -8
  134. package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
  135. package/dist/api/resources/pages/client/Client.d.ts +6 -6
  136. package/dist/api/resources/pages/client/Client.js +8 -10
  137. package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  138. package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  139. package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +2 -2
  140. package/dist/api/resources/pages/resources/scripts/client/Client.js +3 -6
  141. package/dist/api/resources/products/client/Client.d.ts +4 -4
  142. package/dist/api/resources/products/client/Client.js +8 -8
  143. package/dist/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
  144. package/dist/api/resources/scripts/client/Client.d.ts +2 -2
  145. package/dist/api/resources/scripts/client/Client.js +4 -6
  146. package/dist/api/resources/sites/client/Client.d.ts +2 -2
  147. package/dist/api/resources/sites/client/Client.js +5 -6
  148. package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
  149. package/dist/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
  150. package/dist/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
  151. package/dist/api/resources/sites/resources/comments/client/Client.d.ts +8 -8
  152. package/dist/api/resources/sites/resources/comments/client/Client.js +14 -12
  153. package/dist/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
  154. package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
  155. package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
  156. package/dist/api/resources/sites/resources/forms/client/Client.d.ts +6 -6
  157. package/dist/api/resources/sites/resources/forms/client/Client.js +7 -10
  158. package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
  159. package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
  160. package/dist/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
  161. package/dist/api/resources/sites/resources/plans/client/Client.js +2 -6
  162. package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
  163. package/dist/api/resources/sites/resources/redirects/client/Client.js +6 -8
  164. package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
  165. package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
  166. package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
  167. package/dist/api/resources/sites/resources/scripts/client/Client.js +5 -8
  168. package/dist/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
  169. package/dist/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
  170. package/dist/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
  171. package/dist/api/resources/token/client/Client.d.ts +2 -2
  172. package/dist/api/resources/token/client/Client.js +2 -6
  173. package/dist/api/resources/webhooks/client/Client.d.ts +2 -2
  174. package/dist/api/resources/webhooks/client/Client.js +3 -6
  175. package/dist/api/resources/workspaces/client/Client.d.ts +1 -1
  176. package/dist/api/resources/workspaces/client/Client.js +1 -1
  177. package/dist/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
  178. package/dist/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
  179. package/dist/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
  180. package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
  181. package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  182. package/dist/api/types/AssetVariant.d.ts +6 -6
  183. package/dist/api/types/ComponentDom.d.ts +1 -1
  184. package/dist/api/types/ForbiddenErrorBody.d.ts +1 -1
  185. package/dist/api/types/ProductFieldData.d.ts +1 -1
  186. package/dist/api/types/SettingChange.d.ts +7 -0
  187. package/dist/api/types/SettingChangeAuditLogItem.d.ts +5 -0
  188. package/dist/api/types/TriggerType.d.ts +0 -3
  189. package/dist/api/types/TriggerType.js +0 -3
  190. package/dist/api/types/WorkspaceAuditLogItem.d.ts +4 -1
  191. package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
  192. package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
  193. package/dist/api/types/index.d.ts +3 -13
  194. package/dist/api/types/index.js +3 -13
  195. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
  196. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
  197. package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
  198. package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
  199. package/dist/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
  200. package/dist/serialization/resources/collections/resources/items/types/index.js +1 -1
  201. package/dist/serialization/resources/index.d.ts +0 -5
  202. package/dist/serialization/resources/index.js +1 -6
  203. package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
  204. package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  205. package/dist/serialization/types/AssetVariant.d.ts +6 -6
  206. package/dist/serialization/types/AssetVariant.js +6 -6
  207. package/dist/serialization/types/ForbiddenErrorBody.d.ts +2 -2
  208. package/dist/serialization/types/ForbiddenErrorBody.js +2 -2
  209. package/dist/serialization/types/SettingChange.d.ts +13 -0
  210. package/dist/serialization/types/{AccessGroup.js → SettingChange.js} +7 -7
  211. package/dist/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
  212. package/dist/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
  213. package/dist/serialization/types/TriggerType.d.ts +1 -1
  214. package/dist/serialization/types/TriggerType.js +0 -3
  215. package/dist/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
  216. package/dist/serialization/types/WorkspaceAuditLogItem.js +2 -0
  217. package/dist/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
  218. package/dist/serialization/types/{UserStatus.js → WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
  219. package/dist/serialization/types/index.d.ts +3 -13
  220. package/dist/serialization/types/index.js +3 -13
  221. package/dist/version.d.ts +1 -1
  222. package/dist/version.js +1 -1
  223. package/dist/wrapper/AssetsUtilitiesClient.d.ts +1 -1
  224. package/dist/wrapper/FormsClient.js +5 -5
  225. package/dist/wrapper/ItemsClient.js +20 -20
  226. package/dist/wrapper/PagesClient.js +5 -5
  227. package/dist/wrapper/WebflowClient.js +1 -1
  228. package/jest.config.mjs +1 -1
  229. package/package.json +2 -1
  230. package/reference.md +68 -544
  231. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
  232. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
  233. package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
  234. package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
  235. package/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
  236. package/serialization/resources/collections/resources/items/types/index.js +1 -1
  237. package/serialization/resources/index.d.ts +0 -5
  238. package/serialization/resources/index.js +1 -6
  239. package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
  240. package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
  241. package/serialization/types/AssetVariant.d.ts +6 -6
  242. package/serialization/types/AssetVariant.js +6 -6
  243. package/serialization/types/ForbiddenErrorBody.d.ts +2 -2
  244. package/serialization/types/ForbiddenErrorBody.js +2 -2
  245. package/serialization/types/SettingChange.d.ts +13 -0
  246. package/{dist/serialization/types/AccessGroupList.js → serialization/types/SettingChange.js} +7 -8
  247. package/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
  248. package/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
  249. package/serialization/types/TriggerType.d.ts +1 -1
  250. package/serialization/types/TriggerType.js +0 -3
  251. package/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
  252. package/serialization/types/WorkspaceAuditLogItem.js +2 -0
  253. package/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
  254. package/{dist/serialization/types/UserLimitReached.js → serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
  255. package/serialization/types/index.d.ts +3 -13
  256. package/serialization/types/index.js +3 -13
  257. package/version.d.ts +1 -1
  258. package/version.js +1 -1
  259. package/wrapper/AssetsUtilitiesClient.d.ts +1 -1
  260. package/wrapper/FormsClient.js +5 -5
  261. package/wrapper/ItemsClient.js +20 -20
  262. package/wrapper/PagesClient.js +5 -5
  263. package/wrapper/WebflowClient.js +1 -1
  264. package/.mock/definition/__package__.yml +0 -4471
  265. package/.mock/definition/accessGroups.yml +0 -87
  266. package/.mock/definition/api.yml +0 -18
  267. package/.mock/definition/assets.yml +0 -487
  268. package/.mock/definition/collections/fields.yml +0 -212
  269. package/.mock/definition/collections/items.yml +0 -2145
  270. package/.mock/definition/collections.yml +0 -350
  271. package/.mock/definition/comments.yml +0 -41
  272. package/.mock/definition/components.yml +0 -548
  273. package/.mock/definition/ecommerce.yml +0 -45
  274. package/.mock/definition/forms.yml +0 -399
  275. package/.mock/definition/inventory.yml +0 -152
  276. package/.mock/definition/items.yml +0 -112
  277. package/.mock/definition/orders.yml +0 -1971
  278. package/.mock/definition/pages/scripts.yml +0 -155
  279. package/.mock/definition/pages.yml +0 -611
  280. package/.mock/definition/products.yml +0 -642
  281. package/.mock/definition/scripts.yml +0 -236
  282. package/.mock/definition/sites/activityLogs.yml +0 -77
  283. package/.mock/definition/sites/comments.yml +0 -352
  284. package/.mock/definition/sites/forms.yml +0 -316
  285. package/.mock/definition/sites/plans.yml +0 -48
  286. package/.mock/definition/sites/redirects.yml +0 -221
  287. package/.mock/definition/sites/robotsTxt.yml +0 -229
  288. package/.mock/definition/sites/scripts.yml +0 -243
  289. package/.mock/definition/sites/wellKnown.yml +0 -130
  290. package/.mock/definition/sites.yml +0 -558
  291. package/.mock/definition/token.yml +0 -75
  292. package/.mock/definition/users.yml +0 -594
  293. package/.mock/definition/webhooks.yml +0 -188
  294. package/.mock/definition/workspaces/auditLogs.yml +0 -125
  295. package/.mock/fern.config.json +0 -4
  296. package/api/resources/accessGroups/client/Client.d.ts +0 -39
  297. package/api/resources/accessGroups/client/Client.js +0 -197
  298. package/api/resources/accessGroups/client/index.d.ts +0 -1
  299. package/api/resources/accessGroups/client/index.js +0 -17
  300. package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
  301. package/api/resources/accessGroups/client/requests/index.d.ts +0 -1
  302. package/api/resources/accessGroups/client/requests/index.js +0 -2
  303. package/api/resources/accessGroups/index.d.ts +0 -2
  304. package/api/resources/accessGroups/index.js +0 -18
  305. package/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
  306. package/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
  307. package/api/resources/accessGroups/types/index.d.ts +0 -1
  308. package/api/resources/accessGroups/types/index.js +0 -17
  309. package/api/resources/users/client/Client.d.ts +0 -145
  310. package/api/resources/users/client/Client.js +0 -670
  311. package/api/resources/users/client/index.d.ts +0 -1
  312. package/api/resources/users/client/index.js +0 -17
  313. package/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
  314. package/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
  315. package/api/resources/users/client/requests/index.d.ts +0 -2
  316. package/api/resources/users/client/requests/index.js +0 -2
  317. package/api/resources/users/index.d.ts +0 -2
  318. package/api/resources/users/index.js +0 -18
  319. package/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
  320. package/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  321. package/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
  322. package/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
  323. package/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
  324. package/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
  325. package/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  326. package/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
  327. package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
  328. package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
  329. package/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
  330. package/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
  331. package/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  332. package/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
  333. package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
  334. package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
  335. package/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
  336. package/api/resources/users/types/UsersListRequestSort.js +0 -36
  337. package/api/resources/users/types/index.d.ts +0 -10
  338. package/api/resources/users/types/index.js +0 -26
  339. package/api/types/AccessGroup.d.ts +0 -12
  340. package/api/types/AccessGroup.js +0 -3
  341. package/api/types/AccessGroupList.d.ts +0 -16
  342. package/api/types/AccessGroupList.js +0 -3
  343. package/api/types/ConflictErrorBody.d.ts +0 -2
  344. package/api/types/ConflictErrorBody.js +0 -3
  345. package/api/types/DuplicateUserEmail.d.ts +0 -1
  346. package/api/types/DuplicateUserEmail.js +0 -3
  347. package/api/types/User.d.ts +0 -22
  348. package/api/types/User.js +0 -3
  349. package/api/types/UserAccessGroupsItem.d.ts +0 -14
  350. package/api/types/UserAccessGroupsItem.js +0 -3
  351. package/api/types/UserAccessGroupsItemType.d.ts +0 -10
  352. package/api/types/UserAccessGroupsItemType.js +0 -13
  353. package/api/types/UserData.d.ts +0 -7
  354. package/api/types/UserData.js +0 -3
  355. package/api/types/UserDataData.d.ts +0 -12
  356. package/api/types/UserDataData.js +0 -3
  357. package/api/types/UserLimitReached.d.ts +0 -1
  358. package/api/types/UserLimitReached.js +0 -3
  359. package/api/types/UserList.d.ts +0 -16
  360. package/api/types/UserList.js +0 -3
  361. package/api/types/UserStatus.d.ts +0 -7
  362. package/api/types/UserStatus.js +0 -10
  363. package/api/types/UsersNotEnabled.d.ts +0 -1
  364. package/api/types/UsersNotEnabled.js +0 -3
  365. package/dist/api/resources/accessGroups/client/Client.d.ts +0 -39
  366. package/dist/api/resources/accessGroups/client/Client.js +0 -197
  367. package/dist/api/resources/accessGroups/client/index.d.ts +0 -1
  368. package/dist/api/resources/accessGroups/client/index.js +0 -17
  369. package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
  370. package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.js +0 -3
  371. package/dist/api/resources/accessGroups/client/requests/index.d.ts +0 -1
  372. package/dist/api/resources/accessGroups/client/requests/index.js +0 -2
  373. package/dist/api/resources/accessGroups/index.d.ts +0 -2
  374. package/dist/api/resources/accessGroups/index.js +0 -18
  375. package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
  376. package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
  377. package/dist/api/resources/accessGroups/types/index.d.ts +0 -1
  378. package/dist/api/resources/accessGroups/types/index.js +0 -17
  379. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +0 -3
  380. package/dist/api/resources/users/client/Client.d.ts +0 -145
  381. package/dist/api/resources/users/client/Client.js +0 -670
  382. package/dist/api/resources/users/client/index.d.ts +0 -1
  383. package/dist/api/resources/users/client/index.js +0 -17
  384. package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
  385. package/dist/api/resources/users/client/requests/UsersInviteRequest.js +0 -3
  386. package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
  387. package/dist/api/resources/users/client/requests/UsersListRequest.js +0 -3
  388. package/dist/api/resources/users/client/requests/index.d.ts +0 -2
  389. package/dist/api/resources/users/client/requests/index.js +0 -2
  390. package/dist/api/resources/users/index.d.ts +0 -2
  391. package/dist/api/resources/users/index.js +0 -18
  392. package/dist/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
  393. package/dist/api/resources/users/types/UserAccountAddedPayload.js +0 -3
  394. package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  395. package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.js +0 -3
  396. package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
  397. package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
  398. package/dist/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
  399. package/dist/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
  400. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  401. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
  402. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
  403. package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
  404. package/dist/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
  405. package/dist/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
  406. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  407. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
  408. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
  409. package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
  410. package/dist/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
  411. package/dist/api/resources/users/types/UsersListRequestSort.js +0 -36
  412. package/dist/api/resources/users/types/index.d.ts +0 -10
  413. package/dist/api/resources/users/types/index.js +0 -26
  414. package/dist/api/types/AccessGroup.d.ts +0 -12
  415. package/dist/api/types/AccessGroup.js +0 -3
  416. package/dist/api/types/AccessGroupList.d.ts +0 -16
  417. package/dist/api/types/AccessGroupList.js +0 -3
  418. package/dist/api/types/ConflictErrorBody.d.ts +0 -2
  419. package/dist/api/types/ConflictErrorBody.js +0 -3
  420. package/dist/api/types/DuplicateUserEmail.d.ts +0 -1
  421. package/dist/api/types/DuplicateUserEmail.js +0 -3
  422. package/dist/api/types/User.d.ts +0 -22
  423. package/dist/api/types/User.js +0 -3
  424. package/dist/api/types/UserAccessGroupsItem.d.ts +0 -14
  425. package/dist/api/types/UserAccessGroupsItem.js +0 -3
  426. package/dist/api/types/UserAccessGroupsItemType.d.ts +0 -10
  427. package/dist/api/types/UserAccessGroupsItemType.js +0 -13
  428. package/dist/api/types/UserData.d.ts +0 -7
  429. package/dist/api/types/UserData.js +0 -3
  430. package/dist/api/types/UserDataData.d.ts +0 -12
  431. package/dist/api/types/UserDataData.js +0 -3
  432. package/dist/api/types/UserLimitReached.d.ts +0 -1
  433. package/dist/api/types/UserLimitReached.js +0 -3
  434. package/dist/api/types/UserList.d.ts +0 -16
  435. package/dist/api/types/UserList.js +0 -3
  436. package/dist/api/types/UserStatus.d.ts +0 -7
  437. package/dist/api/types/UserStatus.js +0 -10
  438. package/dist/api/types/UsersNotEnabled.d.ts +0 -1
  439. package/dist/api/types/UsersNotEnabled.js +0 -3
  440. package/dist/serialization/resources/accessGroups/index.d.ts +0 -1
  441. package/dist/serialization/resources/accessGroups/index.js +0 -17
  442. package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
  443. package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
  444. package/dist/serialization/resources/accessGroups/types/index.d.ts +0 -1
  445. package/dist/serialization/resources/accessGroups/types/index.js +0 -17
  446. package/dist/serialization/resources/users/client/index.d.ts +0 -1
  447. package/dist/serialization/resources/users/client/index.js +0 -17
  448. package/dist/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
  449. package/dist/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
  450. package/dist/serialization/resources/users/client/requests/index.d.ts +0 -1
  451. package/dist/serialization/resources/users/client/requests/index.js +0 -5
  452. package/dist/serialization/resources/users/index.d.ts +0 -2
  453. package/dist/serialization/resources/users/index.js +0 -18
  454. package/dist/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
  455. package/dist/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
  456. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  457. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
  458. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
  459. package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
  460. package/dist/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
  461. package/dist/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
  462. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  463. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
  464. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
  465. package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
  466. package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
  467. package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
  468. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  469. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
  470. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
  471. package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
  472. package/dist/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
  473. package/dist/serialization/resources/users/types/UsersListRequestSort.js +0 -50
  474. package/dist/serialization/resources/users/types/index.d.ts +0 -10
  475. package/dist/serialization/resources/users/types/index.js +0 -26
  476. package/dist/serialization/types/AccessGroup.d.ts +0 -13
  477. package/dist/serialization/types/AccessGroupList.d.ts +0 -14
  478. package/dist/serialization/types/ConflictErrorBody.d.ts +0 -9
  479. package/dist/serialization/types/ConflictErrorBody.js +0 -41
  480. package/dist/serialization/types/DuplicateUserEmail.d.ts +0 -7
  481. package/dist/serialization/types/DuplicateUserEmail.js +0 -39
  482. package/dist/serialization/types/User.d.ts +0 -20
  483. package/dist/serialization/types/User.js +0 -52
  484. package/dist/serialization/types/UserAccessGroupsItem.d.ts +0 -11
  485. package/dist/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
  486. package/dist/serialization/types/UserAccessGroupsItemType.js +0 -39
  487. package/dist/serialization/types/UserData.d.ts +0 -10
  488. package/dist/serialization/types/UserData.js +0 -42
  489. package/dist/serialization/types/UserDataData.d.ts +0 -13
  490. package/dist/serialization/types/UserDataData.js +0 -45
  491. package/dist/serialization/types/UserLimitReached.d.ts +0 -7
  492. package/dist/serialization/types/UserList.d.ts +0 -14
  493. package/dist/serialization/types/UserList.js +0 -46
  494. package/dist/serialization/types/UserStatus.d.ts +0 -7
  495. package/dist/serialization/types/UsersNotEnabled.d.ts +0 -7
  496. package/dist/serialization/types/UsersNotEnabled.js +0 -39
  497. package/serialization/resources/accessGroups/index.d.ts +0 -1
  498. package/serialization/resources/accessGroups/index.js +0 -17
  499. package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
  500. package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
  501. package/serialization/resources/accessGroups/types/index.d.ts +0 -1
  502. package/serialization/resources/accessGroups/types/index.js +0 -17
  503. package/serialization/resources/users/client/index.d.ts +0 -1
  504. package/serialization/resources/users/client/index.js +0 -17
  505. package/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
  506. package/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
  507. package/serialization/resources/users/client/requests/index.d.ts +0 -1
  508. package/serialization/resources/users/client/requests/index.js +0 -5
  509. package/serialization/resources/users/index.d.ts +0 -2
  510. package/serialization/resources/users/index.js +0 -18
  511. package/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
  512. package/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
  513. package/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
  514. package/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
  515. package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
  516. package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
  517. package/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
  518. package/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
  519. package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
  520. package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
  521. package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
  522. package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
  523. package/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
  524. package/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
  525. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
  526. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
  527. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
  528. package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
  529. package/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
  530. package/serialization/resources/users/types/UsersListRequestSort.js +0 -50
  531. package/serialization/resources/users/types/index.d.ts +0 -10
  532. package/serialization/resources/users/types/index.js +0 -26
  533. package/serialization/types/AccessGroup.d.ts +0 -13
  534. package/serialization/types/AccessGroup.js +0 -45
  535. package/serialization/types/AccessGroupList.d.ts +0 -14
  536. package/serialization/types/AccessGroupList.js +0 -46
  537. package/serialization/types/ConflictErrorBody.d.ts +0 -9
  538. package/serialization/types/ConflictErrorBody.js +0 -41
  539. package/serialization/types/DuplicateUserEmail.d.ts +0 -7
  540. package/serialization/types/DuplicateUserEmail.js +0 -39
  541. package/serialization/types/User.d.ts +0 -20
  542. package/serialization/types/User.js +0 -52
  543. package/serialization/types/UserAccessGroupsItem.d.ts +0 -11
  544. package/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
  545. package/serialization/types/UserAccessGroupsItemType.js +0 -39
  546. package/serialization/types/UserData.d.ts +0 -10
  547. package/serialization/types/UserData.js +0 -42
  548. package/serialization/types/UserDataData.d.ts +0 -13
  549. package/serialization/types/UserDataData.js +0 -45
  550. package/serialization/types/UserLimitReached.d.ts +0 -7
  551. package/serialization/types/UserLimitReached.js +0 -39
  552. package/serialization/types/UserList.d.ts +0 -14
  553. package/serialization/types/UserList.js +0 -46
  554. package/serialization/types/UserStatus.d.ts +0 -7
  555. package/serialization/types/UserStatus.js +0 -39
  556. package/serialization/types/UsersNotEnabled.d.ts +0 -7
  557. package/serialization/types/UsersNotEnabled.js +0 -39
  558. /package/api/resources/{accessGroups/client/requests/AccessGroupsListRequest.js → collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
  559. /package/api/{resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → types/SettingChange.js} +0 -0
  560. /package/api/{resources/users/client/requests/UsersInviteRequest.js → types/SettingChangeAuditLogItem.js} +0 -0
  561. /package/{api/resources/users/client/requests/UsersListRequest.js → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
  562. /package/{api/resources/users/types/UserAccountAddedPayload.js → dist/api/types/SettingChange.js} +0 -0
  563. /package/{api/resources/users/types/UserAccountAddedPayloadPayload.js → dist/api/types/SettingChangeAuditLogItem.js} +0 -0
@@ -1,2145 +0,0 @@
1
- imports:
2
- root: ../__package__.yml
3
- types:
4
- ItemsListItemsRequestSortBy:
5
- enum:
6
- - lastPublished
7
- - name
8
- - slug
9
- source:
10
- openapi: ../../../openapi/referenced-specs/v2.yml
11
- ItemsListItemsRequestSortOrder:
12
- enum:
13
- - asc
14
- - desc
15
- source:
16
- openapi: ../../../openapi/referenced-specs/v2.yml
17
- Multiple Items:
18
- properties:
19
- items:
20
- type: optional<list<root.CollectionItemPostSingle>>
21
- docs: An array of items to create
22
- source:
23
- openapi: ../../../openapi/referenced-specs/v2.yml
24
- inline: true
25
- ItemsCreateItemRequestBody:
26
- discriminated: false
27
- union:
28
- - root.CollectionItemPostSingle
29
- - type: Multiple Items
30
- source:
31
- openapi: ../../../openapi/referenced-specs/v2.yml
32
- ItemsDeleteItemsRequestItemsItem:
33
- properties:
34
- id:
35
- type: string
36
- docs: Unique identifier for the Item
37
- cmsLocaleIds:
38
- type: optional<list<string>>
39
- docs: Array of identifiers for the locales where the item will be created
40
- source:
41
- openapi: ../../../openapi/referenced-specs/v2.yml
42
- inline: true
43
- ItemsUpdateItemsResponse:
44
- discriminated: false
45
- union:
46
- - type: root.CollectionItem
47
- - type: root.CollectionItemList
48
- source:
49
- openapi: ../../../openapi/referenced-specs/v2.yml
50
- ItemsListItemsLiveRequestSortBy:
51
- enum:
52
- - lastPublished
53
- - name
54
- - slug
55
- source:
56
- openapi: ../../../openapi/referenced-specs/v2.yml
57
- ItemsListItemsLiveRequestSortOrder:
58
- enum:
59
- - asc
60
- - desc
61
- source:
62
- openapi: ../../../openapi/referenced-specs/v2.yml
63
- Multiple Live Items:
64
- properties:
65
- items:
66
- type: optional<list<root.CollectionItem>>
67
- docs: List of collection items to create
68
- source:
69
- openapi: ../../../openapi/referenced-specs/v2.yml
70
- inline: true
71
- ItemsCreateItemLiveRequestBody:
72
- discriminated: false
73
- union:
74
- - type: root.CollectionItem
75
- - type: Multiple Live Items
76
- source:
77
- openapi: ../../../openapi/referenced-specs/v2.yml
78
- ItemsDeleteItemsLiveRequestItemsItem:
79
- properties:
80
- id:
81
- type: string
82
- docs: Unique identifier for the Item
83
- cmsLocaleIds:
84
- type: optional<list<string>>
85
- docs: Array of identifiers for the locales where the item will be created
86
- source:
87
- openapi: ../../../openapi/referenced-specs/v2.yml
88
- inline: true
89
- Single CMS Item:
90
- properties:
91
- name:
92
- type: string
93
- docs: The name of the item.
94
- slug:
95
- type: string
96
- docs: >-
97
- URL slug for the item in your site.
98
-
99
- Note: Updating the item slug will break all links referencing the old
100
- slug.
101
- extra-properties: true
102
- source:
103
- openapi: ../../../openapi/referenced-specs/v2.yml
104
- inline: true
105
- CreateBulkCollectionItemRequestBodyFieldDataItem:
106
- docs: A single CMS item to create
107
- properties:
108
- name:
109
- type: string
110
- docs: The name of the item.
111
- slug:
112
- type: string
113
- docs: >-
114
- URL slug for the item in your site.
115
-
116
- Note: Updating the item slug will break all links referencing the old
117
- slug.
118
- extra-properties: true
119
- source:
120
- openapi: ../../../openapi/referenced-specs/v2.yml
121
- inline: true
122
- CreateBulkCollectionItemRequestBodyFieldData:
123
- discriminated: false
124
- union:
125
- - type: Single CMS Item
126
- - docs: A list of CMS items to create
127
- type: list<CreateBulkCollectionItemRequestBodyFieldDataItem>
128
- source:
129
- openapi: ../../../openapi/referenced-specs/v2.yml
130
- inline: true
131
- Item IDs:
132
- docs: An array of Item IDs in a single locale
133
- properties:
134
- itemIds: optional<list<string>>
135
- source:
136
- openapi: ../../../openapi/referenced-specs/v2.yml
137
- inline: true
138
- ItemsPublishItemRequestItemsItemsItem:
139
- properties:
140
- id:
141
- type: string
142
- docs: The ID of the CMS item
143
- cmsLocaleIds:
144
- type: optional<list<string>>
145
- docs: Array of identifiers for the locales where the item will be published
146
- source:
147
- openapi: ../../../openapi/referenced-specs/v2.yml
148
- inline: true
149
- Item IDs with Locales:
150
- docs: An array of Item IDs with included `cmsLocaleIds`
151
- properties:
152
- items: optional<list<ItemsPublishItemRequestItemsItemsItem>>
153
- source:
154
- openapi: ../../../openapi/referenced-specs/v2.yml
155
- inline: true
156
- ItemsPublishItemRequest:
157
- discriminated: false
158
- union:
159
- - type: Item IDs
160
- docs: An array of Item IDs in a single locale
161
- - type: Item IDs with Locales
162
- docs: An array of Item IDs with included `cmsLocaleIds`
163
- source:
164
- openapi: ../../../openapi/referenced-specs/v2.yml
165
- ItemsPublishItemResponse:
166
- properties:
167
- publishedItemIds: optional<list<string>>
168
- errors: optional<list<string>>
169
- source:
170
- openapi: ../../../openapi/referenced-specs/v2.yml
171
- service:
172
- auth: false
173
- base-path: ''
174
- endpoints:
175
- list-items:
176
- path: /collections/{collection_id}/items
177
- method: GET
178
- auth:
179
- - OAuth2:
180
- - cms:read
181
- docs: |
182
- List of all Items within a Collection.
183
-
184
- Required scope | `CMS:read`
185
- source:
186
- openapi: ../../../openapi/referenced-specs/v2.yml
187
- path-parameters:
188
- collection_id:
189
- type: string
190
- docs: Unique identifier for a Collection
191
- display-name: List Collection Items
192
- request:
193
- name: ItemsListItemsRequest
194
- query-parameters:
195
- cmsLocaleId:
196
- type: optional<string>
197
- docs: >-
198
- Unique identifier for a CMS Locale. This UID is different from the
199
- Site locale identifier and is listed as `cmsLocaleId` in the Sites
200
- response. To query multiple locales, input a comma separated
201
- string.
202
- offset:
203
- type: optional<double>
204
- docs: >-
205
- Offset used for pagination if the results have more than limit
206
- records
207
- limit:
208
- type: optional<double>
209
- docs: 'Maximum number of records to be returned (max limit: 100)'
210
- name:
211
- type: optional<string>
212
- docs: Filter by the exact name of the item(s)
213
- slug:
214
- type: optional<string>
215
- docs: Filter by the exact slug of the item
216
- lastPublished:
217
- type: optional<root.ItemsListItemsRequestLastPublished>
218
- docs: Filter by the last published date of the item(s)
219
- sortBy:
220
- type: optional<ItemsListItemsRequestSortBy>
221
- docs: Sort results by the provided value
222
- sortOrder:
223
- type: optional<ItemsListItemsRequestSortOrder>
224
- docs: Sorts the results by asc or desc
225
- response:
226
- docs: Request was successful
227
- type: root.CollectionItemList
228
- status-code: 200
229
- errors:
230
- - root.BadRequestError
231
- - root.UnauthorizedError
232
- - root.NotFoundError
233
- - root.TooManyRequestsError
234
- - root.InternalServerError
235
- examples:
236
- - path-parameters:
237
- collection_id: 580e63fc8c9a982ac9b8b745
238
- query-parameters:
239
- cmsLocaleId: cmsLocaleId
240
- offset: 1.1
241
- limit: 1.1
242
- name: name
243
- slug: slug
244
- sortBy: lastPublished
245
- sortOrder: asc
246
- response:
247
- body:
248
- items:
249
- - id: 62b720ef280c7a7a3be8cabe
250
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
251
- lastPublished: '2022-06-30T13:35:20.878Z'
252
- lastUpdated: '2022-06-25T14:51:27.809Z'
253
- createdOn: '2022-06-25T14:51:27.809Z'
254
- isArchived: false
255
- isDraft: false
256
- fieldData:
257
- name: Senior Data Analyst
258
- slug: senior-data-analyst
259
- url: https://boards.greenhouse.io/webflow/jobs/26567701
260
- department: Data
261
- - id: 62c880ef281c7b7b4cf9dabc
262
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
263
- lastPublished: '2023-04-15T10:25:18.123Z'
264
- lastUpdated: '2023-04-10T11:45:30.567Z'
265
- createdOn: '2023-04-10T11:45:30.567Z'
266
- isArchived: false
267
- isDraft: false
268
- fieldData:
269
- name: Product Manager
270
- slug: product-manager
271
- url: https://boards.greenhouse.io/webflow/jobs/31234567
272
- department: Product
273
- pagination:
274
- limit: 25
275
- offset: 0
276
- total: 2
277
- create-item:
278
- path: /collections/{collection_id}/items
279
- method: POST
280
- auth:
281
- - OAuth2:
282
- - cms:write
283
- docs: >
284
- Create Item(s) in a Collection.
285
-
286
-
287
-
288
- To create items across multiple locales, please use [this
289
- endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
290
-
291
-
292
- Required scope | `CMS:write`
293
- source:
294
- openapi: ../../../openapi/referenced-specs/v2.yml
295
- path-parameters:
296
- collection_id:
297
- type: string
298
- docs: Unique identifier for a Collection
299
- display-name: Create Collection Item(s)
300
- request:
301
- body: ItemsCreateItemRequestBody
302
- query-parameters:
303
- skipInvalidFiles:
304
- type: optional<boolean>
305
- default: true
306
- docs: >-
307
- When true, invalid files are skipped and processing continues.
308
- When false, the entire request fails if any file is invalid.
309
- name: ItemsCreateItemRequest
310
- content-type: application/json
311
- response:
312
- docs: Request was successful
313
- type: root.CollectionItem
314
- status-code: 202
315
- errors:
316
- - root.BadRequestError
317
- - root.UnauthorizedError
318
- - root.NotFoundError
319
- - root.TooManyRequestsError
320
- - root.InternalServerError
321
- examples:
322
- - name: SingleItem
323
- path-parameters:
324
- collection_id: 580e63fc8c9a982ac9b8b745
325
- query-parameters:
326
- skipInvalidFiles: true
327
- request:
328
- isArchived: false
329
- isDraft: false
330
- fieldData:
331
- name: The Hitchhiker's Guide to the Galaxy
332
- slug: hitchhikers-guide-to-the-galaxy
333
- plain-text: Don't Panic.
334
- rich-text: >-
335
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
336
- most massively useful thing an interstellar hitchhiker can have.
337
- <strong>Don't forget yours!</strong></p>
338
- main-image:
339
- fileId: 62b720ef280c7a7a3be8cabe
340
- url: /files/62b720ef280c7a7a3be8cabe_image.png
341
- image-gallery:
342
- - fileId: 62b720ef280c7a7a3be8cabd
343
- url: /files/62b720ef280c7a7a3be8cabd_image.png
344
- - fileId: 62b720ef280c7a7a3be8cabe
345
- url: /files/62b720ef280c7a7a3be8cabe_image.png
346
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
347
- official-site: >-
348
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
349
- contact-email: zaphod.beeblebrox@heartofgold.gov
350
- support-phone: 424-242-4242
351
- answer-to-everything: 42
352
- release-date: '1979-10-12T00:00:00.000Z'
353
- is-featured: true
354
- brand-color: '#000000'
355
- category: 62b720ef280c7a7a3be8cabf
356
- author: 62b720ef280c7a7a3be8cab0
357
- tags:
358
- - 62b720ef280c7a7a3be8cab1
359
- - 62b720ef280c7a7a3be8cab2
360
- downloadable-asset:
361
- fileId: 62b720ef280c7a7a3be8cab3
362
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
363
- response:
364
- body:
365
- id: 42b720ef280c7a7a3be8cabe
366
- cmsLocaleId: 653ad57de882f528b32e810e
367
- lastPublished: '2022-11-29T16:22:43.159Z'
368
- lastUpdated: '2022-11-17T17:19:43.282Z'
369
- createdOn: '2022-11-17T17:11:57.148Z'
370
- isArchived: false
371
- isDraft: false
372
- fieldData:
373
- name: The Hitchhiker's Guide to the Galaxy
374
- slug: hitchhikers-guide-to-the-galaxy
375
- plain-text: Don't Panic.
376
- rich-text: >-
377
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
378
- most massively useful thing an interstellar hitchhiker can
379
- have. <strong>Don't forget yours!</strong></p>
380
- main-image:
381
- fileId: 62b720ef280c7a7a3be8cabe
382
- url: /files/62b720ef280c7a7a3be8cabe_image.png
383
- image-gallery:
384
- - fileId: 62b720ef280c7a7a3be8cabd
385
- url: /files/62b720ef280c7a7a3be8cabd_image.png
386
- - fileId: 62b720ef280c7a7a3be8cabe
387
- url: /files/62b720ef280c7a7a3be8cabe_image.png
388
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
389
- official-site: >-
390
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
391
- contact-email: zaphod.beeblebrox@heartofgold.gov
392
- support-phone: 424-242-4242
393
- answer-to-everything: 42
394
- release-date: '1979-10-12T00:00:00.000Z'
395
- is-featured: true
396
- brand-color: '#000000'
397
- category: 62b720ef280c7a7a3be8cabf
398
- author: 62b720ef280c7a7a3be8cab0
399
- tags:
400
- - 62b720ef280c7a7a3be8cab1
401
- - 62b720ef280c7a7a3be8cab2
402
- downloadable-asset:
403
- fileId: 62b720ef280c7a7a3be8cab3
404
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
405
- - name: MultipleItems
406
- path-parameters:
407
- collection_id: 580e63fc8c9a982ac9b8b745
408
- query-parameters:
409
- skipInvalidFiles: true
410
- request:
411
- items:
412
- - isArchived: false
413
- isDraft: false
414
- fieldData:
415
- name: Senior Data Analyst
416
- slug: senior-data-analyst
417
- url: https://boards.greenhouse.io/webflow/jobs/26567701
418
- department: Data
419
- - isArchived: false
420
- isDraft: false
421
- fieldData:
422
- name: Product Manager
423
- slug: product-manager
424
- url: https://boards.greenhouse.io/webflow/jobs/31234567
425
- department: Product
426
- response:
427
- body:
428
- id: id
429
- cmsLocaleId: 653ad57de882f528b32e810e
430
- lastPublished: '2023-03-17T18:47:35.560Z'
431
- lastUpdated: '2023-03-17T18:47:35.560Z'
432
- createdOn: '2023-03-17T18:47:35.560Z'
433
- isArchived: true
434
- isDraft: true
435
- fieldData:
436
- name: My new item
437
- slug: my-new-item
438
- date: '2022-11-18T00:00:00.000Z'
439
- featured: false
440
- color: '#db4b68'
441
- delete-items:
442
- path: /collections/{collection_id}/items
443
- method: DELETE
444
- auth:
445
- - OAuth2:
446
- - cms:write
447
- docs: >
448
- Delete Items from a Collection.
449
-
450
-
451
- <Tip title="Localization Tip">Items will only be deleted in the primary
452
- locale unless a `cmsLocaleId` is included in the request.</Tip>
453
-
454
-
455
- Required scope | `CMS:write`
456
- source:
457
- openapi: ../../../openapi/referenced-specs/v2.yml
458
- path-parameters:
459
- collection_id:
460
- type: string
461
- docs: Unique identifier for a Collection
462
- display-name: Delete Collection Items
463
- request:
464
- name: ItemsDeleteItemsRequest
465
- body:
466
- properties:
467
- items: list<ItemsDeleteItemsRequestItemsItem>
468
- content-type: application/json
469
- errors:
470
- - root.BadRequestError
471
- - root.UnauthorizedError
472
- - root.NotFoundError
473
- - root.ConflictError
474
- - root.TooManyRequestsError
475
- - root.InternalServerError
476
- examples:
477
- - path-parameters:
478
- collection_id: 580e63fc8c9a982ac9b8b745
479
- request:
480
- items:
481
- - id: 580e64008c9a982ac9b8b754
482
- update-items:
483
- path: /collections/{collection_id}/items
484
- method: PATCH
485
- auth:
486
- - OAuth2:
487
- - cms:write
488
- docs: >
489
- Update a single item or multiple items in a Collection.
490
-
491
-
492
- The limit for this endpoint is 100 items.
493
-
494
-
495
- <Tip title="Localization Tip">Items will only be updated in the primary
496
- locale, unless a `cmsLocaleId` is included in the request.</Tip>
497
-
498
-
499
- Required scope | `CMS:write`
500
- source:
501
- openapi: ../../../openapi/referenced-specs/v2.yml
502
- path-parameters:
503
- collection_id:
504
- type: string
505
- docs: Unique identifier for a Collection
506
- display-name: Update Collection Items
507
- request:
508
- name: ItemsUpdateItemsRequest
509
- query-parameters:
510
- skipInvalidFiles:
511
- type: optional<boolean>
512
- default: true
513
- docs: >-
514
- When true, invalid files are skipped and processing continues.
515
- When false, the entire request fails if any file is invalid.
516
- body:
517
- properties:
518
- items: optional<list<root.CollectionItemWithIdInput>>
519
- content-type: application/json
520
- response:
521
- docs: Request was successful
522
- type: ItemsUpdateItemsResponse
523
- status-code: 200
524
- errors:
525
- - root.BadRequestError
526
- - root.UnauthorizedError
527
- - root.NotFoundError
528
- - root.TooManyRequestsError
529
- - root.InternalServerError
530
- examples:
531
- - name: LocalizedItems
532
- path-parameters:
533
- collection_id: 580e63fc8c9a982ac9b8b745
534
- query-parameters:
535
- skipInvalidFiles: true
536
- request:
537
- items:
538
- - id: 66f6ed9576ddacf3149d5ea6
539
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
540
- fieldData:
541
- name: Ne Paniquez Pas
542
- slug: ne-paniquez-pas
543
- featured: false
544
- - id: 66f6ed9576ddacf3149d5ea6
545
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
546
- fieldData:
547
- name: No Entrar en Pánico
548
- slug: no-entrar-en-panico
549
- featured: false
550
- - id: 66f6ed9576ddacf3149d5eaa
551
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
552
- fieldData:
553
- name: Au Revoir et Merci pour Tous les Poissons
554
- slug: au-revoir-et-merci
555
- featured: false
556
- - id: 66f6ed9576ddacf3149d5eaa
557
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
558
- fieldData:
559
- name: Hasta Luego y Gracias por Todo el Pescado
560
- slug: hasta-luego-y-gracias
561
- featured: false
562
- response:
563
- body:
564
- items:
565
- - id: 66f6ed9576ddacf3149d5ea6
566
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
567
- lastPublished: '2024-09-27T17:38:29.066Z'
568
- lastUpdated: '2024-09-27T17:38:29.066Z'
569
- createdOn: '2024-09-27T17:38:29.066Z'
570
- isArchived: false
571
- isDraft: false
572
- fieldData:
573
- name: Ne Paniquez Pas
574
- slug: ne-paniquez-pas
575
- featured: false
576
- - id: 66f6ed9576ddacf3149d5ea6
577
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
578
- lastPublished: '2024-09-27T17:38:29.066Z'
579
- lastUpdated: '2024-09-27T17:38:29.066Z'
580
- createdOn: '2024-09-27T17:38:29.066Z'
581
- isArchived: false
582
- isDraft: false
583
- fieldData:
584
- name: No Entrar en Pánico
585
- slug: no-entrar-en-panico
586
- featured: false
587
- - id: 66f6ed9576ddacf3149d5eaa
588
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
589
- lastPublished: '2024-09-27T17:38:29.066Z'
590
- lastUpdated: '2024-09-27T17:38:29.066Z'
591
- createdOn: '2024-09-27T17:38:29.066Z'
592
- isArchived: false
593
- isDraft: false
594
- fieldData:
595
- name: Au Revoir et Merci pour Tous les Poissons
596
- slug: au-revoir-et-merci
597
- featured: false
598
- - id: 66f6ed9576ddacf3149d5eaa
599
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
600
- lastPublished: '2024-09-27T17:38:29.066Z'
601
- lastUpdated: '2024-09-27T17:38:29.066Z'
602
- createdOn: '2024-09-27T17:38:29.066Z'
603
- isArchived: false
604
- isDraft: false
605
- fieldData:
606
- name: Hasta Luego y Gracias por Todo el Pescado
607
- slug: hasta-luego-y-gracias
608
- featured: false
609
- pagination:
610
- limit: 25
611
- offset: 0
612
- total: 4
613
- - name: MultipleItems
614
- path-parameters:
615
- collection_id: 580e63fc8c9a982ac9b8b745
616
- query-parameters:
617
- skipInvalidFiles: true
618
- request:
619
- items:
620
- - id: 580e64008c9a982ac9b8b754
621
- isArchived: false
622
- isDraft: false
623
- fieldData:
624
- name: Senior Data Analyst
625
- slug: senior-data-analyst
626
- url: https://boards.greenhouse.io/webflow/jobs/26567701
627
- department: Data
628
- - id: 580e64008c9a982ac9b8b754
629
- isArchived: false
630
- isDraft: false
631
- fieldData:
632
- name: Product Manager
633
- slug: product-manager
634
- url: https://boards.greenhouse.io/webflow/jobs/31234567
635
- department: Product
636
- response:
637
- body:
638
- items:
639
- - id: 62b720ef280c7a7a3be8cabe
640
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
641
- lastPublished: '2022-06-30T13:35:20.878Z'
642
- lastUpdated: '2022-06-25T14:51:27.809Z'
643
- createdOn: '2022-06-25T14:51:27.809Z'
644
- isArchived: false
645
- isDraft: false
646
- fieldData:
647
- name: Senior Data Analyst
648
- slug: senior-data-analyst
649
- url: https://boards.greenhouse.io/webflow/jobs/26567701
650
- department: Data
651
- - id: 62c880ef281c7b7b4cf9dabc
652
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
653
- lastPublished: '2023-04-15T10:25:18.123Z'
654
- lastUpdated: '2023-04-10T11:45:30.567Z'
655
- createdOn: '2023-04-10T11:45:30.567Z'
656
- isArchived: false
657
- isDraft: false
658
- fieldData:
659
- name: Product Manager
660
- slug: product-manager
661
- url: https://boards.greenhouse.io/webflow/jobs/31234567
662
- department: Product
663
- pagination:
664
- limit: 25
665
- offset: 0
666
- total: 2
667
- list-items-live:
668
- path: /collections/{collection_id}/items/live
669
- method: GET
670
- auth:
671
- - OAuth2:
672
- - cms:read
673
- docs: |
674
- List all published items in a collection.
675
-
676
- <Tip title="Serve data with the Content Delivery API">
677
- Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
678
- </Tip>
679
-
680
- Required scope | `CMS:read`
681
- source:
682
- openapi: ../../../openapi/referenced-specs/v2.yml
683
- path-parameters:
684
- collection_id:
685
- type: string
686
- docs: Unique identifier for a Collection
687
- display-name: List Live Collection Items
688
- request:
689
- name: ItemsListItemsLiveRequest
690
- query-parameters:
691
- cmsLocaleId:
692
- type: optional<string>
693
- docs: >-
694
- Unique identifier for a CMS Locale. This UID is different from the
695
- Site locale identifier and is listed as `cmsLocaleId` in the Sites
696
- response. To query multiple locales, input a comma separated
697
- string.
698
- offset:
699
- type: optional<double>
700
- docs: >-
701
- Offset used for pagination if the results have more than limit
702
- records
703
- limit:
704
- type: optional<double>
705
- docs: 'Maximum number of records to be returned (max limit: 100)'
706
- name:
707
- type: optional<string>
708
- docs: Filter by the exact name of the item(s)
709
- slug:
710
- type: optional<string>
711
- docs: Filter by the exact slug of the item
712
- lastPublished:
713
- type: optional<root.ItemsListItemsLiveRequestLastPublished>
714
- docs: Filter by the last published date of the item(s)
715
- sortBy:
716
- type: optional<ItemsListItemsLiveRequestSortBy>
717
- docs: Sort results by the provided value
718
- sortOrder:
719
- type: optional<ItemsListItemsLiveRequestSortOrder>
720
- docs: Sorts the results by asc or desc
721
- response:
722
- docs: Request was successful
723
- type: root.CollectionItemList
724
- status-code: 200
725
- url: Data API
726
- errors:
727
- - root.BadRequestError
728
- - root.UnauthorizedError
729
- - root.NotFoundError
730
- - root.TooManyRequestsError
731
- - root.InternalServerError
732
- examples:
733
- - path-parameters:
734
- collection_id: 580e63fc8c9a982ac9b8b745
735
- query-parameters:
736
- cmsLocaleId: cmsLocaleId
737
- offset: 1.1
738
- limit: 1.1
739
- name: name
740
- slug: slug
741
- sortBy: lastPublished
742
- sortOrder: asc
743
- response:
744
- body:
745
- items:
746
- - id: 62b720ef280c7a7a3be8cabe
747
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
748
- lastPublished: '2022-06-30T13:35:20.878Z'
749
- lastUpdated: '2022-06-25T14:51:27.809Z'
750
- createdOn: '2022-06-25T14:51:27.809Z'
751
- isArchived: false
752
- isDraft: false
753
- fieldData:
754
- name: Senior Data Analyst
755
- slug: senior-data-analyst
756
- url: https://boards.greenhouse.io/webflow/jobs/26567701
757
- department: Data
758
- - id: 62c880ef281c7b7b4cf9dabc
759
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
760
- lastPublished: '2023-04-15T10:25:18.123Z'
761
- lastUpdated: '2023-04-10T11:45:30.567Z'
762
- createdOn: '2023-04-10T11:45:30.567Z'
763
- isArchived: false
764
- isDraft: false
765
- fieldData:
766
- name: Product Manager
767
- slug: product-manager
768
- url: https://boards.greenhouse.io/webflow/jobs/31234567
769
- department: Product
770
- pagination:
771
- limit: 25
772
- offset: 0
773
- total: 2
774
- create-item-live:
775
- path: /collections/{collection_id}/items/live
776
- method: POST
777
- auth:
778
- - OAuth2:
779
- - cms:write
780
- docs: >
781
- Create item(s) in a collection that will be immediately published to the
782
- live site.
783
-
784
-
785
-
786
- To create items across multiple locales, [please use this
787
- endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
788
-
789
-
790
-
791
- Required scope | `CMS:write`
792
- source:
793
- openapi: ../../../openapi/referenced-specs/v2.yml
794
- path-parameters:
795
- collection_id:
796
- type: string
797
- docs: Unique identifier for a Collection
798
- display-name: Create Live Collection Item(s)
799
- request:
800
- body: ItemsCreateItemLiveRequestBody
801
- query-parameters:
802
- skipInvalidFiles:
803
- type: optional<boolean>
804
- default: true
805
- docs: >-
806
- When true, invalid files are skipped and processing continues.
807
- When false, the entire request fails if any file is invalid.
808
- name: ItemsCreateItemLiveRequest
809
- content-type: application/json
810
- response:
811
- docs: Request was successful
812
- type: root.CollectionItem
813
- status-code: 202
814
- errors:
815
- - root.BadRequestError
816
- - root.UnauthorizedError
817
- - root.NotFoundError
818
- - root.TooManyRequestsError
819
- - root.InternalServerError
820
- examples:
821
- - name: SingleItem
822
- path-parameters:
823
- collection_id: 580e63fc8c9a982ac9b8b745
824
- query-parameters:
825
- skipInvalidFiles: true
826
- request:
827
- isArchived: false
828
- isDraft: false
829
- fieldData:
830
- name: The Hitchhiker's Guide to the Galaxy
831
- slug: hitchhikers-guide-to-the-galaxy
832
- plain-text: Don't Panic.
833
- rich-text: >-
834
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
835
- most massively useful thing an interstellar hitchhiker can have.
836
- <strong>Don't forget yours!</strong></p>
837
- main-image:
838
- fileId: 62b720ef280c7a7a3be8cabe
839
- url: /files/62b720ef280c7a7a3be8cabe_image.png
840
- image-gallery:
841
- - fileId: 62b720ef280c7a7a3be8cabd
842
- url: /files/62b720ef280c7a7a3be8cabd_image.png
843
- - fileId: 62b720ef280c7a7a3be8cabe
844
- url: /files/62b720ef280c7a7a3be8cabe_image.png
845
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
846
- official-site: >-
847
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
848
- contact-email: zaphod.beeblebrox@heartofgold.gov
849
- support-phone: 424-242-4242
850
- answer-to-everything: 42
851
- release-date: '1979-10-12T00:00:00.000Z'
852
- is-featured: true
853
- brand-color: '#000000'
854
- category: 62b720ef280c7a7a3be8cabf
855
- author: 62b720ef280c7a7a3be8cab0
856
- tags:
857
- - 62b720ef280c7a7a3be8cab1
858
- - 62b720ef280c7a7a3be8cab2
859
- downloadable-asset:
860
- fileId: 62b720ef280c7a7a3be8cab3
861
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
862
- response:
863
- body:
864
- id: 42b720ef280c7a7a3be8cabe
865
- cmsLocaleId: 653ad57de882f528b32e810e
866
- lastPublished: '2022-11-29T16:22:43.159Z'
867
- lastUpdated: '2022-11-17T17:19:43.282Z'
868
- createdOn: '2022-11-17T17:11:57.148Z'
869
- isArchived: false
870
- isDraft: false
871
- fieldData:
872
- name: The Hitchhiker's Guide to the Galaxy
873
- slug: hitchhikers-guide-to-the-galaxy
874
- plain-text: Don't Panic.
875
- rich-text: >-
876
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
877
- most massively useful thing an interstellar hitchhiker can
878
- have. <strong>Don't forget yours!</strong></p>
879
- main-image:
880
- fileId: 62b720ef280c7a7a3be8cabe
881
- url: /files/62b720ef280c7a7a3be8cabe_image.png
882
- image-gallery:
883
- - fileId: 62b720ef280c7a7a3be8cabd
884
- url: /files/62b720ef280c7a7a3be8cabd_image.png
885
- - fileId: 62b720ef280c7a7a3be8cabe
886
- url: /files/62b720ef280c7a7a3be8cabe_image.png
887
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
888
- official-site: >-
889
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
890
- contact-email: zaphod.beeblebrox@heartofgold.gov
891
- support-phone: 424-242-4242
892
- answer-to-everything: 42
893
- release-date: '1979-10-12T00:00:00.000Z'
894
- is-featured: true
895
- brand-color: '#000000'
896
- category: 62b720ef280c7a7a3be8cabf
897
- author: 62b720ef280c7a7a3be8cab0
898
- tags:
899
- - 62b720ef280c7a7a3be8cab1
900
- - 62b720ef280c7a7a3be8cab2
901
- downloadable-asset:
902
- fileId: 62b720ef280c7a7a3be8cab3
903
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
904
- - name: MultipleItems
905
- path-parameters:
906
- collection_id: 580e63fc8c9a982ac9b8b745
907
- query-parameters:
908
- skipInvalidFiles: true
909
- request:
910
- items:
911
- - isArchived: false
912
- isDraft: false
913
- fieldData:
914
- name: Senior Data Analyst
915
- slug: senior-data-analyst
916
- url: https://boards.greenhouse.io/webflow/jobs/26567701
917
- department: Data
918
- - isArchived: false
919
- isDraft: false
920
- fieldData:
921
- name: Product Manager
922
- slug: product-manager
923
- url: https://boards.greenhouse.io/webflow/jobs/31234567
924
- department: Product
925
- response:
926
- body:
927
- id: 42b720ef280c7a7a3be8cabe
928
- cmsLocaleId: 653ad57de882f528b32e810e
929
- lastPublished: '2022-11-29T16:22:43.159Z'
930
- lastUpdated: '2022-11-17T17:19:43.282Z'
931
- createdOn: '2022-11-17T17:11:57.148Z'
932
- isArchived: false
933
- isDraft: false
934
- fieldData:
935
- name: The Hitchhiker's Guide to the Galaxy
936
- slug: hitchhikers-guide-to-the-galaxy
937
- plain-text: Don't Panic.
938
- rich-text: >-
939
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
940
- most massively useful thing an interstellar hitchhiker can
941
- have. <strong>Don't forget yours!</strong></p>
942
- main-image:
943
- fileId: 62b720ef280c7a7a3be8cabe
944
- url: /files/62b720ef280c7a7a3be8cabe_image.png
945
- image-gallery:
946
- - fileId: 62b720ef280c7a7a3be8cabd
947
- url: /files/62b720ef280c7a7a3be8cabd_image.png
948
- - fileId: 62b720ef280c7a7a3be8cabe
949
- url: /files/62b720ef280c7a7a3be8cabe_image.png
950
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
951
- official-site: >-
952
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
953
- contact-email: zaphod.beeblebrox@heartofgold.gov
954
- support-phone: 424-242-4242
955
- answer-to-everything: 42
956
- release-date: '1979-10-12T00:00:00.000Z'
957
- is-featured: true
958
- brand-color: '#000000'
959
- category: 62b720ef280c7a7a3be8cabf
960
- author: 62b720ef280c7a7a3be8cab0
961
- tags:
962
- - 62b720ef280c7a7a3be8cab1
963
- - 62b720ef280c7a7a3be8cab2
964
- downloadable-asset:
965
- fileId: 62b720ef280c7a7a3be8cab3
966
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
967
- delete-items-live:
968
- path: /collections/{collection_id}/items/live
969
- method: DELETE
970
- auth:
971
- - OAuth2:
972
- - cms:write
973
- docs: >
974
- Unpublish up to 100 items from the live site and set the `isDraft`
975
- property to `true`.
976
-
977
-
978
- <Tip title="Localization Tip">Items will only be unpublished in the
979
- primary locale unless a `cmsLocaleId` is included in the request.</Tip>
980
-
981
-
982
- Required scope | `CMS:write`
983
- source:
984
- openapi: ../../../openapi/referenced-specs/v2.yml
985
- path-parameters:
986
- collection_id:
987
- type: string
988
- docs: Unique identifier for a Collection
989
- display-name: Unpublish Live Collection Items
990
- request:
991
- name: ItemsDeleteItemsLiveRequest
992
- body:
993
- properties:
994
- items: list<ItemsDeleteItemsLiveRequestItemsItem>
995
- content-type: application/json
996
- errors:
997
- - root.BadRequestError
998
- - root.UnauthorizedError
999
- - root.NotFoundError
1000
- - root.TooManyRequestsError
1001
- - root.InternalServerError
1002
- examples:
1003
- - path-parameters:
1004
- collection_id: 580e63fc8c9a982ac9b8b745
1005
- request:
1006
- items:
1007
- - id: 580e64008c9a982ac9b8b754
1008
- update-items-live:
1009
- path: /collections/{collection_id}/items/live
1010
- method: PATCH
1011
- auth:
1012
- - OAuth2:
1013
- - cms:write
1014
- docs: >
1015
- Update a single published item or multiple published items (up to 100)
1016
- in a Collection
1017
-
1018
-
1019
- <Tip title="Localization Tip">Items will only be updated in the primary
1020
- locale, unless a `cmsLocaleId` is included in the request.</Tip>
1021
-
1022
-
1023
- Required scope | `CMS:write`
1024
- source:
1025
- openapi: ../../../openapi/referenced-specs/v2.yml
1026
- path-parameters:
1027
- collection_id:
1028
- type: string
1029
- docs: Unique identifier for a Collection
1030
- display-name: Update Live Collection Items
1031
- request:
1032
- name: ItemsUpdateItemsLiveRequest
1033
- query-parameters:
1034
- skipInvalidFiles:
1035
- type: optional<boolean>
1036
- default: true
1037
- docs: >-
1038
- When true, invalid files are skipped and processing continues.
1039
- When false, the entire request fails if any file is invalid.
1040
- body:
1041
- properties:
1042
- items: optional<list<root.CollectionItemWithIdInput>>
1043
- content-type: application/json
1044
- response:
1045
- docs: Request was successful
1046
- type: root.CollectionItemListNoPagination
1047
- status-code: 200
1048
- errors:
1049
- - root.BadRequestError
1050
- - root.UnauthorizedError
1051
- - root.NotFoundError
1052
- - root.ConflictError
1053
- - root.TooManyRequestsError
1054
- - root.InternalServerError
1055
- examples:
1056
- - name: LocalizedItems
1057
- path-parameters:
1058
- collection_id: 580e63fc8c9a982ac9b8b745
1059
- query-parameters:
1060
- skipInvalidFiles: true
1061
- request:
1062
- items:
1063
- - id: 66f6ed9576ddacf3149d5ea6
1064
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1065
- fieldData:
1066
- name: Ne Paniquez Pas
1067
- slug: ne-paniquez-pas
1068
- featured: false
1069
- - id: 66f6ed9576ddacf3149d5ea6
1070
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1071
- fieldData:
1072
- name: No Entrar en Pánico
1073
- slug: no-entrar-en-panico
1074
- featured: false
1075
- - id: 66f6ed9576ddacf3149d5eaa
1076
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1077
- fieldData:
1078
- name: Au Revoir et Merci pour Tous les Poissons
1079
- slug: au-revoir-et-merci
1080
- featured: false
1081
- - id: 66f6ed9576ddacf3149d5eaa
1082
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1083
- fieldData:
1084
- name: Hasta Luego y Gracias por Todo el Pescado
1085
- slug: hasta-luego-y-gracias
1086
- featured: false
1087
- response:
1088
- body:
1089
- items:
1090
- - id: 66f6ed9576ddacf3149d5ea6
1091
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1092
- lastPublished: '2024-09-27T17:38:29.066Z'
1093
- lastUpdated: '2024-09-27T17:38:29.066Z'
1094
- createdOn: '2024-09-27T17:38:29.066Z'
1095
- isArchived: false
1096
- isDraft: false
1097
- fieldData:
1098
- name: Ne Paniquez Pas
1099
- slug: ne-paniquez-pas
1100
- featured: false
1101
- - id: 66f6ed9576ddacf3149d5ea6
1102
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1103
- lastPublished: '2024-09-27T17:38:29.066Z'
1104
- lastUpdated: '2024-09-27T17:38:29.066Z'
1105
- createdOn: '2024-09-27T17:38:29.066Z'
1106
- isArchived: false
1107
- isDraft: false
1108
- fieldData:
1109
- name: No Entrar en Pánico
1110
- slug: no-entrar-en-panico
1111
- featured: false
1112
- - id: 66f6ed9576ddacf3149d5eaa
1113
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1114
- lastPublished: '2024-09-27T17:38:29.066Z'
1115
- lastUpdated: '2024-09-27T17:38:29.066Z'
1116
- createdOn: '2024-09-27T17:38:29.066Z'
1117
- isArchived: false
1118
- isDraft: false
1119
- fieldData:
1120
- name: Au Revoir et Merci pour Tous les Poissons
1121
- slug: au-revoir-et-merci
1122
- featured: false
1123
- - id: 66f6ed9576ddacf3149d5eaa
1124
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1125
- lastPublished: '2024-09-27T17:38:29.066Z'
1126
- lastUpdated: '2024-09-27T17:38:29.066Z'
1127
- createdOn: '2024-09-27T17:38:29.066Z'
1128
- isArchived: false
1129
- isDraft: false
1130
- fieldData:
1131
- name: Hasta Luego y Gracias por Todo el Pescado
1132
- slug: hasta-luego-y-gracias
1133
- featured: false
1134
- - name: MultipleItems
1135
- path-parameters:
1136
- collection_id: 580e63fc8c9a982ac9b8b745
1137
- query-parameters:
1138
- skipInvalidFiles: true
1139
- request:
1140
- items:
1141
- - id: 580e64008c9a982ac9b8b754
1142
- isArchived: false
1143
- isDraft: false
1144
- fieldData:
1145
- name: Senior Data Analyst
1146
- slug: senior-data-analyst
1147
- url: https://boards.greenhouse.io/webflow/jobs/26567701
1148
- department: Data
1149
- - id: 580e64008c9a982ac9b8b754
1150
- isArchived: false
1151
- isDraft: false
1152
- fieldData:
1153
- name: Product Manager
1154
- slug: product-manager
1155
- url: https://boards.greenhouse.io/webflow/jobs/31234567
1156
- department: Product
1157
- response:
1158
- body:
1159
- items:
1160
- - id: 66f6ed9576ddacf3149d5ea6
1161
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1162
- lastPublished: '2024-09-27T17:38:29.066Z'
1163
- lastUpdated: '2024-09-27T17:38:29.066Z'
1164
- createdOn: '2024-09-27T17:38:29.066Z'
1165
- isArchived: false
1166
- isDraft: false
1167
- fieldData:
1168
- name: Ne Paniquez Pas
1169
- slug: ne-paniquez-pas
1170
- featured: false
1171
- - id: 66f6ed9576ddacf3149d5ea6
1172
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1173
- lastPublished: '2024-09-27T17:38:29.066Z'
1174
- lastUpdated: '2024-09-27T17:38:29.066Z'
1175
- createdOn: '2024-09-27T17:38:29.066Z'
1176
- isArchived: false
1177
- isDraft: false
1178
- fieldData:
1179
- name: No Entrar en Pánico
1180
- slug: no-entrar-en-panico
1181
- featured: false
1182
- - id: 66f6ed9576ddacf3149d5eaa
1183
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1184
- lastPublished: '2024-09-27T17:38:29.066Z'
1185
- lastUpdated: '2024-09-27T17:38:29.066Z'
1186
- createdOn: '2024-09-27T17:38:29.066Z'
1187
- isArchived: false
1188
- isDraft: false
1189
- fieldData:
1190
- name: Au Revoir et Merci pour Tous les Poissons
1191
- slug: au-revoir-et-merci
1192
- featured: false
1193
- - id: 66f6ed9576ddacf3149d5eaa
1194
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1195
- lastPublished: '2024-09-27T17:38:29.066Z'
1196
- lastUpdated: '2024-09-27T17:38:29.066Z'
1197
- createdOn: '2024-09-27T17:38:29.066Z'
1198
- isArchived: false
1199
- isDraft: false
1200
- fieldData:
1201
- name: Hasta Luego y Gracias por Todo el Pescado
1202
- slug: hasta-luego-y-gracias
1203
- featured: false
1204
- - name: Multiple items updated across multiple locales
1205
- path-parameters:
1206
- collection_id: 580e63fc8c9a982ac9b8b745
1207
- query-parameters:
1208
- skipInvalidFiles: true
1209
- request:
1210
- items:
1211
- - id: 66f6ed9576ddacf3149d5ea6
1212
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1213
- fieldData:
1214
- name: Ne Paniquez Pas
1215
- slug: ne-paniquez-pas
1216
- featured: false
1217
- - id: 66f6ed9576ddacf3149d5ea6
1218
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1219
- fieldData:
1220
- name: No Entrar en Pánico
1221
- slug: no-entrar-en-panico
1222
- featured: false
1223
- - id: 66f6ed9576ddacf3149d5eaa
1224
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1225
- fieldData:
1226
- name: Au Revoir et Merci pour Tous les Poissons
1227
- slug: au-revoir-et-merci
1228
- featured: false
1229
- - id: 66f6ed9576ddacf3149d5eaa
1230
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1231
- fieldData:
1232
- name: Hasta Luego y Gracias por Todo el Pescado
1233
- slug: hasta-luego-y-gracias
1234
- featured: false
1235
- response:
1236
- body:
1237
- items:
1238
- - id: 66f6ed9576ddacf3149d5ea6
1239
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1240
- lastPublished: '2024-09-27T17:38:29.066Z'
1241
- lastUpdated: '2024-09-27T17:38:29.066Z'
1242
- createdOn: '2024-09-27T17:38:29.066Z'
1243
- isArchived: false
1244
- isDraft: false
1245
- fieldData:
1246
- name: Ne Paniquez Pas
1247
- slug: ne-paniquez-pas
1248
- featured: false
1249
- - id: 66f6ed9576ddacf3149d5ea6
1250
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1251
- lastPublished: '2024-09-27T17:38:29.066Z'
1252
- lastUpdated: '2024-09-27T17:38:29.066Z'
1253
- createdOn: '2024-09-27T17:38:29.066Z'
1254
- isArchived: false
1255
- isDraft: false
1256
- fieldData:
1257
- name: No Entrar en Pánico
1258
- slug: no-entrar-en-panico
1259
- featured: false
1260
- - id: 66f6ed9576ddacf3149d5eaa
1261
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1262
- lastPublished: '2024-09-27T17:38:29.066Z'
1263
- lastUpdated: '2024-09-27T17:38:29.066Z'
1264
- createdOn: '2024-09-27T17:38:29.066Z'
1265
- isArchived: false
1266
- isDraft: false
1267
- fieldData:
1268
- name: Au Revoir et Merci pour Tous les Poissons
1269
- slug: au-revoir-et-merci
1270
- featured: false
1271
- - id: 66f6ed9576ddacf3149d5eaa
1272
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1273
- lastPublished: '2024-09-27T17:38:29.066Z'
1274
- lastUpdated: '2024-09-27T17:38:29.066Z'
1275
- createdOn: '2024-09-27T17:38:29.066Z'
1276
- isArchived: false
1277
- isDraft: false
1278
- fieldData:
1279
- name: Hasta Luego y Gracias por Todo el Pescado
1280
- slug: hasta-luego-y-gracias
1281
- featured: false
1282
- - name: Multiple items updated in a single locale
1283
- path-parameters:
1284
- collection_id: 580e63fc8c9a982ac9b8b745
1285
- query-parameters:
1286
- skipInvalidFiles: true
1287
- request:
1288
- items:
1289
- - id: 66f6ed9576ddacf3149d5ea6
1290
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1291
- fieldData:
1292
- name: Ne Paniquez Pas
1293
- slug: ne-paniquez-pas
1294
- featured: false
1295
- - id: 66f6ed9576ddacf3149d5ea6
1296
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1297
- fieldData:
1298
- name: No Entrar en Pánico
1299
- slug: no-entrar-en-panico
1300
- featured: false
1301
- - id: 66f6ed9576ddacf3149d5eaa
1302
- cmsLocaleId: 66f6e966c9e1dc700a857ca5
1303
- fieldData:
1304
- name: Au Revoir et Merci pour Tous les Poissons
1305
- slug: au-revoir-et-merci
1306
- featured: false
1307
- - id: 66f6ed9576ddacf3149d5eaa
1308
- cmsLocaleId: 66f6e966c9e1dc700a857ca4
1309
- fieldData:
1310
- name: Hasta Luego y Gracias por Todo el Pescado
1311
- slug: hasta-luego-y-gracias
1312
- featured: false
1313
- response:
1314
- body:
1315
- items:
1316
- - id: 62b720ef280c7a7a3be8cabe
1317
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
1318
- lastPublished: '2022-06-30T13:35:20.878Z'
1319
- lastUpdated: '2022-06-25T14:51:27.809Z'
1320
- createdOn: '2022-06-25T14:51:27.809Z'
1321
- isArchived: false
1322
- isDraft: false
1323
- fieldData:
1324
- name: Senior Data Analyst
1325
- slug: senior-data-analyst
1326
- url: https://boards.greenhouse.io/webflow/jobs/26567701
1327
- department: Data
1328
- - id: 62c880ef281c7b7b4cf9dabc
1329
- cmsLocaleId: 66f6e966c9e1dc700a857ca3
1330
- lastPublished: '2023-04-15T10:25:18.123Z'
1331
- lastUpdated: '2023-04-10T11:45:30.567Z'
1332
- createdOn: '2023-04-10T11:45:30.567Z'
1333
- isArchived: false
1334
- isDraft: false
1335
- fieldData:
1336
- name: Product Manager
1337
- slug: product-manager
1338
- url: https://boards.greenhouse.io/webflow/jobs/31234567
1339
- department: Product
1340
- create-items:
1341
- path: /collections/{collection_id}/items/bulk
1342
- method: POST
1343
- auth:
1344
- - OAuth2:
1345
- - cms:write
1346
- docs: >
1347
- Create an item or multiple items in a CMS Collection across multiple
1348
- corresponding locales.
1349
-
1350
-
1351
- <Note>
1352
- - This endpoint can create up to 100 items in a request.
1353
- - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.
1354
- </Note>
1355
-
1356
-
1357
- Required scope | `CMS:write`
1358
- source:
1359
- openapi: ../../../openapi/referenced-specs/v2.yml
1360
- path-parameters:
1361
- collection_id:
1362
- type: string
1363
- docs: Unique identifier for a Collection
1364
- display-name: Create Collection Items
1365
- request:
1366
- name: CreateBulkCollectionItemRequestBody
1367
- query-parameters:
1368
- skipInvalidFiles:
1369
- type: optional<boolean>
1370
- default: true
1371
- docs: >-
1372
- When true, invalid files are skipped and processing continues.
1373
- When false, the entire request fails if any file is invalid.
1374
- body:
1375
- properties:
1376
- cmsLocaleIds:
1377
- type: optional<list<string>>
1378
- docs: >-
1379
- Array of identifiers for the locales where the item will be
1380
- created
1381
- isArchived:
1382
- type: optional<boolean>
1383
- docs: Indicates whether the item is archived.
1384
- default: false
1385
- isDraft:
1386
- type: optional<boolean>
1387
- docs: Indicates whether the item is in draft state.
1388
- default: true
1389
- fieldData: CreateBulkCollectionItemRequestBodyFieldData
1390
- content-type: application/json
1391
- response:
1392
- docs: Request was successful
1393
- type: root.BulkCollectionItem
1394
- status-code: 202
1395
- errors:
1396
- - root.BadRequestError
1397
- - root.UnauthorizedError
1398
- - root.NotFoundError
1399
- - root.TooManyRequestsError
1400
- - root.InternalServerError
1401
- examples:
1402
- - name: Create a single item across multiple locales
1403
- path-parameters:
1404
- collection_id: 580e63fc8c9a982ac9b8b745
1405
- query-parameters:
1406
- skipInvalidFiles: true
1407
- request:
1408
- cmsLocaleIds:
1409
- - 66f6e966c9e1dc700a857ca3
1410
- - 66f6e966c9e1dc700a857ca4
1411
- - 66f6e966c9e1dc700a857ca5
1412
- isArchived: false
1413
- isDraft: false
1414
- fieldData:
1415
- name: Don’t Panic
1416
- slug: dont-panic
1417
- response:
1418
- body:
1419
- id: 580e64008c9a982ac9b8b754
1420
- cmsLocaleIds:
1421
- - 653ad57de882f528b32e810e
1422
- - 6514390aea353fc691d69827
1423
- - 65143930ea353fc691d69cd8
1424
- lastPublished: '2023-03-17T18:47:35.560Z'
1425
- lastUpdated: '2023-03-17T18:47:35.560Z'
1426
- createdOn: '2023-03-17T18:47:35.560Z'
1427
- isArchived: true
1428
- isDraft: true
1429
- fieldData:
1430
- name: My new item
1431
- slug: my-new-item
1432
- date: '2022-11-18T00:00:00.000Z'
1433
- featured: false
1434
- color: '#db4b68'
1435
- - name: Create multiple items across multiple locales
1436
- path-parameters:
1437
- collection_id: 580e63fc8c9a982ac9b8b745
1438
- query-parameters:
1439
- skipInvalidFiles: true
1440
- request:
1441
- cmsLocaleIds:
1442
- - 66f6e966c9e1dc700a857ca3
1443
- - 66f6e966c9e1dc700a857ca4
1444
- isArchived: false
1445
- isDraft: false
1446
- fieldData:
1447
- - name: Don’t Panic
1448
- slug: dont-panic
1449
- - name: So Long and Thanks for All the Fish
1450
- slug: so-long-and-thanks
1451
- response:
1452
- body:
1453
- id: 580e64008c9a982ac9b8b754
1454
- cmsLocaleIds:
1455
- - 653ad57de882f528b32e810e
1456
- - 6514390aea353fc691d69827
1457
- - 65143930ea353fc691d69cd8
1458
- lastPublished: '2023-03-17T18:47:35.560Z'
1459
- lastUpdated: '2023-03-17T18:47:35.560Z'
1460
- createdOn: '2023-03-17T18:47:35.560Z'
1461
- isArchived: true
1462
- isDraft: true
1463
- fieldData:
1464
- name: My new item
1465
- slug: my-new-item
1466
- date: '2022-11-18T00:00:00.000Z'
1467
- featured: false
1468
- color: '#db4b68'
1469
- - name: Single item created across multiple locales
1470
- path-parameters:
1471
- collection_id: 580e63fc8c9a982ac9b8b745
1472
- query-parameters:
1473
- skipInvalidFiles: true
1474
- request:
1475
- cmsLocaleIds:
1476
- - 66f6e966c9e1dc700a857ca3
1477
- - 66f6e966c9e1dc700a857ca4
1478
- - 66f6e966c9e1dc700a857ca5
1479
- isArchived: false
1480
- isDraft: false
1481
- fieldData:
1482
- name: Don’t Panic
1483
- slug: dont-panic
1484
- response:
1485
- body:
1486
- id: 580e64008c9a982ac9b8b754
1487
- cmsLocaleIds:
1488
- - 653ad57de882f528b32e810e
1489
- - 6514390aea353fc691d69827
1490
- - 65143930ea353fc691d69cd8
1491
- lastPublished: '2023-03-17T18:47:35.560Z'
1492
- lastUpdated: '2023-03-17T18:47:35.560Z'
1493
- createdOn: '2023-03-17T18:47:35.560Z'
1494
- isArchived: true
1495
- isDraft: true
1496
- fieldData:
1497
- name: My new item
1498
- slug: my-new-item
1499
- date: '2022-11-18T00:00:00.000Z'
1500
- featured: false
1501
- color: '#db4b68'
1502
- - name: Multiple items created across multiple locales
1503
- path-parameters:
1504
- collection_id: 580e63fc8c9a982ac9b8b745
1505
- query-parameters:
1506
- skipInvalidFiles: true
1507
- request:
1508
- cmsLocaleIds:
1509
- - 66f6e966c9e1dc700a857ca3
1510
- - 66f6e966c9e1dc700a857ca4
1511
- - 66f6e966c9e1dc700a857ca5
1512
- isArchived: false
1513
- isDraft: false
1514
- fieldData:
1515
- name: Don’t Panic
1516
- slug: dont-panic
1517
- response:
1518
- body:
1519
- id: 580e64008c9a982ac9b8b754
1520
- cmsLocaleIds:
1521
- - 653ad57de882f528b32e810e
1522
- - 6514390aea353fc691d69827
1523
- - 65143930ea353fc691d69cd8
1524
- lastPublished: '2023-03-17T18:47:35.560Z'
1525
- lastUpdated: '2023-03-17T18:47:35.560Z'
1526
- createdOn: '2023-03-17T18:47:35.560Z'
1527
- isArchived: true
1528
- isDraft: true
1529
- fieldData:
1530
- name: My new item
1531
- slug: my-new-item
1532
- date: '2022-11-18T00:00:00.000Z'
1533
- featured: false
1534
- color: '#db4b68'
1535
- get-item:
1536
- path: /collections/{collection_id}/items/{item_id}
1537
- method: GET
1538
- auth:
1539
- - OAuth2:
1540
- - cms:read
1541
- docs: |
1542
- Get details of a selected Collection Item.
1543
-
1544
- Required scope | `CMS:read`
1545
- source:
1546
- openapi: ../../../openapi/referenced-specs/v2.yml
1547
- path-parameters:
1548
- collection_id:
1549
- type: string
1550
- docs: Unique identifier for a Collection
1551
- item_id:
1552
- type: string
1553
- docs: Unique identifier for an Item
1554
- display-name: Get Collection Item
1555
- request:
1556
- name: ItemsGetItemRequest
1557
- query-parameters:
1558
- cmsLocaleId:
1559
- type: optional<string>
1560
- docs: >-
1561
- Unique identifier for a CMS Locale. This UID is different from the
1562
- Site locale identifier and is listed as `cmsLocaleId` in the Sites
1563
- response. To query multiple locales, input a comma separated
1564
- string.
1565
- response:
1566
- docs: Request was successful
1567
- type: root.CollectionItem
1568
- status-code: 200
1569
- errors:
1570
- - root.BadRequestError
1571
- - root.UnauthorizedError
1572
- - root.NotFoundError
1573
- - root.TooManyRequestsError
1574
- - root.InternalServerError
1575
- examples:
1576
- - path-parameters:
1577
- collection_id: 580e63fc8c9a982ac9b8b745
1578
- item_id: 580e64008c9a982ac9b8b754
1579
- query-parameters:
1580
- cmsLocaleId: cmsLocaleId
1581
- response:
1582
- body:
1583
- id: 42b720ef280c7a7a3be8cabe
1584
- cmsLocaleId: 653ad57de882f528b32e810e
1585
- lastPublished: '2022-11-29T16:22:43.159Z'
1586
- lastUpdated: '2022-11-17T17:19:43.282Z'
1587
- createdOn: '2022-11-17T17:11:57.148Z'
1588
- isArchived: false
1589
- isDraft: false
1590
- fieldData:
1591
- name: The Hitchhiker's Guide to the Galaxy
1592
- slug: hitchhikers-guide-to-the-galaxy
1593
- plain-text: Don't Panic.
1594
- rich-text: >-
1595
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
1596
- most massively useful thing an interstellar hitchhiker can
1597
- have. <strong>Don't forget yours!</strong></p>
1598
- main-image:
1599
- fileId: 62b720ef280c7a7a3be8cabe
1600
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1601
- image-gallery:
1602
- - fileId: 62b720ef280c7a7a3be8cabd
1603
- url: /files/62b720ef280c7a7a3be8cabd_image.png
1604
- - fileId: 62b720ef280c7a7a3be8cabe
1605
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1606
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
1607
- official-site: >-
1608
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
1609
- contact-email: zaphod.beeblebrox@heartofgold.gov
1610
- support-phone: 424-242-4242
1611
- answer-to-everything: 42
1612
- release-date: '1979-10-12T00:00:00.000Z'
1613
- is-featured: true
1614
- brand-color: '#000000'
1615
- category: 62b720ef280c7a7a3be8cabf
1616
- author: 62b720ef280c7a7a3be8cab0
1617
- tags:
1618
- - 62b720ef280c7a7a3be8cab1
1619
- - 62b720ef280c7a7a3be8cab2
1620
- downloadable-asset:
1621
- fileId: 62b720ef280c7a7a3be8cab3
1622
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
1623
- delete-item:
1624
- path: /collections/{collection_id}/items/{item_id}
1625
- method: DELETE
1626
- auth:
1627
- - OAuth2:
1628
- - cms:write
1629
- docs: |
1630
- Delete an item from a collection.
1631
-
1632
- Required scope | `CMS:write`
1633
- source:
1634
- openapi: ../../../openapi/referenced-specs/v2.yml
1635
- path-parameters:
1636
- collection_id:
1637
- type: string
1638
- docs: Unique identifier for a Collection
1639
- item_id:
1640
- type: string
1641
- docs: Unique identifier for an Item
1642
- display-name: Delete Collection Item
1643
- request:
1644
- name: ItemsDeleteItemRequest
1645
- query-parameters:
1646
- cmsLocaleId:
1647
- type: optional<string>
1648
- docs: >-
1649
- Unique identifier for a CMS Locale. This UID is different from the
1650
- Site locale identifier and is listed as `cmsLocaleId` in the Sites
1651
- response. To query multiple locales, input a comma separated
1652
- string.
1653
- errors:
1654
- - root.BadRequestError
1655
- - root.UnauthorizedError
1656
- - root.NotFoundError
1657
- - root.TooManyRequestsError
1658
- - root.InternalServerError
1659
- examples:
1660
- - path-parameters:
1661
- collection_id: 580e63fc8c9a982ac9b8b745
1662
- item_id: 580e64008c9a982ac9b8b754
1663
- query-parameters:
1664
- cmsLocaleId: cmsLocaleId
1665
- update-item:
1666
- path: /collections/{collection_id}/items/{item_id}
1667
- method: PATCH
1668
- auth:
1669
- - OAuth2:
1670
- - cms:write
1671
- docs: |
1672
- Update a selected Item in a Collection.
1673
-
1674
- Required scope | `CMS:write`
1675
- source:
1676
- openapi: ../../../openapi/referenced-specs/v2.yml
1677
- path-parameters:
1678
- collection_id:
1679
- type: string
1680
- docs: Unique identifier for a Collection
1681
- item_id:
1682
- type: string
1683
- docs: Unique identifier for an Item
1684
- display-name: Update Collection Item
1685
- request:
1686
- body: root.CollectionItemPatchSingle
1687
- query-parameters:
1688
- skipInvalidFiles:
1689
- type: optional<boolean>
1690
- default: true
1691
- docs: >-
1692
- When true, invalid files are skipped and processing continues.
1693
- When false, the entire request fails if any file is invalid.
1694
- name: ItemsUpdateItemRequest
1695
- content-type: application/json
1696
- response:
1697
- docs: Request was successful
1698
- type: root.CollectionItem
1699
- status-code: 200
1700
- errors:
1701
- - root.BadRequestError
1702
- - root.UnauthorizedError
1703
- - root.NotFoundError
1704
- - root.TooManyRequestsError
1705
- - root.InternalServerError
1706
- examples:
1707
- - path-parameters:
1708
- collection_id: 580e63fc8c9a982ac9b8b745
1709
- item_id: 580e64008c9a982ac9b8b754
1710
- query-parameters:
1711
- skipInvalidFiles: true
1712
- request:
1713
- isArchived: false
1714
- isDraft: false
1715
- fieldData:
1716
- name: The Hitchhiker's Guide to the Galaxy
1717
- slug: hitchhikers-guide-to-the-galaxy
1718
- plain-text: Don't Panic.
1719
- rich-text: >-
1720
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
1721
- most massively useful thing an interstellar hitchhiker can have.
1722
- <strong>Don't forget yours!</strong></p>
1723
- main-image:
1724
- fileId: 62b720ef280c7a7a3be8cabe
1725
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1726
- image-gallery:
1727
- - fileId: 62b720ef280c7a7a3be8cabd
1728
- url: /files/62b720ef280c7a7a3be8cabd_image.png
1729
- - fileId: 62b720ef280c7a7a3be8cabe
1730
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1731
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
1732
- official-site: >-
1733
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
1734
- contact-email: zaphod.beeblebrox@heartofgold.gov
1735
- support-phone: 424-242-4242
1736
- answer-to-everything: 42
1737
- release-date: '1979-10-12T00:00:00.000Z'
1738
- is-featured: true
1739
- brand-color: '#000000'
1740
- category: 62b720ef280c7a7a3be8cabf
1741
- author: 62b720ef280c7a7a3be8cab0
1742
- tags:
1743
- - 62b720ef280c7a7a3be8cab1
1744
- - 62b720ef280c7a7a3be8cab2
1745
- downloadable-asset:
1746
- fileId: 62b720ef280c7a7a3be8cab3
1747
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
1748
- response:
1749
- body:
1750
- id: 42b720ef280c7a7a3be8cabe
1751
- cmsLocaleId: 653ad57de882f528b32e810e
1752
- lastPublished: '2022-11-29T16:22:43.159Z'
1753
- lastUpdated: '2022-11-17T17:19:43.282Z'
1754
- createdOn: '2022-11-17T17:11:57.148Z'
1755
- isArchived: false
1756
- isDraft: false
1757
- fieldData:
1758
- name: The Hitchhiker's Guide to the Galaxy
1759
- slug: hitchhikers-guide-to-the-galaxy
1760
- plain-text: Don't Panic.
1761
- rich-text: >-
1762
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
1763
- most massively useful thing an interstellar hitchhiker can
1764
- have. <strong>Don't forget yours!</strong></p>
1765
- main-image:
1766
- fileId: 62b720ef280c7a7a3be8cabe
1767
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1768
- image-gallery:
1769
- - fileId: 62b720ef280c7a7a3be8cabd
1770
- url: /files/62b720ef280c7a7a3be8cabd_image.png
1771
- - fileId: 62b720ef280c7a7a3be8cabe
1772
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1773
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
1774
- official-site: >-
1775
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
1776
- contact-email: zaphod.beeblebrox@heartofgold.gov
1777
- support-phone: 424-242-4242
1778
- answer-to-everything: 42
1779
- release-date: '1979-10-12T00:00:00.000Z'
1780
- is-featured: true
1781
- brand-color: '#000000'
1782
- category: 62b720ef280c7a7a3be8cabf
1783
- author: 62b720ef280c7a7a3be8cab0
1784
- tags:
1785
- - 62b720ef280c7a7a3be8cab1
1786
- - 62b720ef280c7a7a3be8cab2
1787
- downloadable-asset:
1788
- fileId: 62b720ef280c7a7a3be8cab3
1789
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
1790
- get-item-live:
1791
- path: /collections/{collection_id}/items/{item_id}/live
1792
- method: GET
1793
- auth:
1794
- - OAuth2:
1795
- - cms:read
1796
- docs: |
1797
- Get details of a selected Collection live Item.
1798
-
1799
- <Tip title="Serve data with the Content Delivery API">
1800
- Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
1801
- </Tip>
1802
-
1803
- Required scope | `CMS:read`
1804
- source:
1805
- openapi: ../../../openapi/referenced-specs/v2.yml
1806
- path-parameters:
1807
- collection_id:
1808
- type: string
1809
- docs: Unique identifier for a Collection
1810
- item_id:
1811
- type: string
1812
- docs: Unique identifier for an Item
1813
- display-name: Get Live Collection Item
1814
- request:
1815
- name: ItemsGetItemLiveRequest
1816
- query-parameters:
1817
- cmsLocaleId:
1818
- type: optional<string>
1819
- docs: >-
1820
- Unique identifier for a CMS Locale. This UID is different from the
1821
- Site locale identifier and is listed as `cmsLocaleId` in the Sites
1822
- response. To query multiple locales, input a comma separated
1823
- string.
1824
- response:
1825
- docs: Request was successful
1826
- type: root.CollectionItem
1827
- status-code: 200
1828
- url: Data API
1829
- errors:
1830
- - root.BadRequestError
1831
- - root.UnauthorizedError
1832
- - root.NotFoundError
1833
- - root.TooManyRequestsError
1834
- - root.InternalServerError
1835
- examples:
1836
- - path-parameters:
1837
- collection_id: 580e63fc8c9a982ac9b8b745
1838
- item_id: 580e64008c9a982ac9b8b754
1839
- query-parameters:
1840
- cmsLocaleId: cmsLocaleId
1841
- response:
1842
- body:
1843
- id: 42b720ef280c7a7a3be8cabe
1844
- cmsLocaleId: 653ad57de882f528b32e810e
1845
- lastPublished: '2022-11-29T16:22:43.159Z'
1846
- lastUpdated: '2022-11-17T17:19:43.282Z'
1847
- createdOn: '2022-11-17T17:11:57.148Z'
1848
- isArchived: false
1849
- isDraft: false
1850
- fieldData:
1851
- name: The Hitchhiker's Guide to the Galaxy
1852
- slug: hitchhikers-guide-to-the-galaxy
1853
- plain-text: Don't Panic.
1854
- rich-text: >-
1855
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
1856
- most massively useful thing an interstellar hitchhiker can
1857
- have. <strong>Don't forget yours!</strong></p>
1858
- main-image:
1859
- fileId: 62b720ef280c7a7a3be8cabe
1860
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1861
- image-gallery:
1862
- - fileId: 62b720ef280c7a7a3be8cabd
1863
- url: /files/62b720ef280c7a7a3be8cabd_image.png
1864
- - fileId: 62b720ef280c7a7a3be8cabe
1865
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1866
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
1867
- official-site: >-
1868
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
1869
- contact-email: zaphod.beeblebrox@heartofgold.gov
1870
- support-phone: 424-242-4242
1871
- answer-to-everything: 42
1872
- release-date: '1979-10-12T00:00:00.000Z'
1873
- is-featured: true
1874
- brand-color: '#000000'
1875
- category: 62b720ef280c7a7a3be8cabf
1876
- author: 62b720ef280c7a7a3be8cab0
1877
- tags:
1878
- - 62b720ef280c7a7a3be8cab1
1879
- - 62b720ef280c7a7a3be8cab2
1880
- downloadable-asset:
1881
- fileId: 62b720ef280c7a7a3be8cab3
1882
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
1883
- delete-item-live:
1884
- path: /collections/{collection_id}/items/{item_id}/live
1885
- method: DELETE
1886
- auth:
1887
- - OAuth2:
1888
- - cms:write
1889
- docs: >
1890
- Unpublish a live item from the site and set the `isDraft` property to
1891
- `true`.
1892
-
1893
-
1894
- For bulk unpublishing, please use [this
1895
- endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live)
1896
-
1897
-
1898
- Required scope | `CMS:write`
1899
- source:
1900
- openapi: ../../../openapi/referenced-specs/v2.yml
1901
- path-parameters:
1902
- collection_id:
1903
- type: string
1904
- docs: Unique identifier for a Collection
1905
- item_id:
1906
- type: string
1907
- docs: Unique identifier for an Item
1908
- display-name: Unpublish Live Collection Item
1909
- request:
1910
- name: ItemsDeleteItemLiveRequest
1911
- query-parameters:
1912
- cmsLocaleId:
1913
- type: optional<string>
1914
- docs: >-
1915
- Unique identifier for a CMS Locale. This UID is different from the
1916
- Site locale identifier and is listed as `cmsLocaleId` in the Sites
1917
- response. To query multiple locales, input a comma separated
1918
- string.
1919
- errors:
1920
- - root.BadRequestError
1921
- - root.UnauthorizedError
1922
- - root.NotFoundError
1923
- - root.TooManyRequestsError
1924
- - root.InternalServerError
1925
- examples:
1926
- - path-parameters:
1927
- collection_id: 580e63fc8c9a982ac9b8b745
1928
- item_id: 580e64008c9a982ac9b8b754
1929
- query-parameters:
1930
- cmsLocaleId: cmsLocaleId
1931
- update-item-live:
1932
- path: /collections/{collection_id}/items/{item_id}/live
1933
- method: PATCH
1934
- auth:
1935
- - OAuth2:
1936
- - cms:write
1937
- docs: >
1938
- Update a selected live Item in a Collection. The updates for this Item
1939
- will be published to the live site.
1940
-
1941
-
1942
- Required scope | `CMS:write`
1943
- source:
1944
- openapi: ../../../openapi/referenced-specs/v2.yml
1945
- path-parameters:
1946
- collection_id:
1947
- type: string
1948
- docs: Unique identifier for a Collection
1949
- item_id:
1950
- type: string
1951
- docs: Unique identifier for an Item
1952
- display-name: Update Live Collection Item
1953
- request:
1954
- body: root.CollectionItemPatchSingle
1955
- query-parameters:
1956
- skipInvalidFiles:
1957
- type: optional<boolean>
1958
- default: true
1959
- docs: >-
1960
- When true, invalid files are skipped and processing continues.
1961
- When false, the entire request fails if any file is invalid.
1962
- name: ItemsUpdateItemLiveRequest
1963
- content-type: application/json
1964
- response:
1965
- docs: Request was successful
1966
- type: root.CollectionItem
1967
- status-code: 200
1968
- errors:
1969
- - root.BadRequestError
1970
- - root.UnauthorizedError
1971
- - root.NotFoundError
1972
- - root.ConflictError
1973
- - root.TooManyRequestsError
1974
- - root.InternalServerError
1975
- examples:
1976
- - path-parameters:
1977
- collection_id: 580e63fc8c9a982ac9b8b745
1978
- item_id: 580e64008c9a982ac9b8b754
1979
- query-parameters:
1980
- skipInvalidFiles: true
1981
- request:
1982
- isArchived: false
1983
- isDraft: false
1984
- fieldData:
1985
- name: The Hitchhiker's Guide to the Galaxy
1986
- slug: hitchhikers-guide-to-the-galaxy
1987
- plain-text: Don't Panic.
1988
- rich-text: >-
1989
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
1990
- most massively useful thing an interstellar hitchhiker can have.
1991
- <strong>Don't forget yours!</strong></p>
1992
- main-image:
1993
- fileId: 62b720ef280c7a7a3be8cabe
1994
- url: /files/62b720ef280c7a7a3be8cabe_image.png
1995
- image-gallery:
1996
- - fileId: 62b720ef280c7a7a3be8cabd
1997
- url: /files/62b720ef280c7a7a3be8cabd_image.png
1998
- - fileId: 62b720ef280c7a7a3be8cabe
1999
- url: /files/62b720ef280c7a7a3be8cabe_image.png
2000
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
2001
- official-site: >-
2002
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
2003
- contact-email: zaphod.beeblebrox@heartofgold.gov
2004
- support-phone: 424-242-4242
2005
- answer-to-everything: 42
2006
- release-date: '1979-10-12T00:00:00.000Z'
2007
- is-featured: true
2008
- brand-color: '#000000'
2009
- category: 62b720ef280c7a7a3be8cabf
2010
- author: 62b720ef280c7a7a3be8cab0
2011
- tags:
2012
- - 62b720ef280c7a7a3be8cab1
2013
- - 62b720ef280c7a7a3be8cab2
2014
- downloadable-asset:
2015
- fileId: 62b720ef280c7a7a3be8cab3
2016
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
2017
- response:
2018
- body:
2019
- id: 42b720ef280c7a7a3be8cabe
2020
- cmsLocaleId: 653ad57de882f528b32e810e
2021
- lastPublished: '2022-11-29T16:22:43.159Z'
2022
- lastUpdated: '2022-11-17T17:19:43.282Z'
2023
- createdOn: '2022-11-17T17:11:57.148Z'
2024
- isArchived: false
2025
- isDraft: false
2026
- fieldData:
2027
- name: The Hitchhiker's Guide to the Galaxy
2028
- slug: hitchhikers-guide-to-the-galaxy
2029
- plain-text: Don't Panic.
2030
- rich-text: >-
2031
- <h3>A Guide to Interstellar Travel</h3><p>A towel is about the
2032
- most massively useful thing an interstellar hitchhiker can
2033
- have. <strong>Don't forget yours!</strong></p>
2034
- main-image:
2035
- fileId: 62b720ef280c7a7a3be8cabe
2036
- url: /files/62b720ef280c7a7a3be8cabe_image.png
2037
- image-gallery:
2038
- - fileId: 62b720ef280c7a7a3be8cabd
2039
- url: /files/62b720ef280c7a7a3be8cabd_image.png
2040
- - fileId: 62b720ef280c7a7a3be8cabe
2041
- url: /files/62b720ef280c7a7a3be8cabe_image.png
2042
- intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4
2043
- official-site: >-
2044
- https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy
2045
- contact-email: zaphod.beeblebrox@heartofgold.gov
2046
- support-phone: 424-242-4242
2047
- answer-to-everything: 42
2048
- release-date: '1979-10-12T00:00:00.000Z'
2049
- is-featured: true
2050
- brand-color: '#000000'
2051
- category: 62b720ef280c7a7a3be8cabf
2052
- author: 62b720ef280c7a7a3be8cab0
2053
- tags:
2054
- - 62b720ef280c7a7a3be8cab1
2055
- - 62b720ef280c7a7a3be8cab2
2056
- downloadable-asset:
2057
- fileId: 62b720ef280c7a7a3be8cab3
2058
- url: /files/62b720ef280c7a7a3be8cab3_document.pdf
2059
- publish-item:
2060
- path: /collections/{collection_id}/items/publish
2061
- method: POST
2062
- auth:
2063
- - OAuth2:
2064
- - cms:write
2065
- docs: |
2066
- Publish an item or multiple items.
2067
-
2068
- Required scope | `cms:write`
2069
- source:
2070
- openapi: ../../../openapi/referenced-specs/v2.yml
2071
- path-parameters:
2072
- collection_id:
2073
- type: string
2074
- docs: Unique identifier for a Collection
2075
- display-name: Publish Collection Item
2076
- request:
2077
- body: ItemsPublishItemRequest
2078
- content-type: application/json
2079
- response:
2080
- docs: Request was successful
2081
- type: ItemsPublishItemResponse
2082
- status-code: 202
2083
- errors:
2084
- - root.BadRequestError
2085
- - root.UnauthorizedError
2086
- - root.NotFoundError
2087
- - root.ConflictError
2088
- - root.TooManyRequestsError
2089
- - root.InternalServerError
2090
- examples:
2091
- - name: PrimaryLocale
2092
- path-parameters:
2093
- collection_id: 580e63fc8c9a982ac9b8b745
2094
- request:
2095
- itemIds:
2096
- - 643fd856d66b6528195ee2ca
2097
- - 643fd856d66b6528195ee2cb
2098
- - 643fd856d66b6528195ee2cc
2099
- response:
2100
- body:
2101
- publishedItemIds:
2102
- - 643fd856d66b6528195ee2ca
2103
- - 643fd856d66b6528195ee2cb
2104
- errors:
2105
- - Staging item ID 643fd856d66b6528195ee2cf not found.
2106
- - name: SecondaryLocale
2107
- path-parameters:
2108
- collection_id: 580e63fc8c9a982ac9b8b745
2109
- request:
2110
- items:
2111
- - id: 643fd856d66b6528195ee2ca
2112
- cmsLocaleIds:
2113
- - 653ad57de882f528b32e810e
2114
- - id: 643fd856d66b6528195ee2cb
2115
- cmsLocaleIds:
2116
- - 653ad57de882f528b32e810e
2117
- - id: 643fd856d66b6528195ee2cc
2118
- cmsLocaleIds:
2119
- - 653ad57de882f528b32e810e
2120
- response:
2121
- body:
2122
- publishedItemIds:
2123
- - 643fd856d66b6528195ee2ca
2124
- - 643fd856d66b6528195ee2cb
2125
- errors:
2126
- - Staging item ID 643fd856d66b6528195ee2cf not found.
2127
- - name: MultipleLocales
2128
- path-parameters:
2129
- collection_id: 580e63fc8c9a982ac9b8b745
2130
- request:
2131
- items:
2132
- - id: 643fd856d66b6528195ee2ca
2133
- cmsLocaleIds:
2134
- - 653ad57de882f528b32e810e
2135
- - 6514390aea353fc691d69827
2136
- - 65143930ea353fc691d69cd8
2137
- response:
2138
- body:
2139
- publishedItemIds:
2140
- - 643fd856d66b6528195ee2ca
2141
- - 643fd856d66b6528195ee2cb
2142
- errors:
2143
- - Staging item ID 643fd856d66b6528195ee2cf not found.
2144
- source:
2145
- openapi: ../../../openapi/referenced-specs/v2.yml