Sample - Box Platform API
PUT/terms_of_services/{terms_of_service_id}

Update terms of service

Replaces a specific terms of service record. Supply status and text to set its active state and displayed content. text can be empty only when status is disabled.

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

1 parameter · 2 body fields
terms_of_service_idstringrequired
The string identifier of the terms of service to update.

Terms of service values to replace. Provide both status and text.

statusstringrequired
Whether this terms of service is active.
Allowed:enableddisabled
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 the updated terms of service 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.
defaultReturned when an unexpected client error occurs.
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

status and text must both be supplied. status must be enabled or disabled, and text can be empty only when status is disabled. terms_of_service_id must identify an existing terms of service record.