AddGuests
Adds guest users to the Kintone environment for controlled external access without sending invitations or automatically assigning them to Spaces.
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 | Display name assigned to the guest user, which must contain between 1 and 128 characters. |
| Code | String | False | Email address used as the guest user's login name, serving as the primary identifier for authentication. |
| Password | String | False | Alphanumeric password for the guest user's login credentials, required for account creation. |
| Timezone | String | False | Time zone setting applied to the guest user, used for timestamp display and scheduling behavior. |
| Locale | String | False | Specifies the language preference for the guest user. Accepted values are 'auto', 'en', 'zh', 'ja'. The default value is 'auto'. |
| Image | String | False | Profile image for the guest user, provided by specifying the fileKey of an uploaded file. |
| SurNameReading | String | False | Phonetic reading of the guest user's surname, with a maximum length of 64 characters. |
| GivenNameReading | String | False | Phonetic reading of the guest user's given name, with a maximum length of 64 characters. |
| Company | String | False | Company name displayed on the guest user's profile to provide organizational context. |
| Division | String | False | Department or division name displayed on the guest user's profile. |
| Phone | String | False | Contact phone number displayed on the guest user's profile. |
| CallTo | String | False | Skype name associated with the guest user for communication or collaboration purposes. |
| GuestsAggregate | String | False | Aggregate structure containing one or more guest user definitions for batch processing. |
Result Set Columns
| Name | Type | Description |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |