Skip to main content

Update Sharing Consent

PUT 

/api/success-plan/consent

Changes sharing consent. Every change is kept in the history and logged in the story. Setting no revokes approved drafts that are not yet published and flags published ones for SKU.io to take down.

Required scope: success_plan:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token with the success_plan:write scope. The user must hold the success_plan.manage permission.

Body:

  • status (string, required): open, ask_later or no.
  • permissions.name_company (boolean): the write-up may name the company.
  • permissions.use_figures (boolean): it may use your figures.
  • permissions.name_person (boolean): it may name the person quoted.
  • note (string, max 255).

Permissions are kept only with open; any not sent are false. Returns the consent and history, as Get Sharing Consent.

Request​

Responses​

OK

Response Headers
    Content-Type