Study templates

Set which workspaces a template is available in

Replaces the template's shared-workspace list. Sharing is the only property this API changes — templates themselves are authored in the Outset app.

An empty list means the whole organization, not none.

Every identifier must name a live workspace your credential can reach; one that does not refuses the whole request and changes nothing. A template Outset provides to every organization cannot be shared through this API. Refused while the organization is suspended, and on a plan that does not include authoring studies.

With a user-delegated token two more rules apply, as in the app. An empty list is refused when the organization restricts organization-wide sharing to admins and the token's person is not one. And a template also shared with a workspace the token cannot reach is refused with 403, because replacing its list would remove those shares unseen.

Requires the templates:write scope, on a user-delegated token or a partner credential.

patch/v2/study-templates/{template_id}/

Request

  • Base URL: https://api.outset.ai
  • URL: https://api.outset.ai/v2/study-templates/{template_id}/
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://outset.ai/oauth/authorize, token URL https://api.outset.ai/users/oauth/token/, scopes: templates:write)
    • HTTP bearer

Path parameters

template_idstring uuid required

Request body

workspace_idsstring[]

The complete list of workspaces this template should be available in — a replacement, not an addition. Send an empty list to make it available to the whole organization. Every identifier must name a live workspace your credential can reach.

Response

Changes

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