Description

Delete one or multiple users from a given shop.

In case if you omit shop_id and provide your user id as the only id you can delete yourself from the system.

You can only delete users from a shop if you have permissions to do so, however if you delete only yourself from a shop, you can always do that.

Please, be careful with this API, deleting yourself from a shop is one thing, deleting yourself is another thing. Watch out for shop_id presence.

Permission bit: "users.delete"

Topic: Users

Arguments

ids: [String!]

List of user ids. See also: Unique Identifiers

Example: ["us_EQzGqWoY"]

shop_id: String

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

Result

Boolean

Preview (typescript)

Loading module