Publish Purpose

Use this API to publish a Purpose. Before calling this API, ensure that the Purpose is in Draft status. The Purpose will be published with version 1 and Active status.

πŸ—’

Things to Know

  • The Update Purpose API can be used to edit an existing Purpose before publishing.
  • Once the Purpose is published, the previous version of the Purpose will be set to Retired status.
  • This API returns Purpose descriptions inside <p> and </p> HTML tags. These can be sanitized depending on your formatting needs.
Path Params
uuid
required

Unique identifier of the Purpose.

Query Params
integer
required
β‰₯ 1

The Purpose's version.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 1 required scope
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*