Skip to content

UsersProfileSetArguments.md

Latest commit

 

History

History
99 lines (57 loc) · 2.31 KB

UsersProfileSetArguments.md

File metadata and controls

99 lines (57 loc) · 2.31 KB

@slack/web-api / UsersProfileSetArguments

Interface: UsersProfileSetArguments

Defined in: src/types/request/users.ts:76

Extends

  • TokenOverridable

Properties

name?

optional name: string;

Defined in: src/types/request/users.ts:90

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.

profile?

optional profile: Record<string, unknown>;

Defined in: src/types/request/users.ts:83

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.

token?

optional token: string;

Defined in: src/types/request/common.ts:43

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token

user?

optional user: string;

Defined in: src/types/request/users.ts:85

Description

ID of user to change. This argument may only be specified by admins on paid teams.

value?

optional value: string;

Defined in: src/types/request/users.ts:95

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.