hipchat_create_user: Create a new Hipchat user.

Description Usage Arguments Value Note References Examples

View source: R/user.R

Description

Create a new Hipchat user.

Usage

1
2
hipchat_create_user(name, password, email, title, mention_name,
  is_group_admin = FALSE, timezone = "UTC")

Arguments

name

character. User's full name (1-50 characters). (Required)

password

character. User's password. (Required)

email

character. User's email. (Required)

title

character. User's title. (Optional)

mention_name

character. User's mention name. (Optional)

is_group_admin

logical. Whether or not this user is an admin. (Optional) The default is FALSE.

timezone

character. A supported timezone (see note). (Optional) The default is 'UTC'.

Value

the id for the newly created user, or NA if creation failed.

Note

for available time zones, see the third column in the table given at http://en.wikipedia.org/wiki/List_of_tz_database_time_zones

References

https://www.hipchat.com/docs/apiv2/method/create_user

Examples

1
2
3
4
5
## Not run: 
  hipchat_create_user('My name', 'mypassword', 'my.email@org.com',
    'my title', 'MyName')

## End(Not run)

robertzk/hipchat documentation built on May 27, 2019, 10:34 a.m.