Description

Modify one or multiple API keys.

Permission bit: "keys.modify"

Topic: API Keys

Arguments

data: [KeyModify!]!

Main argument for mutations.

ids: [String!]!

List of key ids. See also: Unique Identifiers

Example: ["ke_EQzGqWoY"]

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

Data Argument Fields

name: String

The name of the key

Example: "unnamed"

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters

permissions: [String!]

A set of permission bits valid for this key

role_ids: [String!]

sales_channel_id: String

Sales channel this API key is associated with

Example: "sc_EQzGqWoY"

Valid when: sales_channel_id matches regexp pattern: ^sc_

Result

[Key!]

Preview (typescript)

Loading module