AddGuests
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, use the AddGuestsToSpace Stored Procedure. Only Kintone Administrators can use this API.
Stored Procedure Specific Information
Kintone allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Jack', '[email protected]', '#jack@123', 'America/Los_Angeles')
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Geeky', '[email protected]', '#geeky@321', 'America/Los_Angeles')
EXECUTE AddGuests GuestsAggregate = 'GuestsAggregate#TEMP'
The second way of using the Stored Procedure is by adding the aggregate itself:
EXECUTE AddGuests GuestsAggregate = '[{"code":"[email protected]","password":"#abcd@123","timezone":"America/Los_Angeles","locale":"en","name":"John Doe","company":"Company Name","division":"Sales","callto":"skypecallto"}]'
Input
| Name | Type | Required | Description |
| Name | String | False | The display name of the user. Must be between 1 - 128 characters. |
| Code | String | False | The email address (log in name) of the Guest user. |
| Password | String | False | The log in password of the Guest user. It must be alphanumeric. |
| Timezone | String | False | The timezone of the Guest user. |
| Locale | String | False | The language settings of the Guest user. Available values are auto, en, zh, ja. If not provided, auto will be set as default. |
| Image | String | False | The profile image of the Guest user. Specify a fileKey of an uploaded file. |
| SurNameReading | String | False | The Phonetic Surname settings of the Guest User. The maximum limit is 64 characters. |
| GivenNameReading | String | False | The Phonetic Given Name settings of the Guest User. The maximum limit is 64 characters. |
| Company | String | False | The Company name to display on the Guest User's profile. |
| Division | String | False | The Department name to display on the Guest User's profile. |
| Phone | String | False | The Phone number to display on the Guest User's profile. |
| CallTo | String | False | The Skype Name of the Guest user. |
| GuestsAggregate | String | False | The Guests Aggregate. |
Result Set Columns
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |