ResponseStatus

ResponseStatus is returned by mutations to indicate whether the operation succeeded. It is a distinct type from the UserStatus enum — mutation responses use this object, not the enum.

Fields

code · StatusCode! · required

A code indicating the result of the operation. OK means the operation succeeded; any other value indicates failure.

message · String! · required

A human-readable message describing the result. On failure, this field contains the error details.

StatusCode enum

enum StatusCode {
  NONE
  OK
  ERROR
  NOT_FOUND
}

Example values

Success

{
  "status": {
    "code": "OK",
    "message": "Operation completed successfully"
  }
}

Failure

{
  "status": {
    "code": "ERROR",
    "message": "User with email [e-mail] already exists"
  }
}

Not found

{
  "status": {
    "code": "NOT_FOUND",
    "message": "User not found"
  }
}

GraphQL returns HTTP 200 even when status.code is not "OK". Always check the code field in the response body to determine success or failure. See Error handling.

When querying mutations, you must explicitly request { status { code message } } — requesting just { status } returns nothing.

Operations that return ResponseStatus

Create users

Returns ResponseStatus

Set user attributes

Returns ResponseStatus

Delete users from workspace

Returns ResponseStatus