On this page

unbookmarkConstruct

mutation · in the family Your own session

What it does

Remove one of your bookmarks. The record itself is untouched.

Remove one bookmark: teamId ABSENT = my personal row, PRESENT = the team's row (membership-gated like bookmarkConstruct). An absent row refuses NOT_FOUND/BOOKMARK. Requires authentication. Template class (universal staff work).

Who may call it

Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.

Owner
System Administrator
Manager
Associate Manager
Warehouse Associate
Sales Associate
Cashier
An API key whose scope allows api:unbookmarkConstruct

Arguments

Name	Type	Required	Notes
`targetType`	String `String!`	yes	No further notes.
`targetId`	ID `ID!`	yes	No further notes.
`teamId`	ID	no	No further notes.

Returns

Boolean Boolean! — True or false.

Example request

mutation ExampleUnbookmarkConstruct($targetType: String!, $targetId: ID!, $teamId: ID) {
  unbookmarkConstruct(targetType: $targetType, targetId: $targetId, teamId: $teamId)
}

Variables:

{
  "targetType": "<target type>",
  "targetId": "01900000-0000-7000-8000-446adfd50000",
  "teamId": "01900000-0000-7000-8000-3c35d4210000"
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "unbookmarkConstruct": true
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)
CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)