Core GraphQL APIReferenceMutations

Files__register

Authenticated · x-tenant · Add an uploaded file to the reusable file library. Requires a signed-in staff user. Needs the `files__File` `create` permission. Send the `x-tenant` header (the gateway sets it from your API key).

MUTATIONfiles__register(body: RegisterFileInput!): CommonMutationResponse!

Authenticated · x-tenant · Add an uploaded file to the reusable file library. Requires a signed-in staff user. Needs the files__File create permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

body*

Returns

files__register

_id*ID!

Example Request

mutation Files__register($body: RegisterFileInput!) {
  files__register(body: $body) {
    _id
  }
}

mutation Files__register($body: RegisterFileInput!) {  files__register(body: $body) {    _id  }}

Variables

{
  "body": {
    "file": {
      "external": "string",
      "fileAssetId": "1"
    }
  }
}

Variables

{  "body": {    "file": {      "external": "string",      "fileAssetId": "1"    }  }}

Example Response

{
  "data": {
    "files__register": {
      "_id": "1"
    }
  }
}

Example Response

{  "data": {    "files__register": {      "_id": "1"    }  }}

Create Page MUTATION

Authenticated · x-tenant · Auth rules: @storeos/rbac-catalog Requires a signed-in staff user. Needs the `Pages` `create` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Files__remove MUTATION

Authenticated · x-tenant · Remove an unused file from the library and storage. Requires a signed-in staff user. Needs the `files__File` `delete` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Files__register

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns