Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceMutations

Identity__add Tenant Notice

Platform admin only.

MUTATIONidentity__addTenantNotice(input: CreateTenantNoticeInput!, uid: String!): TenantNotice!

Platform admin only.

Arguments

input*
uid*String!

Returns

  1. identity__addTenantNotice
_id*ID!
body*String!
createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

createdBy?
sendAsEmail?Boolean
severity*NoticeSeverity!
Value inCRITICALINFOWARNING
title*String!
updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

visible?Boolean
Example Request
mutation Identity__addTenantNotice($input: CreateTenantNoticeInput!, $uid: String!) {  identity__addTenantNotice(input: $input, uid: $uid) {    _id    body    createdAt    createdBy {      email      name      phoneNumber      referenceId    }    sendAsEmail    severity    title    updatedAt    visible  }}
Variables
{  "input": {    "body": "string",    "title": "string"  },  "uid": "string"}
Example Response
{  "data": {    "identity__addTenantNotice": {      "_id": "1",      "body": "string",      "createdAt": "<DateTime>",      "createdBy": {        "email": "string",        "name": "string",        "phoneNumber": "string",        "referenceId": "1"      },      "sendAsEmail": true,      "severity": "CRITICAL",      "title": "string",      "updatedAt": "<DateTime>",      "visible": true    }  }}

Identity__add Kyc Comment MUTATION

Requires a signed-in staff user. Needs the `identity__Tenant` `update` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Identity__add User To Current Tenant MUTATION

Requires a signed-in staff user. Needs the `identity__User` `update` permission. Send the `x-tenant` header (the gateway sets it from your API key).