Documents

Link a StoryBrand framework to a document

framework_id is the framework's INTEGER primary key, not its uuid. Ownership is checked on BOTH sides; a framework you do not own answers 400, not 404.

post/v1/documents/{uuid}/link-framework

Request

  • Base URL: https://contentmaschine.ai/api
  • URL: https://contentmaschine.ai/api/v1/documents/{uuid}/link-framework
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://contentmaschine.ai/api/oauth/authorize, token URL https://contentmaschine.ai/api/oauth/token)

Path parameters

uuidstring uuid required

The document uuid, as returned when it was created or listed.

Request body

framework_idinteger required

Integer primary key of a StoryBrand framework you own. NOT its uuid.

Response

Linked.

successboolean
dataobject
timestampstring date-time

Example response

{
  "success": true
}

Changes

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