Box Developer Documentation
Log in
Latest version

Update terms of service status for existing user

put
https://api.box.com/2.0
/terms_of_service_user_statuses/:terms_of_service_user_status_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Updates the status for a terms of service for a user.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
324234

The ID of the terms of service status.

Request Body

booleanin bodyrequired
true

Whether the user has accepted the terms.

Response

application/jsonTerms of service user status

Returns the updated terms of service status object.

application/jsonClient error

An unexpected client error.

put
Update terms of service status for existing user
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/terms_of_service_user_statuses/324234" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "is_accepted": true
     }'
TypeScript Gen
await client.termsOfServiceUserStatuses.updateTermsOfServiceStatusForUserById(
  createdTosUserStatus.id,
  {
    isAccepted: true,
  } satisfies UpdateTermsOfServiceStatusForUserByIdRequestBody,
);
Python Gen
client.terms_of_service_user_statuses.update_terms_of_service_status_for_user_by_id(
    created_tos_user_status.id, True
)
.NET Gen
await client.TermsOfServiceUserStatuses.UpdateTermsOfServiceStatusForUserByIdAsync(termsOfServiceUserStatusId: createdTosUserStatus.Id, requestBody: new UpdateTermsOfServiceStatusForUserByIdRequestBody(isAccepted: true));
Swift Gen (Beta)
try await client.termsOfServiceUserStatuses.updateTermsOfServiceStatusForUserById(termsOfServiceUserStatusId: createdTosUserStatus.id, requestBody: UpdateTermsOfServiceStatusForUserByIdRequestBody(isAccepted: true))
Java
BoxTermsOfServiceUserStatus tosUserStatus = new BoxTermsOfServiceUserStatus(api, "tos-user-status-id");
BoxTermOfServiceUserStatus.Info tosUserStatusInfo = tosUserStatus.new Info();
tosUserStatusInfo.setStatus(newStatus);
tosUserStatus.updateInfo(tosUSerStatusInfo);
Python
user_status = client.terms_of_service_user_status(tos_user_status_id='12345').update_info(data={'is_accepted': True})
print(f'Terms of Service User Status ID is {user_status.id} and the accepted status is {user_status.is_accepted}')
.NET
BoxTermsOfServiceUserStatuses updatedStatus = await client.TermsOfServiceManager
    .UpdateTermsofServiceUserStatusesAsync("12345", false);
Node
client.termsOfService.updateUserStatus('5678', false)
	.then(tosStatus => {
		/* tosStatus -> {
			type: 'terms_of_service_user_status',
			id: '12345',
			tos: { type: 'terms_of_service', id: '11111' },
			user: { type: 'user', id: '22222' },
			is_accepted: false,
			created_at: '2018-04-11T15:33:49-07:00',
			modified_at: '2018-04-11T15:33:49-07:00' }
		*/
	});

Response Example

{
  "id": "11446498",
  "type": "terms_of_service_user_status",
  "created_at": "2012-12-12T10:53:43-08:00",
  "is_accepted": true,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "tos": {
    "id": "11446498",
    "type": "terms_of_service"
  },
  "user": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  }
}