Interface: UsersProfileSetArguments
Extends
TokenOverridable
Properties
name?
optional name: string;
Description
Name of a single profile field to set. If both name and profile are set, name takes precedence.
See
users.profile.set Profile fields usage info.
Defined in
packages/web-api/src/types/request/users.ts:90
profile?
optional profile: Record<string, unknown>;
Description
Sets profile fields using a single argument. Collection of key:value pairs presented. At most 50 fields may be set. Each field name is limited to 255 characters.
See
users.profile.set Profile fields usage info.
Defined in
packages/web-api/src/types/request/users.ts:83
token?
optional token: string;
Description
Overridable authentication token bearing required scopes.
Inherited from
TokenOverridable.token
Defined in
packages/web-api/src/types/request/common.ts:43
user?
optional user: string;
Description
ID of user to change. This argument may only be specified by admins on paid teams.
Defined in
packages/web-api/src/types/request/users.ts:85
value?
optional value: string;
Description
Value to set for the profile field specified by name. Usable only if profile is not passed.
See
users.profile.set Profile fields usage info.