v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Update terms of service

Updates a specific terms of service.

put/terms_of_services/{terms_of_service_id}

Path parameters

terms_of_service_idstring required

The ID of the terms of service.

Request body

status'enabled' | 'disabled' required

Whether this terms of service is active.

textstring required

The terms of service text to display to users.

The text can be set to empty if the status is set to disabled.

Example request

{
  "status": "enabled",
  "text": "By collaborating on this file you are accepting..."
}

Response

Returns an updated terms of service object.

idstring required

The unique identifier for this terms of service.

type'terms_of_service' required

The value will always be terms_of_service.

status'enabled' | 'disabled'

Whether these terms are enabled or not.

tos_type'managed' | 'external'

Whether to apply these terms to managed users or external users.

textstring

The text for your terms and conditions. This text could be empty if the status is set to disabled.

created_atstring date-time

When the legal item was created.

modified_atstring date-time

When the legal item was modified.

Example response

{
  "id": "11446498",
  "type": "terms_of_service",
  "status": "enabled",
  "enterprise": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "tos_type": "managed",
  "text": "By using this service, you agree to ...",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00"
}