Install a publication into the workspace

Changed on

Clones the publication's snapshot into the API key's team. What it creates depends on the publication's template_kind — an image template or an animation template. Recipes are installed with POST /recipes/{id}/install. A legacy V3 publication (uid prefixed v3_) is converted into a V5 image template on the way in. Returns the newly created resource. Trial accounts are capped at 3 templates per kind — installing beyond the cap returns 402.

post/publications/{uid}/install

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Path parameters

uidstring required

Response

Installed. The response shape matches the resource that was created, so it follows the publication's template_kind.

OR

Changes

    • info

      removed subschema #3 from the response body oneOf list for the response status

    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status