Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-054014269.7 KB
ChatV1User

post/v1/Services/{ServiceSid}/Users

Path parameters

ServiceSidstring required

The SID of the Service to create the resource under.

Response

Created

sidstring nullable

The unique string that we created to identify the User resource.

account_sidstring nullable

The SID of the Account that created the User resource.

service_sidstring nullable

The SID of the Service the resource is associated with.

attributesstring nullable

The JSON string that stores application-specific data. Note If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, {} is returned.

friendly_namestring nullable

The string that you assigned to describe the resource.

role_sidstring nullable

The SID of the Role assigned to the user.

identitystring nullable

The application-defined string that uniquely identifies the resource's User within the Service. This value is often a username or an email address. See access tokens for more info.

is_onlineboolean nullable

Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and null is always returned by a Read action. This value is null if the Service's reachability_enabled is false, if the User has never been online for the Service instance, even if the Service's reachability_enabled is true.

is_notifiableboolean nullable

Whether the User has a potentially valid Push Notification registration (APN or GCM) for the Service instance. If at least one registration exists, true; otherwise false. This value is only returned by Fetch actions that return a single resource and null is always returned by a Read action. This value is null if the Service's reachability_enabled is false, and if the User has never had a notification registration, even if the Service's reachability_enabled is true.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

joined_channels_countinteger

The number of Channels this User is a Member of.

linksobject nullable

The absolute URLs of the Channel and Binding resources related to the user.

urlstring uri nullable

The absolute URL of the User resource.