POST /api/users

create a user as a community admin

Success Response Code: 201

Params

Param name Description
activate_user
optional

activate the user or not (default=false)


Value: Must be one of: <code>true</code>, <code>false</code>.
skip_emails
optional

skip new user emails (default=false)


Value: Must be one of: <code>true</code>, <code>false</code>.
skip_joined_notifications
optional

Do not send the user a welcome email or post a welcome message to the stream on their behalf (only effective when activate_user is also true) (default=false)


Value: Must be one of: <code>true</code>, <code>false</code>.
account_type
optional

Whether this user will be a standard member or external contributor (default=member)


Value: Must be one of: <code>member</code>, <code>external</code>.
group_id
optional

If this user is an external contributor, the group that they will be allowed to interact with (required for external contributors)


Value: Must be a Integer
user
optional

Value: Must be a Hash
user[first_name]
required

first name of the user


Value: Must be a String
user[last_name]
required

last name of the user


Value: Must be a String
user[title]
optional

title of the user


Value: Must be a String
user[profile_photo_url]
optional

set the profile picture to the picture from this URL link


Value: Must be a String
user[profile_photo]
optional

Value: Must be a Hash
user[profile_photo][data]
optional

set the profile picture to a file upload from the local file path


Value: Must be a File
user[roles]
optional

Value: Must be a Hash
user[roles][tenant_admin_role]
optional

flag to set tenant admin role


Value: Must be one of: <code>true</code>, <code>false</code>.
user[contact_info]
optional

Value: Must be a Hash
user[contact_info][cell_phone]
optional

Value: Must be a String
user[contact_info][office_phone]
optional

Value: Must be a String
user[contact_info][aim]
optional

Value: Must be a String
user[contact_info][google_talk]
optional

Value: Must be a String
user[contact_info][yahoo]
optional

Value: Must be a String
user[contact_info][skype]
optional

Value: Must be a String
user[contact_info][jabber]
optional

Value: Must be a String
user[contact_info][msn]
optional

Value: Must be a String
user[contact_info][email]
required

Value: Must be a String
user[contact_info][location]
optional

Value: Must be a String
user[contact_info][twitter]
optional

Value: Must be a String
user[contact_info][lync]
optional

Value: Must be a String
user[contact_info][google_talk]
optional

Value: Must be a String

Response Fields

user see #show for details User

Example Curl Commands

curl -X POST -v --basic -u "admin@socialcast.com:password" 'https://demo.socialcast.com/api/users' -H"Content-Type: application/json" -d'{"user": { "first_name":"Emily2", "last_name":"James", "contact_info": { "email": "emily2@socialcast.com" }}}'

Examples

POST /api/users.json
{
  "user": {
    "contact_info": {
      "email": "monkey@socialcast.com"
    },
    "first_name": "fuzzy",
    "last_name": "monkey"
  }
}
201
{
  "user": {
    "contact_info": {
      "email": "monkey@socialcast.com"
    },
    "manager": null,
    "custom_fields": [],
    "followable": false,
    "contact_id": null,
    "following_count": 0,
    "followers_count": 0,
    "status_message": null,
    "id": 57,
    "first_name": "fuzzy",
    "last_name": "monkey",
    "name": "fuzzy monkey",
    "html_name": "fuzzy monkey",
    "url": "https://socialcast.socialcast.test/users/57-fuzzymonkey",
    "avatars": {
      "is_system_default": false,
      "id": 4,
      "square16": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square16.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20180711%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180711T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=a7b01b6a2d1a71e858d5d07bbb6f914a899ddc70b0719f0a6fd726634089160e",
      "square30": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square30.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20180711%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180711T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=bc4b3903bb1bb4bcb340321588c531db325199b30c7d8a0e64b79b4840d792e7",
      "square45": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square45.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20180711%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180711T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=bdf2dc56c42704d9e8c54c17cf63201ce243b2b58eade0f2b509de973b7f21a2",
      "square70": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square70.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20180711%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180711T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=f5e04a69cdb3a236a2890907b542b0812dc26cb02b011e74e9b238e695a2eb5c",
      "square140": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square140.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20180711%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180711T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=af022a255f000b4fe6684f3fe038a98c6d9dd47d124fd36158c917cf7670ed10",
      "original": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20180711%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180711T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=d4efe92278bf7fcc797a6f3c17bced268e9826a29a9663029a4da33a34683ec1"
    },
    "username": "fuzzymonkey",
    "active": false,
    "terminated": false,
    "inactive": true,
    "role": "member",
    "type": "User",
    "title": null,
    "out_of_office": false,
    "out_of_office_on": null,
    "back_in_office_on": null,
    "company_login": null
  }
}