Create terms of service status for new user

post
https://api.box.com/2.0
/terms_of_service_user_statuses

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

Request

bearer [ACCESS_TOKEN]
application/json

Request Body

booleanin bodyrequired
true

Whether the user has accepted the terms.

objectin body

The terms of service to set the status for.

stringin bodyrequired
"1232132"

The ID of terms of service

stringin bodyrequired
"terms_of_service"

The type of object.

Value is always terms_of_service

objectin body

The user to set the status for.

stringin bodyrequired
"3423423"

The ID of user

stringin bodyrequired
"user"

The type of object.

Value is always user

Response

Returns a terms of service status object.

application/jsonClient error

An unexpected client error.

post
Create terms of service status for new user
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X POST "https://api.box.com/2.0/terms_of_service_user_statuses" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "tos": {
         "type": "terms_of_service",
         "id": "1232132"
       },
       "user": {
         "type": "user",
         "id": "3423423"
       },
       "is_accepted": true
     }'
.NET
var createStatusRequest = new BoxTermsOfServiceUserStatusCreateRequest()
{
    TermsOfService = new BoxRequestEntity()
    {
        Id = "11111",
        Type = BoxType.terms_of_service
    },
    User = new BoxRequestEntity()
    {
        Id = "22222",
        Type = BoxType.user
    },
    IsAccepted = true
};
BoxTermsOfServiceUserStatuses termsOfServiceUserStatuses =
    await client.TermsOfServiceManager.CreateBoxTermsOfServiceUserStatusesAsync(createStatusRequest);
Java
BoxTermsOfService.Info newUserStatus = BoxTermsOfServiceUserStatus.create(api, "tos-id", true, "user-id");
Python
user = client.user(user_id='22222')
user_status = client.terms_of_service(tos_id='12345').set_user_status(is_accepted=True, user=user)
print(f'User status ID is {user_status.id} and the accepted status is {user_status.is_accepted}')
Node
client.termsOfService.createUserStatus('11111', true, {user_id: '22222'})
	.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: true,
			created_at: '2018-04-11T15:33:49-07:00',
			modified_at: '2018-04-11T15:33:49-07:00' }
		*/
	});
iOS
client.termsOfService.createUserStatus(
    tosId: "12345",
    isAccepted: true,
    userId: "54321"
) { (result: Result<TermsOfServiceUserStatus, BoxSDKError>) in
    guard case let .success(userStatus) = result else {
        print("Error accepting Terms of Service for new user")
        return
    }

    print("User status for accepting of Terms of Service is \(userStatus.isAccepted)")
}
TypeScript (Beta)
await client.termsOfServiceUserStatuses.createTermsOfServiceStatusForUser({
  tos: {
    type: 'terms_of_service' as CreateTermsOfServiceStatusForUserRequestBodyTosTypeField,
    id: tos.id,
  } satisfies CreateTermsOfServiceStatusForUserRequestBodyTosField,
  user: {
    type: 'user' as CreateTermsOfServiceStatusForUserRequestBodyUserTypeField,
    id: user.id,
  } satisfies CreateTermsOfServiceStatusForUserRequestBodyUserField,
  isAccepted: false,
} satisfies CreateTermsOfServiceStatusForUserRequestBody);
Python (Beta)
client.terms_of_service_user_statuses.create_terms_of_service_status_for_user(CreateTermsOfServiceStatusForUserTos(type=CreateTermsOfServiceStatusForUserTosTypeField.TERMS_OF_SERVICE.value, id=tos.id), CreateTermsOfServiceStatusForUserUser(type=CreateTermsOfServiceStatusForUserUserTypeField.USER.value, id=user.id), False)
.NET (Beta)
await client.TermsOfServiceUserStatuses.CreateTermsOfServiceStatusForUserAsync(requestBody: new CreateTermsOfServiceStatusForUserRequestBody(tos: new CreateTermsOfServiceStatusForUserRequestBodyTosField(type: CreateTermsOfServiceStatusForUserRequestBodyTosTypeField.TermsOfService, id: tos.Id), user: new CreateTermsOfServiceStatusForUserRequestBodyUserField(type: CreateTermsOfServiceStatusForUserRequestBodyUserTypeField.User, id: user.Id), isAccepted: false)).ConfigureAwait(false)

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"
  }
}