v4

latestSwagger 2.02026-08-0343714211.7 MB

clickwraps

Clickwraps

Show Clickwrap

get/clickwraps/{id}

Path parameters

idinteger required

Clickwrap ID.

Response

The Clickwraps object.

idinteger

Clickwrap ID

namestring

Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

bodystring

Body text of Clickwrap (supports Markdown formatting).

use_with_users'none' | 'require' | 'require_all_users_once' | 'require_all_users_always'

Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), require_all_users_once (show to all users at their next web login; once accepted, not shown again), require_all_users_always (show to all users on every web login).

use_with_bundles'none' | 'available' | 'require' | 'available_to_all_users'

Use this Clickwrap for Bundles?

use_with_inboxes'none' | 'available' | 'require' | 'available_to_all_users'

Use this Clickwrap for Inboxes?

Example response

{
  "id": 1,
  "name": "Example Site NDA for Files.com Use",
  "body": "[Legal body text]",
  "use_with_users": "example",
  "use_with_bundles": "example",
  "use_with_inboxes": "example"
}