Compositions & Component/Composition Patterns

Deletes or unpublishes a composition

Deletes or unpublishes a composition

delete/api/v1/canvas

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/canvas
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

compositionIdstring uuid required

The ID of the composition to delete. When editionId is also passed, the composition remains and an edition under it is deleted. When editionId is omitted, and the composition has editions, all editions will also be deleted along with the composition.

editionIdstring uuid

The edition ID to delete. When set, this deletes a child edition of the compositionId. The composition will remain when an edition is deleted. If the composition ID is specified as the edition ID, the composition will be deleted but any other editions will remain (this is used for unpublishing).

projectIdstring uuid required

The ID of the project the composition to delete belongs to

releaseIdstring uuid

The release the composition to delete belongs to. If not set, it belongs to the base. Note: Deleting a composition from a release will not delete the composition from the base

statenumber

The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all)

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.