Sample - Box Platform API
POST/terms_of_services

Create terms of service

Creates a terms of service for a given enterprise and type of user.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 body fields
statusstringrequired
Whether this terms of service is active.
Allowed:enableddisabled
tos_typestringoptional
The type of user to set the terms of service for.
Allowed:externalmanaged
textstringrequired
The terms of service text to display to users. The text can be set to empty if the `status` is set to `disabled`.

2 status codes
200Returns a new task object.
idstringrequired
The unique identifier for this terms of service.
typestringrequired
The value will always be `terms_of_service`.
Allowed:terms_of_service
statusstringoptional
Whether these terms are enabled or not.
Allowed:enableddisabled
enterpriseobjectoptional
tos_typestringoptional
Whether to apply these terms to managed users or external users.
Allowed:managedexternal
textstringoptional
The text for your terms and conditions. This text could be empty if the `status` is set to `disabled`.
created_atstringoptional
When the legal item was created.
modified_atstringoptional
When the legal item was modified.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.