Add Guests

Adds Guest users to kintone.
This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails.
To affiliate a Guest user with a Guest Space, follow up this API call with the Update Space Guests API.

Method POST
URL https://{subdomain}.kintone.com/k/v1/guests.json
Authentication Password Authentication
Content-Type application/json

Permissions

  • Only kintone Administrators can use this API.

Request Parameters

Parameter Value Required Description
guests Array Yes A list of Guest user data.
guests[].name String Yes The display name of the user.
Must be between 1 - 128 characters.
guests[].code String Yes The email address (log in name) of the Guest user.
guests[].password String Yes The log in password of the Guest user.
guests[].timezone String Yes The timezone of the Guest user.
guests[].locale String   The language settings of the Guest user.
  • auto: Use web browser settings.
  • en: English
  • zh: Chinese
  • ja: Japanese
If ignored, auto will be set.
guests[].image String   The profile image of the Guest user.
Specify a fileKey of an uploaded file. fileKeys can be found from the response of the Upload File API.
If ignored, a default image will be set.
guests[].surNameReading String   The Phonetic Surname settings of the Guest User. The maximum limit is 64 characters.
guests[].givenNameReading String   The Phonetic Given Name settings of the Guest User. The maximum limit is 64 characters.
guests[].company String   The Company name to display on the Guest User's profile.
The maximum limit is 100 characters.
guests[].division String   The Department name to display on the Guest User's profile.
The maximum limit is 100 characters.
guests[].phone String   The Phone number to display on the Guest User's profile.
The maximum limit is 100 characters.
guests[].callto String   The Skype Name of the Guest user.
The maximum limit is 256 characters.

Sample Request

JavaScript (using kintone REST API Request)

XMLHttpRequest

Response Parameters

An empty JSON object will be returned.

Sample Response

Limitations

  • Guest users will be added to the kintone domain, but no invitation emails will be sent to the Guest users.
  • The on/off settings of the Space or Guest Space features do not affect this API.
  • The E-mail Notifications settings of the Guest user will be turned on by default.
Was this article helpful?
0 out of 0 found this helpful
Comments
Please sign in to leave a comment.