API Docs
Subaccount Management
Delegate Subaccount

Delegate Subaccount

Mutation to share your subaccount

Example

mutation delegateSubaccount {
  delegateSubaccount(input: { emailTo: "[email protected]", subaccount: "subaccount_name", permission: "read" }) {
    string
  }
}

Response

{
  "data": {
    "delegateSubaccount": {
      "boolean": true
    }
  }
}

Arguments

  • input (DelegateSubaccountInput!)

The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.

type DelegateSubaccountInput {
  clientMutationId: String
  emailTo: String!
  subaccount: String!
  permission: String!
}
  • clientMutationId (String) An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.

  • emailTo (String!)

  • subaccount (String!)

  • permission (String!)

Type

DelegateSubaccountPayload

The output of our deleteSubaccount mutation.

type DelegateSubaccountPayload {
  clientMutationId: String
  string: String
  query: Query
}
Fields
  • clientMutationId (String)
    The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.

  • string (String)

  • query (Query)