Create users

The createUser() method creates a new user (User object) with a unique User ID.

Requires App Context

To store data about users, you must enable App Context for your app's keyset in the Admin Portal.

Method signature

This method takes the following parameters:

chat.createUser(
    id: String,
    name: String? = nil,
    externalId: String? = nil,
    profileUrl: String? = nil,
    email: String? = nil,
    custom: [String: JSONCodableScalar]? = nil,
    status: String? = nil,
    type: String? = nil
) async throws -> UserImpl

Input

* required

Parameter	Description
id * Type: String Default: n/a	Unique user identifier.
name Type: String Default: n/a	Display name for the user (must not be empty or consist only of whitespace characters).
externalId Type: String Default: n/a	User's identifier in an external system. You can use it to match id with a similar identifier from an external database.
profileUrl Type: String Default: n/a	URL of the user's profile picture.
email Type: String Default: n/a	User's email address.
custom Type: String: JSONCodableScalar Default: n/a	JSON providing custom data about the user. Values must be scalar only; arrays or objects are not supported. Filtering App Context data through the custom property is not recommended in SDKs.
status Type: String Default: n/a	Tag that lets you categorize your app users by their current state. The tag choice is entirely up to you and depends on your use case. For example, you can use status to mark users in your chat app as invited, active, or archived.
type Type: String Default: n/a	Tag that lets you categorize your app users by their functional roles. The tag choice is entirely up to you and depends on your use case. For example, you can use type to group users by their roles in your app, such as moderator, player, or support-agent.

API limits

To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.

Output

Parameter	Description
UserImpl	UserImpl containing the newly created user object.

Basic usage

Sample code

The code samples in Swift Chat SDK focus on asynchronous code execution.

You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.

Create a user with an ID of support_agent_15. Specify their name, avatar, and custom attributes, such as their title and the LinkedIn profile URL.

// Assuming you have a reference of type "ChatImpl" named "chat".
Task {
  let customAttributes: [String: JSONCodableScalar] = [
    "title": "Support Agent",
    "linkedin": "https://www.linkedin.com/in/support_agent_15"
  ]
  let user = try await chat.createUser(
    id: "support_agent_15",
    name: "John Doe",
    externalId: nil,
    profileUrl: nil,
    email: nil,
    custom: customAttributes,
    status: nil,
    type: nil

show all 17 lines