About Mutations
Every GraphQL schema has a root type for both queries and
mutations. The mutation
type
defines GraphQL operations that change data on the server. It is
analogous to performing HTTP verbs such as POST,
PATCH, and DELETE.
API Site
acceptGoodsQuote
Type:AcceptGoodsQuote
URL:https://api.st.kraken.tech/v1/graphql/
Accept a goods quote.
The possible errors that can be raised are:
- KT-CT-8223: Unauthorized.
- KT-CT-8201: Received an invalid quoteId.
- KT-CT-8224: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for accepting a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase created. |
Mutation
mutation AcceptGoodsQuote($input: AcceptGoodsQuoteInput!) {
acceptGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": AcceptGoodsQuoteInput
}Response
{
"data": {
"acceptGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}acceptOfferForQuoting
URL:https://api.st.kraken.tech/v1/graphql/
Accept a quoting offer in an offer group.
The possible errors that can be raised are:
- KT-CT-12402: Unable to accept offer.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for accepting a quoting offer. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Accepted quoting offer. |
Mutation
mutation AcceptOfferForQuoting($input: AcceptOfferForQuotingInput!) {
acceptOfferForQuoting(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
offer {
...OfferTypeFragment
}
}
}Variables
{
"input": AcceptOfferForQuotingInput
}Response
{
"data": {
"acceptOfferForQuoting": {
"possibleErrors": [PossibleErrorType],
"offer": OfferType
}
}
}actualizeContract
URL:https://api.st.kraken.tech/v1/graphql/
Actualize a contract for an account or business.
The possible errors that can be raised are:
- KT-CT-10003: Contract not found.
- KT-CT-10007: Unable to terminate contract.
- KT-CT-10008: The contract is currently undergoing an active journey.
- KT-CT-10022: Contract already terminated.
- KT-CT-10023: Contract is already revoked.
- KT-CT-10024: Contract already expired.
- KT-CT-10026: Contract actualization implies breach.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation ActualizeContract($input: ActualizeContractInput!) {
actualizeContract(input: $input) {
contract {
...ContractFragment
}
}
}Variables
{
"input": ActualizeContractInput
}Response
{
"data": {
"actualizeContract": {
"contract": Contract
}
}
}addBusinessToSegment
Type:AddBusinessToSegmentMutation
URL:https://api.st.kraken.tech/v1/graphql/
Add a business to a segment.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-11111: Segment does not exist.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a business to a segment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The business segment period that was created. |
Mutation
mutation AddBusinessToSegment($input: AddBusinessToSegmentInput!) {
addBusinessToSegment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
businessSegmentPeriod {
...BusinessSegmentPeriodTypeFragment
}
}
}Variables
{
"input": AddBusinessToSegmentInput
}Response
{
"data": {
"addBusinessToSegment": {
"possibleErrors": [PossibleErrorType],
"businessSegmentPeriod": BusinessSegmentPeriodType
}
}
}addCampaignToAccount
Type:AddCampaignToAccount
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-7427: No campaign found with given slug.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for adding a campaign to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the campaign was successfully added. |
Mutation
mutation AddCampaignToAccount($input: AddCampaignToAccountInput!) {
addCampaignToAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
campaignAdded
}
}Variables
{
"input": AddCampaignToAccountInput
}Response
{
"data": {
"addCampaignToAccount": {
"possibleErrors": [PossibleErrorType],
"campaignAdded": true
}
}
}addChildToProperty
Type:AddChildToProperty
URL:https://api.st.kraken.tech/v1/graphql/
Add a child property to a parent property in a hierarchy.
If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-6622: Unauthorized.
- KT-CT-6634: Unable to add child to property.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a child to a parent property. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The child property that was added to the parent. |
Mutation
mutation AddChildToProperty($input: AddChildToPropertyInput!) {
addChildToProperty(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
child {
...PropertyTypeFragment
}
}
}Variables
{
"input": AddChildToPropertyInput
}Response
{
"data": {
"addChildToProperty": {
"possibleErrors": [PossibleErrorType],
"child": PropertyType
}
}
}addItemsToRiskList
Type:AddItemsToRiskList
URL:https://api.st.kraken.tech/v1/graphql/
Add items to the risk list.
The possible errors that can be raised are:
- KT-CT-12105: Risk list item addition failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| A list of risk list items to add. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| List of successfully added risk identifiers. |
Mutation
mutation AddItemsToRiskList($input: [RiskListItemInputType]!) {
addItemsToRiskList(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
riskIdentifiers {
...RiskListItemTypeFragment
}
}
}Variables
{
"input": RiskListItemInputType
}Response
{
"data": {
"addItemsToRiskList": {
"possibleErrors": [PossibleErrorType],
"riskIdentifiers": [RiskListItemType]
}
}
}addJourneyCompletionReward
Type:AddJourneyCompletionReward
URL:https://api.st.kraken.tech/v1/graphql/
Add a journey completion reward.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6710: Unable to create referral.
- KT-CT-6712: Invalid reference.
- KT-CT-6728: This referral scheme's usage is at capacity.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input data for adding the journey completion reward. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created account referral instance. |
Mutation
mutation AddJourneyCompletionReward($input: AddJourneyCompletionRewardInput!) {
addJourneyCompletionReward(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReferral {
...ReferralTypeFragment
}
}
}Variables
{
"input": AddJourneyCompletionRewardInput
}Response
{
"data": {
"addJourneyCompletionReward": {
"possibleErrors": [PossibleErrorType],
"accountReferral": ReferralType
}
}
}addNoteToInkConversation
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The ink conversation note. |
Mutation
mutation AddNoteToInkConversation($input: AddNoteToInkConversationInput) {
addNoteToInkConversation(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
note {
...InkNoteFragment
}
}
}Variables
{
"input": AddNoteToInkConversationInput
}Response
{
"data": {
"addNoteToInkConversation": {
"possibleErrors": [PossibleErrorType],
"note": InkNote
}
}
}addParentToProperty
Type:AddParentToProperty
URL:https://api.st.kraken.tech/v1/graphql/
Add a parent property to a child property in a hierarchy.
If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-6622: Unauthorized.
- KT-CT-6635: Unable to add parent to property.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a parent to a child property. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The parent property that was added to the child. |
Mutation
mutation AddParentToProperty($input: AddParentToPropertyInput!) {
addParentToProperty(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
parent {
...PropertyTypeFragment
}
}
}Variables
{
"input": AddParentToPropertyInput
}Response
{
"data": {
"addParentToProperty": {
"possibleErrors": [PossibleErrorType],
"parent": PropertyType
}
}
}addPortfolioReference
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to add a reference to an existing portfolio.
The possible errors that can be raised are:
- KT-CT-9403: Received an invalid portfolioId.
- KT-CT-9410: Conflicting portfolio reference.
- KT-CT-9408: Invalid portfolio number format.
- KT-CT-9409: Invalid portfolio reference.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a reference to a portfolio. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation AddPortfolioReference($input: AddPortfolioReferenceInput) {
addPortfolioReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": AddPortfolioReferenceInput
}Response
{
"data": {
"addPortfolioReference": {
"possibleErrors": [PossibleErrorType]
}
}
}addProperty
Type:AddProperty
URL:https://api.st.kraken.tech/v1/graphql/
Add a property to an account.
The possible errors that can be raised are:
- KT-CT-6623: Unauthorized.
- KT-CT-6629: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a property to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The property that was added to the account. |
Mutation
mutation AddProperty($input: AddPropertyInput!) {
addProperty(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
property {
...PropertyTypeFragment
}
}
}Variables
{
"input": AddPropertyInput
}Response
{
"data": {
"addProperty": {
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}
}
}addPropertyToHierarchy
URL:https://api.st.kraken.tech/v1/graphql/
Add a property to a hierarchy as a root node.
If the property is already a root node in the hierarchy, this operation is idempotent. If the property is already in the hierarchy as a child, an error will be raised.
The possible errors that can be raised are:
- KT-CT-6622: Unauthorized.
- KT-CT-6633: Property is already in the hierarchy as a child.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a property to a hierarchy. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The property that was added to the hierarchy. |
Mutation
mutation AddPropertyToHierarchy($input: AddPropertyToHierarchyInput!) {
addPropertyToHierarchy(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
property {
...PropertyTypeFragment
}
}
}Variables
{
"input": AddPropertyToHierarchyInput
}Response
{
"data": {
"addPropertyToHierarchy": {
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}
}
}addSignupReferralOnAccount
Type:AddSignupReferralOnAccount
URL:https://api.st.kraken.tech/v1/graphql/
Add a one-way signup reward to a referral.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6729: This scheme cannot be applied to given account.
- KT-CT-6710: Unable to create referral.
- KT-CT-6728: This referral scheme's usage is at capacity.
- KT-CT-6712: Invalid reference.
- KT-CT-6713: Referring and referred account brands do not match.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a signup reward for an organization. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created account referral instance. |
Mutation
mutation AddSignupReferralOnAccount($input: AddSignupReferralOnAccountInput!) {
addSignupReferralOnAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReferral {
...ReferralTypeFragment
}
}
}Variables
{
"input": AddSignupReferralOnAccountInput
}Response
{
"data": {
"addSignupReferralOnAccount": {
"possibleErrors": [PossibleErrorType],
"accountReferral": ReferralType
}
}
}addStorylineToInkConversation
Type:AddStorylineToInkConversation
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-7651: Only one storyline entry can be marked as the root cause.
- KT-CT-7657: The provided analyzer result data is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The storyline that was added to the conversation. |
Mutation
mutation AddStorylineToInkConversation($input: AddStorylineToInkConversationInput) {
addStorylineToInkConversation(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
storyline {
...InkStorylineFragment
}
}
}Variables
{
"input": AddStorylineToInkConversationInput
}Response
{
"data": {
"addStorylineToInkConversation": {
"possibleErrors": [PossibleErrorType],
"storyline": InkStoryline
}
}
}addUserToAccount
Type:AddUserToAccount
URL:https://api.st.kraken.tech/v1/graphql/
Add an account user to the account.
Only one name field can be updated per day, other fields can be updated freely. This prevents users from switching accounts to someone else (usually when moving homes). All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-4121: Invalid phone number.
- KT-CT-4122: Invalid email.
- KT-CT-6723: Unauthorized.
- KT-CT-4111: Unable to use given email address.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding user to account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The user that was added to the account. |
Mutation
mutation AddUserToAccount($input: AddUserToAccountInput!) {
addUserToAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
user {
...AccountUserTypeFragment
}
}
}Variables
{
"input": AddUserToAccountInput
}Response
{
"data": {
"addUserToAccount": {
"possibleErrors": [PossibleErrorType],
"user": AccountUserType
}
}
}addUserToPortfolio
Type:AddUserToPortfolio
URL:https://api.st.kraken.tech/v1/graphql/
Add an user to a portfolio with a specified role.
The possible errors that can be raised are:
- KT-CT-5461: Invalid role code.
- KT-CT-5462: Invalid user number format.
- KT-CT-5463: Unauthorized.
- KT-CT-9407: Unauthorized.
- KT-CT-9408: Invalid portfolio number format.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a user to a portfolio. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation AddUserToPortfolio($input: AddUserToPortfolioInput!) {
addUserToPortfolio(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": AddUserToPortfolioInput
}Response
{
"data": {
"addUserToPortfolio": {
"possibleErrors": [PossibleErrorType]
}
}
}allowRepaymentSubmission
URL:https://api.st.kraken.tech/v1/graphql/
Allow a repayment to be submitted.
The possible errors that can be raised are:
- KT-CT-3944: Account repayment does not exist.
- KT-CT-3945: Unable to allow a repayment to be submitted.
- KT-CT-3950: The provided reason text is too long.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variable needed for allowing repayment submission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The repayment ID. |
| Resulting Repayment Intervention details. |
Mutation
mutation AllowRepaymentSubmission($input: RepaymentInput!) {
allowRepaymentSubmission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentId
repaymentIntervention {
...RepaymentInterventionTypeFragment
}
}
}Variables
{
"input": RepaymentInput
}Response
{
"data": {
"allowRepaymentSubmission": {
"possibleErrors": [PossibleErrorType],
"repaymentId": "abc123",
"repaymentIntervention": RepaymentInterventionType
}
}
}amendPayment
Type:AmendPayment
URL:https://api.st.kraken.tech/v1/graphql/
Amend an existing payment.
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-3970: The account cannot amend payments.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for amending an existing payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation AmendPayment($input: AmendPaymentInput!) {
amendPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": AmendPaymentInput
}Response
{
"data": {
"amendPayment": {
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
}
}approveRepayment
Type:ApproveRepayment
URL:https://api.st.kraken.tech/v1/graphql/
Approve a repayment.
The possible errors that can be raised are:
- KT-CT-3934: Repayment request already approved.
- KT-CT-3935: Repayment request cannot be paid.
- KT-CT-3959: Unauthorized.
- KT-CT-3973: Repayment request is not in a state to be approved.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for approving a repayment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The approved repayment. |
Mutation
mutation ApproveRepayment($input: ApproveRepaymentInput!) {
approveRepayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repayment {
...AccountRepaymentTypeFragment
}
}
}Variables
{
"input": ApproveRepaymentInput
}Response
{
"data": {
"approveRepayment": {
"possibleErrors": [PossibleErrorType],
"repayment": AccountRepaymentType
}
}
}assessCollectionProcessRecordForPause
Type:AssessCollectionProcessRecordForPause
URL:https://api.st.kraken.tech/v1/graphql/
Assess a collection process record for pause.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Details of collection process to run the pause assessment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of collection process after running the pause assessment. |
Mutation
mutation AssessCollectionProcessRecordForPause($input: AssessCollectionProcessRecordForPauseInputType!) {
assessCollectionProcessRecordForPause(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessProcessed {
...AssessCollectionProcessRecordForPauseOutputTypeFragment
}
}
}Variables
{
"input": AssessCollectionProcessRecordForPauseInputType
}Response
{
"data": {
"assessCollectionProcessRecordForPause": {
"possibleErrors": [PossibleErrorType],
"collectionProcessProcessed": AssessCollectionProcessRecordForPauseOutputType
}
}
}assignInkBucket
Type:AssignInkBucket
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-7613: The Ink bucket was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The conversation that will be assigned to the bucket. |
| The bucket that the conversation will be assigned to. |
Mutation
mutation AssignInkBucket($input: AssignInkBucketInput) {
assignInkBucket(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
conversation {
...InkConversationFragment
}
bucket {
...InkBucketFragment
}
}
}Variables
{
"input": AssignInkBucketInput
}Response
{
"data": {
"assignInkBucket": {
"possibleErrors": [PossibleErrorType],
"conversation": InkConversation,
"bucket": InkBucket
}
}
}associateCallWithAccount
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-11808: Unable to associate account to call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The call. |
Mutation
mutation AssociateCallWithAccount($input: AssociateCallWithAccountInput!) {
associateCallWithAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
call {
...InboundCallTypeFragment
}
}
}Variables
{
"input": AssociateCallWithAccountInput
}Response
{
"data": {
"associateCallWithAccount": {
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
}
}associateItemToCollectionProcess
Type:AssociateItemToCollectionProcess
URL:https://api.st.kraken.tech/v1/graphql/
Associate item to a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11205: Item already associated to collection process.
- KT-CT-11216: Invalid extra_details for associated item type.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input variables needed for associating an item to collection process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Item associated to the collection process. |
Mutation
mutation AssociateItemToCollectionProcess($input: AssociateItemToCollectionProcessInputType!) {
associateItemToCollectionProcess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessAssociatedItem {
...AssociateItemToCollectionProcessOutputTypeFragment
}
}
}Variables
{
"input": AssociateItemToCollectionProcessInputType
}Response
{
"data": {
"associateItemToCollectionProcess": {
"possibleErrors": [PossibleErrorType],
"collectionProcessAssociatedItem": AssociateItemToCollectionProcessOutputType
}
}
}awardLoyaltyPoints
Type:AwardLoyaltyPoints
URL:https://api.st.kraken.tech/v1/graphql/
Award the passed number of Loyalty Points to the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9202: Loyalty Points adapter not configured.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9212: Points exceed maximum limit.
- KT-CT-9219: Loyalty points user not found.
- KT-CT-9221: Idempotency key already used on ledger entry.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for awarding Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were awarded. |
| The ledger entry for the awarded loyalty points. |
Mutation
mutation AwardLoyaltyPoints($input: AwardLoyaltyPointsInput!) {
awardLoyaltyPoints(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsAwarded
ledgerEntry {
...LoyaltyPointLedgerEntryTypeFragment
}
}
}Variables
{
"input": AwardLoyaltyPointsInput
}Response
{
"data": {
"awardLoyaltyPoints": {
"possibleErrors": [PossibleErrorType],
"pointsAwarded": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}
}
}backendScreenEvent
Type:BackendScreenEvent
URL:https://api.st.kraken.tech/v1/graphql/
Look up an event to perform from its event_id, and return the next action to perform.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-8002: No event found.
- KT-CT-8003: Event has no execute function.
- KT-CT-8004: Error executing event in the backend.
- KT-CT-8007: Incorrect or missing parameters for backend screen event.
- KT-GB-9310: Account ineligible for joining Octoplus.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for performing a backend action. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| An action to perform. |
Mutation
mutation BackendScreenEvent($input: BackendScreenEventInput!) {
backendScreenEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
action {
... on DeeplinkActionType {
...DeeplinkActionTypeFragment
}
... on LinkActionType {
...LinkActionTypeFragment
}
... on BackendScreenEventActionType {
...BackendScreenEventActionTypeFragment
}
... on CloseActionType {
...CloseActionTypeFragment
}
... on ScreenActionType {
...ScreenActionTypeFragment
}
... on ShowInputFieldErrorsActionType {
...ShowInputFieldErrorsActionTypeFragment
}
}
}
}Variables
{
"input": BackendScreenEventInput
}Response
{
"data": {
"backendScreenEvent": {
"possibleErrors": [PossibleErrorType],
"action": DeeplinkActionType
}
}
}blockRepaymentSubmission
URL:https://api.st.kraken.tech/v1/graphql/
Block a repayment from being submitted.
The possible errors that can be raised are:
- KT-CT-3944: Account repayment does not exist.
- KT-CT-3946: Unable to block a repayment from being submitted.
- KT-CT-3950: The provided reason text is too long.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variable needed for blocking repayment submission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The repayment ID. |
| Resulting Repayment Intervention details. |
Mutation
mutation BlockRepaymentSubmission($input: RepaymentInput!) {
blockRepaymentSubmission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentId
repaymentIntervention {
...RepaymentInterventionTypeFragment
}
}
}Variables
{
"input": RepaymentInput
}Response
{
"data": {
"blockRepaymentSubmission": {
"possibleErrors": [PossibleErrorType],
"repaymentId": "abc123",
"repaymentIntervention": RepaymentInterventionType
}
}
}cancelEnrollment
Type:EnrollmentCancelled!
URL:https://api.st.kraken.tech/v1/graphql/
Cancel an enrollment for an account and a set of supply points.
The possible errors that can be raised are:
- KT-CT-10312: Mutation not enabled in this environment.
- KT-CT-10318: Enrollment process not found.
- KT-CT-10319: Enrollment process failed to cancel.
- KT-CT-10320: Enrollment process not cancellable.
- KT-CT-10321: Enrollment cancellation workflow not defined.
- KT-CT-10323: Enrollment process failed to cancel.
- KT-CT-10338: Enrollment process cannot be cancelled.
- KT-CT-10331: Missing required process number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation CancelEnrollment($input: CancelEnrollmentInput!) {
cancelEnrollment(input: $input) {
message
enrollmentProcess {
... on JoinSupplierProcessType {
...JoinSupplierProcessTypeFragment
}
... on OccupyPropertyProcessType {
...OccupyPropertyProcessTypeFragment
}
}
}
}Variables
{
"input": CancelEnrollmentInput
}Response
{
"data": {
"cancelEnrollment": {
"message": "abc123",
"enrollmentProcess": JoinSupplierProcessType
}
}
}cancelLeaveSupplier
URL:https://api.st.kraken.tech/v1/graphql/
Cancel a leave supplier process.
The possible errors that can be raised are:
- KT-CT-10304: Mutation not enabled in this environment.
- KT-CT-10302: Invalid data.
- KT-CT-10305: Failed to cancel leave supplier process - market actions are no longer cancellable.
- KT-CT-10306: Failed to cancel leave supplier process - the cancellation workflow has not been configured.
- KT-CT-10307: Failed to cancel leave supplier process - failed to cancel market actions.
- KT-CT-10308: Failed to cancel leave supplier process.
- KT-CT-10311: Failed to cancel leave supplier process. The process status is not in cancellable status.
- KT-CT-1607: Value cannot be empty.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation CancelLeaveSupplier($input: CancelLeaveSupplierInput!) {
cancelLeaveSupplier(input: $input) {
message
}
}Variables
{
"input": CancelLeaveSupplierInput
}Response
{
"data": {
"cancelLeaveSupplier": {
"message": "abc123"
}
}
}cancelOnSiteJobsAppointment
Type:CancelOnSiteJobsAppointment
URL:https://api.st.kraken.tech/v1/graphql/
Cancel an Appointment.
The possible errors that can be raised are:
- KT-CT-13001: Appointment does not exist.
- KT-CT-13019: Vendor not found.
- KT-CT-13017: Appointment cancellation not supported.
- KT-CT-13053: Failed to cancel the appointment with the agent.
- KT-CT-13018: Unable to record cancellationcategory/cancellationsub_category.
- KT-CT-13043: Cannot update appointment as it has terminal status.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The input objects required to cancel an Appointment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The Appointment that was cancelled. |
Mutation
mutation CancelOnSiteJobsAppointment($input: CancelOnSiteJobsAppointmentInputType!) {
cancelOnSiteJobsAppointment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
onSiteJobsAppointment {
...OnSiteJobsAppointmentTypeFragment
}
}
}Variables
{
"input": CancelOnSiteJobsAppointmentInputType
}Response
{
"data": {
"cancelOnSiteJobsAppointment": {
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}
}
}cancelPayment
Type:CancelPayment
URL:https://api.st.kraken.tech/v1/graphql/
Cancel an in-flight payment.
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-3954: Payment cancellation failed.
- KT-CT-3955: Payment cannot be cancelled.
- KT-CT-3956: Temporary error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for cancelling a pending payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The cancelled payment. |
Mutation
mutation CancelPayment($input: CancelPaymentInput!) {
cancelPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": CancelPaymentInput
}Response
{
"data": {
"cancelPayment": {
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
}
}cancelRepaymentRequest
URL:https://api.st.kraken.tech/v1/graphql/
Cancel a repayment or refund request.
The possible errors that can be raised are:
- KT-CT-4231: Unauthorized.
- KT-CT-3930: The repayment or refund request does not exist.
- KT-CT-3931: This repayment or refund request cannot be cancelled.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for cancelling a repayment request. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The cancelled repayment/refund request. |
Mutation
mutation CancelRepaymentRequest($input: CancelRepaymentRequestInputType!) {
cancelRepaymentRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentRequest {
...CancelRepaymentRequestOutputTypeFragment
}
}
}Variables
{
"input": CancelRepaymentRequestInputType
}Response
{
"data": {
"cancelRepaymentRequest": {
"possibleErrors": [PossibleErrorType],
"repaymentRequest": CancelRepaymentRequestOutputType
}
}
}checkCallbackEligibility
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11811: Callback requests are disabled.
- KT-CT-11812: Minimum wait time not met for callback request.
- KT-CT-11813: Call is not in queue.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Callback eligibility information. |
Mutation
mutation CheckCallbackEligibility($input: CheckCallbackEligibilityInput!) {
checkCallbackEligibility(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
callbackEligibility {
...CallbackEligibilityTypeFragment
}
}
}Variables
{
"input": CheckCallbackEligibilityInput
}Response
{
"data": {
"checkCallbackEligibility": {
"possibleErrors": [PossibleErrorType],
"callbackEligibility": CallbackEligibilityType
}
}
}claimJourneyCompletionReward
Type:ClaimJourneyCompletionReward
URL:https://api.st.kraken.tech/v1/graphql/
Claim a journey completion reward.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-GB-12801: Ineligible for reward journey.
- KT-GB-12802: Reward claim failed.
- KT-GB-12803: Invalid reward journey code.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
Input data for claiming the journey completion reward. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The code of the reward that was given to the user. |
Mutation
mutation ClaimJourneyCompletionReward($input: ClaimJourneyCompletionRewardInput!) {
claimJourneyCompletionReward(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
rewardCode
}
}Variables
{
"input": ClaimJourneyCompletionRewardInput
}Response
{
"data": {
"claimJourneyCompletionReward": {
"possibleErrors": [PossibleErrorType],
"rewardCode": "abc123"
}
}
}closeDcaProceeding
Type:CloseDCAProceeding
URL:https://api.st.kraken.tech/v1/graphql/
Close the DCA proceeding for an account.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11602: Could not find DCA with that name.
- KT-CT-11603: Could not stop debt collection proceeding.
- KT-CT-11604: Active debt collection proceeding does not exist for account.
- KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the closure could be applied. |
Mutation
mutation CloseDcaProceeding($input: CloseDCAProceedingInputType!) {
closeDcaProceeding(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
dcaProceedingClosureStatus {
...DCAProceedingClosureStatusFragment
}
}
}Variables
{
"input": CloseDCAProceedingInputType
}Response
{
"data": {
"closeDcaProceeding": {
"possibleErrors": [PossibleErrorType],
"dcaProceedingClosureStatus": DCAProceedingClosureStatus
}
}
}closeInkConversation
Type:CloseInkConversation
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for closing an Ink conversation. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The conversation that was closed. |
Mutation
mutation CloseInkConversation($input: CloseInkConversationInput) {
closeInkConversation(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
conversation {
...InkConversationFragment
}
}
}Variables
{
"input": CloseInkConversationInput
}Response
{
"data": {
"closeInkConversation": {
"possibleErrors": [PossibleErrorType],
"conversation": InkConversation
}
}
}closeInkLiveChat
Type:CloseInkLiveChatConversation
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7616: Not yet implemented.
- KT-CT-7643: The Live Chat was not found.
- KT-CT-7644: Ink Live Chat conversation not found.
- KT-CT-7652: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The live chat conversation. |
Mutation
mutation CloseInkLiveChat($input: CloseInkLiveChaConversationtInput) {
closeInkLiveChat(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
liveChatConversation {
...InkLiveChatConversationFragment
}
}
}Variables
{
"input": CloseInkLiveChaConversationtInput
}Response
{
"data": {
"closeInkLiveChat": {
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation
}
}
}closeOpenPrintBatch
Type:CloseOpenPrintBatch!
URL:https://api.st.kraken.tech/v1/graphql/
Close the Open Print Batch if any.
The possible errors that can be raised are:
- KT-CT-9010: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Return fields
| Name | Description |
|---|
Mutation
mutation CloseOpenPrintBatch {
closeOpenPrintBatch {
possibleErrors {
...PossibleErrorTypeFragment
}
printBatch {
...PrintBatchTypeFragment
}
}
}Response
{
"data": {
"closeOpenPrintBatch": {
"possibleErrors": [PossibleErrorType],
"printBatch": PrintBatchType
}
}
}collectDeposit
Type:CollectDeposit
URL:https://api.st.kraken.tech/v1/graphql/
Collect deposit for the given account.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-5711: No collection is required.
- KT-CT-5712: Deposit agreement does not exist or has not been accepted.
- KT-CT-5713: Payment instruction is not usable.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CollectDeposit($input: CollectDepositInput!) {
collectDeposit(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...CollectDepositOutputFragment
}
}
}Variables
{
"input": CollectDepositInput
}Response
{
"data": {
"collectDeposit": {
"possibleErrors": [PossibleErrorType],
"payment": CollectDepositOutput
}
}
}collectPayment
Type:CollectPayment
URL:https://api.st.kraken.tech/v1/graphql/
Attempt to collect a one-off payment. If an instruction type is provided and there is an existing payment instruction, the payment can be collected immediately. A request to collect a payment at a future date can also be made, in which case the instruction input type is not necessary, but an instruction must exist at the specified collection date for the payment to be collected successfully.
The possible errors that can be raised are:
- KT-CT-3932: Invalid data.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for collecting a payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details about the collected payment. Note that we might not be able to collect the payment (e.g. if there is no usable payment instruction), in which case the status of the returned payment might be failed or cancelled. |
Mutation
mutation CollectPayment($input: CollectPaymentInput!) {
collectPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": CollectPaymentInput
}Response
{
"data": {
"collectPayment": {
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
}
}commenceDcaProceeding
URL:https://api.st.kraken.tech/v1/graphql/
Add commencement to an account.
The possible errors that can be raised are:
- KT-CT-11606: Debt Collection Agency cannot use campaign.
- KT-CT-11601: Cannot start collection proceeding, proceeding for this account already exists.
- KT-CT-11602: Could not find DCA with that name.
- KT-CT-11607: Invalid ledger number for debt collection proceeding.
- KT-CT-11608: Ledger does not belong to account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the commencement could be applied. |
Mutation
mutation CommenceDcaProceeding($input: CommenceDCAProceedingInputType!) {
commenceDcaProceeding(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
dcaProceedingCommencementStatus {
...DCAProceedingCommencementStatusFragment
}
}
}Variables
{
"input": CommenceDCAProceedingInputType
}Response
{
"data": {
"commenceDcaProceeding": {
"possibleErrors": [PossibleErrorType],
"dcaProceedingCommencementStatus": DCAProceedingCommencementStatus
}
}
}completeStandalonePayment
Type:CompleteStandalonePayment
URL:https://api.st.kraken.tech/v1/graphql/
Complete a standalone payment.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-3974: Unauthorized.
- KT-CT-3975: Unable to complete standalone payment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for completing a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The completed standalone payment. |
Mutation
mutation CompleteStandalonePayment($input: CompleteStandalonePaymentInput!) {
completeStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...CompleteStandalonePaymentOutputFragment
}
}
}Variables
{
"input": CompleteStandalonePaymentInput
}Response
{
"data": {
"completeStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": CompleteStandalonePaymentOutput
}
}
}confirmDoubleOptIn
Type:ConfirmDoubleOptIn
URL:https://api.st.kraken.tech/v1/graphql/
Confirm a double opt in
The possible errors that can be raised are:
- KT-CT-9016: Consent management not enabled.
- KT-CT-9020: Invalid consent expiring token.
- KT-CT-9021: Consent expiring token not found.
- KT-CT-9022: Consent for given token already accepted.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The consent that was created or updated. |
Mutation
mutation ConfirmDoubleOptIn($input: ConfirmDoubleOptInInput) {
confirmDoubleOptIn(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
consent {
...ConsentTypeFragment
}
}
}Variables
{
"input": ConfirmDoubleOptInInput
}Response
{
"data": {
"confirmDoubleOptIn": {
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
}
}connectAiAgentToCall
Type:ConnectAiAgentToCall
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11815: Unable to connect a call to an AI agent.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The call the AI agent was connected to. |
Mutation
mutation ConnectAiAgentToCall($input: ConnectAiAgentToCallInput!) {
connectAiAgentToCall(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
call {
...InboundCallTypeFragment
}
}
}Variables
{
"input": ConnectAiAgentToCallInput
}Response
{
"data": {
"connectAiAgentToCall": {
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
}
}createAccountCharge
Type:CreateAccountCharge
URL:https://api.st.kraken.tech/v1/graphql/
Add charge to an account.
The possible errors that can be raised are:
- KT-CT-5211: The charge reason with the requested code is deprecated.
- KT-CT-5212: The charge reason with the requested code does not exist.
- KT-CT-5213: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an account charge. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateAccountCharge($input: CreateAccountChargeInput!) {
createAccountCharge(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountCharge {
...AccountChargeTypeFragment
}
}
}Variables
{
"input": CreateAccountChargeInput
}Response
{
"data": {
"createAccountCharge": {
"possibleErrors": [PossibleErrorType],
"accountCharge": AccountChargeType
}
}
}createAccountCredit
Type:CreateAccountCredit
URL:https://api.st.kraken.tech/v1/graphql/
Add credit to an account.
The possible errors that can be raised are:
- KT-CT-5315: Invalid data.
- KT-CT-5314: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'createAccountCredit' field is deprecated.
Use postCredit mutation as it is ledger aware.
- Marked as deprecated on 2022-07-04.
- Scheduled for removal on or after 2026-03-30.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an account credit. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateAccountCredit($input: CreateAccountCreditInput!) {
createAccountCredit(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountCredit {
...AccountCreditTypeFragment
}
}
}Variables
{
"input": CreateAccountCreditInput
}Response
{
"data": {
"createAccountCredit": {
"possibleErrors": [PossibleErrorType],
"accountCredit": AccountCreditType
}
}
}createAccountNote
Type:CreateAccountNote
URL:https://api.st.kraken.tech/v1/graphql/
Add a note to an account.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4180: Account note must be a valid string.
- KT-CT-4196: Unpin at date provided is in the past.
- KT-CT-4195: Unpin at date provided for an unpinned note.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for adding a note to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account, which has the added note. |
Mutation
mutation CreateAccountNote($input: CreateAccountNoteInput!) {
createAccountNote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": CreateAccountNoteInput
}Response
{
"data": {
"createAccountNote": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}createAccountPaymentSchedule
Type:CreateAccountPaymentSchedule
URL:https://api.st.kraken.tech/v1/graphql/
Replace an existing payment schedule with a new one that updates either the payment amount or payment day.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-3822: Unauthorized.
- KT-CT-3923: Unauthorized.
- KT-CT-3941: Invalid data.
- KT-CT-3942: An unexpected error occurred.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3960: Invalid value for payment day.
- KT-CT-3961: Cannot update plan-associated payment schedule.
- KT-CT-3962: No new value provided to update payment schedule.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for updating a payment schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| New payment schedule. |
Mutation
mutation CreateAccountPaymentSchedule($input: CreateAccountPaymentScheduleInput!) {
createAccountPaymentSchedule(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
schedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": CreateAccountPaymentScheduleInput
}Response
{
"data": {
"createAccountPaymentSchedule": {
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
}
}createAccountReference
URL:https://api.st.kraken.tech/v1/graphql/
Create an account reference.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an account reference. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateAccountReference($input: AccountReferenceInput!) {
createAccountReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReference {
...AccountReferenceTypeFragment
}
}
}Variables
{
"input": AccountReferenceInput
}Response
{
"data": {
"createAccountReference": {
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
}
}createAccountReminder
URL:https://api.st.kraken.tech/v1/graphql/
Create an account reminder.
The possible errors that can be raised are:
- KT-CT-1401: Invalid data.
- KT-CT-1402: Unable to create account reminder.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'createAccountReminder' field is deprecated.
This mutation rely on legacy reminder types.
Please use the createReminder mutation which uses the new registry based reminder types instead.
- Marked as deprecated on 2024-11-14.
- Scheduled for removal on or after 2025-04-16.
Arguments
| Name | Description |
|---|---|
| Input variables needed for creating an account reminder. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account reminder. |
Mutation
mutation CreateAccountReminder($input: CreateAccountReminderInput!) {
createAccountReminder(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReminder {
...AccountReminderFragment
}
}
}Variables
{
"input": CreateAccountReminderInput
}Response
{
"data": {
"createAccountReminder": {
"possibleErrors": [PossibleErrorType],
"accountReminder": AccountReminder
}
}
}createAffiliateLink
Type:CreateAffiliateLink!
URL:https://api.st.kraken.tech/v1/graphql/
Create an affiliate link for a new sales agent.
The possible errors that can be raised are:
- KT-CT-7711: Invalid data.
- KT-CT-7713: Invalid data.
- KT-CT-7714: Invalid data.
- KT-CT-7715: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an affiliate link for an organisation. |
Return fields
| Name | Description |
|---|
Mutation
mutation CreateAffiliateLink($input: CreateAffiliateLinkInputType!) {
createAffiliateLink(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
affiliateLink {
...AffiliateLinkTypeFragment
}
}
}Variables
{
"input": CreateAffiliateLinkInputType
}Response
{
"data": {
"createAffiliateLink": {
"possibleErrors": [PossibleErrorType],
"affiliateLink": AffiliateLinkType
}
}
}createAffiliateOrganisation
Type:CreateAffiliateOrganisation!
URL:https://api.st.kraken.tech/v1/graphql/
Create an affiliate organisation.
The possible errors that can be raised are:
- KT-CT-7716: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating an affiliate organisation. |
Return fields
| Name | Description |
|---|
Mutation
mutation CreateAffiliateOrganisation($input: CreateAffiliateOrganisationInputType!) {
createAffiliateOrganisation(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
affiliateOrganisation {
...AffiliateOrganisationTypeFragment
}
}
}Variables
{
"input": CreateAffiliateOrganisationInputType
}Response
{
"data": {
"createAffiliateOrganisation": {
"possibleErrors": [PossibleErrorType],
"affiliateOrganisation": AffiliateOrganisationType
}
}
}createAffiliateSession
URL:https://api.st.kraken.tech/v1/graphql/
Create a session for an affiliate link.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a session for an affiliate link. |
Return fields
| Name | Description |
|---|
Mutation
mutation CreateAffiliateSession($input: CreateAffiliateSessionInputType!) {
createAffiliateSession(input: $input) {
affiliateSession {
...AffiliateSessionTypeFragment
}
}
}Variables
{
"input": CreateAffiliateSessionInputType
}Response
{
"data": {
"createAffiliateSession": {
"affiliateSession": AffiliateSessionType
}
}
}createAgreement
Type:CreateAgreement
URL:https://api.st.kraken.tech/v1/graphql/
Create a new agreement.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-4910: No product exists with the given input.
- KT-CT-1503: Agreement validto date must be later than validfrom date.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1511: Cannot create overlapping agreement.
- KT-CT-1512: Account type does not support agreements.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an agreement. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created agreement. |
Mutation
mutation CreateAgreement($input: CreateAgreementInput!) {
createAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreement {
...CommonAgreementTypeFragment
}
}
}Variables
{
"input": CreateAgreementInput
}Response
{
"data": {
"createAgreement": {
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}
}
}createAgreementRollover
URL:https://api.st.kraken.tech/v1/graphql/
Create an agreement rollover for a specific account and agreement.
The possible errors that can be raised are:
- KT-CT-1501: Agreement not found.
- KT-CT-4910: No product exists with the given input.
- KT-CT-4924: Unauthorized.
- KT-CT-13701: An active agreement rollover already exists for this agreement.
- KT-CT-13702: Expected send date cannot be in the past.
- KT-CT-13703: Rollover date cannot be in the past.
- KT-CT-13704: Unable to create agreement rollover.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Create an agreement rollover for a specific account and agreement. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new agreement rollover. |
Mutation
mutation CreateAgreementRollover($input: CreateAgreementRolloverInput!) {
createAgreementRollover(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreementRollover {
...AgreementRolloverTypeFragment
}
}
}Variables
{
"input": CreateAgreementRolloverInput
}Response
{
"data": {
"createAgreementRollover": {
"possibleErrors": [PossibleErrorType],
"agreementRollover": AgreementRolloverType
}
}
}createApiCall
Type:CreateAPICall
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to create a new APICall instance.
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an API call. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created APICall. |
Mutation
mutation CreateApiCall($input: CreateAPICallInput!) {
createApiCall(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
apiCall {
...APICallTypeFragment
}
}
}Variables
{
"input": CreateAPICallInput
}Response
{
"data": {
"createApiCall": {
"possibleErrors": [PossibleErrorType],
"apiCall": APICallType
}
}
}createApiException
Type:CreateAPIException
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to create a new APIException instance.
The possible errors that can be raised are:
- KT-CT-7801: Received an invalid operationsTeamId.
- KT-CT-7802: The external identifier already exists.
- KT-CT-7805: Too many tags associated with this API Exception.
- KT-CT-7806: Cannot create duplicate tags for the same API exception.
- KT-CT-7811: Received an invalid assignedUserId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an API exception. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created APIException. |
Mutation
mutation CreateApiException($input: CreateAPIExceptionInput!) {
createApiException(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
apiException {
...APIExceptionTypeFragment
}
}
}Variables
{
"input": CreateAPIExceptionInput
}Response
{
"data": {
"createApiException": {
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
}
}createApiExceptionEvent
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to create a new APIExceptionEvent instance.
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an API exception event. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created APIExceptionEvent. |
Mutation
mutation CreateApiExceptionEvent($input: CreateAPIExceptionEventInput!) {
createApiExceptionEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
apiExceptionEvent {
...APIExceptionEventTypeFragment
}
}
}Variables
{
"input": CreateAPIExceptionEventInput
}Response
{
"data": {
"createApiExceptionEvent": {
"possibleErrors": [PossibleErrorType],
"apiExceptionEvent": APIExceptionEventType
}
}
}createApiExceptionNote
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to create a new APIExceptionNote instance.
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an API exception note. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created APIExceptionNote. |
Mutation
mutation CreateApiExceptionNote($input: CreateAPIExceptionNoteInput!) {
createApiExceptionNote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
apiException {
...APIExceptionTypeFragment
}
}
}Variables
{
"input": CreateAPIExceptionNoteInput
}Response
{
"data": {
"createApiExceptionNote": {
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
}
}createAudioRecording
URL:https://api.st.kraken.tech/v1/graphql/
Create an audio recording for an affiliate session.
The possible errors that can be raised are:
- KT-CT-7720: Invalid S3 key format.
- KT-CT-7721: Link not found.
- KT-CT-7722: Invalid input for audio recording upload.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields required to create an audio recording. |
Return fields
| Name | Description |
|---|
Mutation
mutation CreateAudioRecording($input: AudioRecordingInputType!) {
createAudioRecording(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
audioRecording {
...AudioRecordingTypeFragment
}
}
}Variables
{
"input": AudioRecordingInputType
}Response
{
"data": {
"createAudioRecording": {
"possibleErrors": [PossibleErrorType],
"audioRecording": AudioRecordingType
}
}
}createBusiness
Type:CreateBusiness
URL:https://api.st.kraken.tech/v1/graphql/
Create a business.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11108: Invalid data.
- KT-CT-11109: Invalid data.
- KT-CT-11110: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for creating a business. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created business. |
Mutation
mutation CreateBusiness($input: CreateBusinessInput!) {
createBusiness(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
business {
...BusinessTypeFragment
}
}
}Variables
{
"input": CreateBusinessInput
}Response
{
"data": {
"createBusiness": {
"possibleErrors": [PossibleErrorType],
"business": BusinessType
}
}
}createCallMetadata
Type:CreateCallMetadata
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11806: Call metadata item key cannot be an empty string.
- KT-CT-11807: A call metadata item with this key already exists for this call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The call metadata was attached to. |
Mutation
mutation CreateCallMetadata($input: CallMetadataInput!) {
createCallMetadata(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
call {
...CallInterfaceFragment
}
}
}Variables
{
"input": CallMetadataInput
}Response
{
"data": {
"createCallMetadata": {
"possibleErrors": [PossibleErrorType],
"call": CallInterface
}
}
}createCampaignItems
Type:CreateCampaignItems
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11501: Voice campaign not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-11503: One or more campaign items are invalid and cannot be created.
- KT-CT-11504: The batch of campaign items is too large.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| |
| The identifier for this batch of items to assist in tracking and logging. |
Mutation
mutation CreateCampaignItems($input: CreateCampaignItemsInput!) {
createCampaignItems(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
campaignItems {
...VoiceCampaignItemTypeFragment
}
batchIdentifier
}
}Variables
{
"input": CreateCampaignItemsInput
}Response
{
"data": {
"createCampaignItems": {
"possibleErrors": [PossibleErrorType],
"campaignItems": [VoiceCampaignItemType],
"batchIdentifier": "abc123"
}
}
}createCollectionProcessEvent
Type:CreateCollectionProcessEvent
URL:https://api.st.kraken.tech/v1/graphql/
Create an event for a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-1605: Invalid input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input variables needed for creating a collection process event. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created collection process event. |
Mutation
mutation CreateCollectionProcessEvent($input: CreateCollectionProcessEventInputType!) {
createCollectionProcessEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessEvent {
...CollectionProcessEventOutputTypeFragment
}
}
}Variables
{
"input": CreateCollectionProcessEventInputType
}Response
{
"data": {
"createCollectionProcessEvent": {
"possibleErrors": [PossibleErrorType],
"collectionProcessEvent": CollectionProcessEventOutputType
}
}
}createComplaint
Type:CreateComplaint
URL:https://api.st.kraken.tech/v1/graphql/
Create a complaint.
The possible errors that can be raised are:
- KT-CT-10801: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The complaint that has been created. |
Mutation
mutation CreateComplaint($complaint: CreateComplaintInputType!) {
createComplaint(complaint: $complaint) {
possibleErrors {
...PossibleErrorTypeFragment
}
complaint {
...ComplaintTypeFragment
}
}
}Variables
{
"complaint": CreateComplaintInputType
}Response
{
"data": {
"createComplaint": {
"possibleErrors": [PossibleErrorType],
"complaint": ComplaintType
}
}
}createContract
URL:https://api.st.kraken.tech/v1/graphql/
Create and actualize a new contract for an account or business.
The possible errors that can be raised are:
- KT-CT-10001: Party is already under contract.
- KT-CT-10006: Account not found.
- KT-CT-10021: Business not found.
- KT-CT-10018: The provided contract subject is invalid.
- KT-CT-10019: Contract creation implies breach.
- KT-CT-10020: The provided contract party payload is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation CreateContract($input: CreateContractInput!) {
createContract(input: $input) {
identifier
wasCreated
}
}Variables
{
"input": CreateContractInput
}Response
{
"data": {
"createContract": {
"identifier": NonEmptyString,
"wasCreated": true
}
}
}createContributionAgreement
Type:CreateContributionAgreement
URL:https://api.st.kraken.tech/v1/graphql/
Create a contribution agreement for an account.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-9601: Invalid data.
- KT-CT-9602: Unable to create contribution agreement.
- KT-CT-9605: Contribution amount cannot be 0 or negative.
- KT-CT-9606: Scheme is not accepting contributions at this time.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input variables needed for creating a contribution agreement on an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created contribution agreement. |
Mutation
mutation CreateContributionAgreement($input: CreateContributionAgreementInput!) {
createContributionAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
contributionAgreement {
...ContributionAgreementTypeFragment
}
}
}Variables
{
"input": CreateContributionAgreementInput
}Response
{
"data": {
"createContributionAgreement": {
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
}
}createCreditTransferPermission
Type:CreateCreditTransferPermission
URL:https://api.st.kraken.tech/v1/graphql/
Create a credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3827: The ledger is not valid.
- KT-CT-3828: At least one of the provided ledgers must be a credit storage ledger.
- KT-CT-3829: The credit transfer permission already exists.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields to create a credit transfer permission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Datetime when the credit transfer permission is valid. |
Mutation
mutation CreateCreditTransferPermission($input: CreateCreditTransferPermissionInput!) {
createCreditTransferPermission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
validFrom
}
}Variables
{
"input": CreateCreditTransferPermissionInput
}Response
{
"data": {
"createCreditTransferPermission": {
"possibleErrors": [PossibleErrorType],
"validFrom": "2020-01-01T00:00:00.000Z"
}
}
}createCustomerFeedback
URL:https://api.st.kraken.tech/v1/graphql/
Create unsubmitted customer feedback object.
The possible errors that can be raised are:
- KT-CT-5516: Invalid data.
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created customer feedback object. |
Mutation
mutation CreateCustomerFeedback($input: CreateCustomerFeedbackInputType!) {
createCustomerFeedback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
customerFeedback {
...CustomerFeedbackTypeFragment
}
}
}Variables
{
"input": CreateCustomerFeedbackInputType
}Response
{
"data": {
"createCustomerFeedback": {
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
}
}createDepositAgreement
URL:https://api.st.kraken.tech/v1/graphql/
Create a new deposit agreement for the account if it needs one.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateDepositAgreement($input: CreateDepositAgreementInput!) {
createDepositAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
depositAgreement {
...CreateDepositAgreementOutputFragment
}
}
}Variables
{
"input": CreateDepositAgreementInput
}Response
{
"data": {
"createDepositAgreement": {
"possibleErrors": [PossibleErrorType],
"depositAgreement": CreateDepositAgreementOutput
}
}
}createDirectDebitInstructionAndSchedule
Type:CreateDirectDebitInstructionAndSchedule
URL:https://api.st.kraken.tech/v1/graphql/
Create direct debit payment instructions and schedule
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-GB-3922: This configuration of payment schedule is not supported.
- KT-GB-3930: Invalid data.
- KT-CT-3964: Could not create payment schedule on ledger with future payment schedules.
- KT-CT-3965: Payments list is empty. Unable to create payments for payment schedule.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'createDirectDebitInstructionAndSchedule' field is deprecated.
Please use `setUpDirectDebitInstruction` mutation followed by `createDirectDebitPaymentSchedule` mutation instead.
- Marked as deprecated on 2025-11-28.
- Scheduled for removal on or after 2026-02-01.
Arguments
| Name | Description |
|---|---|
Input fields for creating a payment schedule with a direct debit. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The payment instruction. |
| The payment schedule. |
Mutation
mutation CreateDirectDebitInstructionAndSchedule($input: CreateDirectDebitInstructionAndScheduleInput!) {
createDirectDebitInstructionAndSchedule(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...PaymentInstructionTypeFragment
}
paymentSchedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": CreateDirectDebitInstructionAndScheduleInput
}Response
{
"data": {
"createDirectDebitInstructionAndSchedule": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType,
"paymentSchedule": PaymentScheduleType
}
}
}createDirectDebitPaymentSchedule
Type:CreateDirectDebitPaymentSchedule
URL:https://api.st.kraken.tech/v1/graphql/
Create direct debit payment schedule
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-GB-3922: This configuration of payment schedule is not supported.
- KT-GB-3931: Invalid data for payment schedule input.
- KT-CT-3964: Could not create payment schedule on ledger with future payment schedules.
- KT-CT-3965: Payments list is empty. Unable to create payments for payment schedule.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating a payment schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The payment schedule. |
Mutation
mutation CreateDirectDebitPaymentSchedule($input: CreateDirectDebitPaymentScheduleInput!) {
createDirectDebitPaymentSchedule(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentSchedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": CreateDirectDebitPaymentScheduleInput
}Response
{
"data": {
"createDirectDebitPaymentSchedule": {
"possibleErrors": [PossibleErrorType],
"paymentSchedule": PaymentScheduleType
}
}
}createExternalAccountEvent
Type:CreateExternalAccountEvent
URL:https://api.st.kraken.tech/v1/graphql/
Create an external account event.
The possible errors that can be raised are:
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an external account event. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new event data. |
Mutation
mutation CreateExternalAccountEvent($input: CreateExternalAccountEventInput!) {
createExternalAccountEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
event {
...ExternalAccountEventFragment
}
}
}Variables
{
"input": CreateExternalAccountEventInput
}Response
{
"data": {
"createExternalAccountEvent": {
"possibleErrors": [PossibleErrorType],
"event": ExternalAccountEvent
}
}
}createExternalAccountUserEvent
Type:CreateExternalAccountUserEvent
URL:https://api.st.kraken.tech/v1/graphql/
Create an external account user event.
The possible errors that can be raised are:
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating an external account event. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new event data. |
Mutation
mutation CreateExternalAccountUserEvent($input: CreateExternalAccountUserEventInput!) {
createExternalAccountUserEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
event {
...ExternalAccountUserEventFragment
}
}
}Variables
{
"input": CreateExternalAccountUserEventInput
}Response
{
"data": {
"createExternalAccountUserEvent": {
"possibleErrors": [PossibleErrorType],
"event": ExternalAccountUserEvent
}
}
}createExternalMessage
URL:https://api.st.kraken.tech/v1/graphql/
Create an external message to record communications sent by external vendors. This allows you to import messages, such as emails, sent using other tools into Kraken.
The possible errors that can be raised are:
- KT-CT-14201: Vendor is empty.
- KT-CT-14202: Vendor message ID is empty.
- KT-CT-14203: Account number is empty.
- KT-CT-14204: Message already exists.
- KT-CT-14205: Unable to create the external message.
- KT-CT-14206: An email body is missing.
- KT-CT-14207: To email is empty.
- KT-CT-14208: To email is not a valid email address.
- KT-CT-14209: From email is empty.
- KT-CT-14210: From email is an invalid format.
- KT-CT-14211: A reply to email address is empty.
- KT-CT-14212: A reply to email address is not a valid email address.
- KT-CT-14213: The external messaging API is not enabled.
- KT-CT-14214: An account number was provided, but no corresponding account could be found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for creating an external message. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The external message that was created. |
Mutation
mutation CreateExternalMessage($input: CreateExternalMessageInput!) {
createExternalMessage(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
externalMessage {
...ExternalMessageTypeFragment
}
}
}Variables
{
"input": CreateExternalMessageInput
}Response
{
"data": {
"createExternalMessage": {
"possibleErrors": [PossibleErrorType],
"externalMessage": ExternalMessageType
}
}
}createFormSubmission
Type:FormSubmissionOuput
URL:https://api.st.kraken.tech/v1/graphql/
Create a "form submission" entity. This is only meant to be used as a quick way of putting together a form and submit data for it, in the form of JSON - it is not expected that all form submissions will come through this path.
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
| |
|
Mutation
mutation CreateFormSubmission($input: FormSubmissionInput!) {
createFormSubmission(input: $input) {
id
content
errors {
...SerializerFieldErrorsTypeFragment
}
}
}Variables
{
"input": FormSubmissionInput
}Response
{
"data": {
"createFormSubmission": {
"id": 1,
"content": {"key": "value"},
"errors": [SerializerFieldErrorsType]
}
}
}createGoodsPurchase
Type:CreateGoodsPurchase
URL:https://api.st.kraken.tech/v1/graphql/
Create a goods purchase.
The possible errors that can be raised are:
- KT-CT-8206: Invalid data.
- KT-CT-1131: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a purchase without a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase created. |
Mutation
mutation CreateGoodsPurchase($input: CreatePurchaseInput!) {
createGoodsPurchase(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": CreatePurchaseInput
}Response
{
"data": {
"createGoodsPurchase": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}createGoodsQuote
Type:CreateGoodsQuote
URL:https://api.st.kraken.tech/v1/graphql/
Create a goods quote.
The possible errors that can be raised are:
- KT-CT-8202: Invalid data.
- KT-CT-8205: Unable to create quote.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a goods quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote created for the customer. |
Mutation
mutation CreateGoodsQuote($input: CreateGoodsQuoteInput!) {
createGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsQuote {
...GoodsQuoteFragment
}
}
}Variables
{
"input": CreateGoodsQuoteInput
}Response
{
"data": {
"createGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
}
}createGoodsQuoteWithoutAccount
Type:CreateGoodsQuoteWithoutAccount
URL:https://api.st.kraken.tech/v1/graphql/
Create a goods quote without an account.
The possible errors that can be raised are:
- KT-CT-8202: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating a goods quote without an existing account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote created for the customer. |
Mutation
mutation CreateGoodsQuoteWithoutAccount($input: CreateGoodsQuoteWithoutAccountInput!) {
createGoodsQuoteWithoutAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsQuote {
...GoodsQuoteFragment
}
}
}Variables
{
"input": CreateGoodsQuoteWithoutAccountInput
}Response
{
"data": {
"createGoodsQuoteWithoutAccount": {
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
}
}createInboundCall
Type:CreateInboundCall
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11805: Invalid input for creating an inbound call.
- KT-CT-11810: Caller is blocked.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The call that was created. |
Mutation
mutation CreateInboundCall($input: CreateInboundCallInput!) {
createInboundCall(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
call {
...InboundCallTypeFragment
}
}
}Variables
{
"input": CreateInboundCallInput
}Response
{
"data": {
"createInboundCall": {
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
}
}createInkInboundMessage
URL:https://api.st.kraken.tech/v1/graphql/
Register an Ink inbound message.
The possible errors that can be raised are:
- KT-CT-7622: Attachment bucket is invalid.
- KT-CT-7623: Attachment path is invalid.
- KT-CT-7621: Attachment not found.
- KT-CT-7618: Unable to process message.
- KT-CT-7625: Invalid email address.
- KT-CT-7630: Message with this message ID has already been processed.
- KT-CT-7632: The text content of the Ink Inbound Generic Message is too long.
- KT-CT-7620: Channel not supported.
- KT-CT-7627: The 'email' object is missing from the payload.
- KT-CT-7628: The 'generic' object is missing from the payload.
- KT-CT-7629: The 'post' object is missing from the payload.
- KT-CT-7653: Account numbers on the message and message type must match if both are supplied.
- KT-CT-7654: An account number was provided, but no corresponding account could be found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The Ink message that was created. |
Mutation
mutation CreateInkInboundMessage($input: CreateInkInboundMessageInput) {
createInkInboundMessage(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
message {
... on InkEmail {
...InkEmailFragment
}
... on InkSMS {
...InkSMSFragment
}
... on InkLine {
...InkLineFragment
}
... on InkWhatsApp {
...InkWhatsAppFragment
}
... on InkTwilioWhatsApp {
...InkTwilioWhatsAppFragment
}
... on InkPost {
...InkPostFragment
}
... on InkGenericMessage {
...InkGenericMessageFragment
}
... on InkLiveChatMessage {
...InkLiveChatMessageFragment
}
}
}
}Variables
{
"input": CreateInkInboundMessageInput
}Response
{
"data": {
"createInkInboundMessage": {
"possibleErrors": [PossibleErrorType],
"message": InkEmail
}
}
}createInkLiveChatMessage
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7616: Not yet implemented.
- KT-CT-1111: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-7642: No account user was found for the given fromHandle.
- KT-CT-7641: Live Chat message with this message ID has already been processed.
- KT-CT-7645: The user is not authorized to access this Live Chat.
- KT-CT-7622: Attachment bucket is invalid.
- KT-CT-7623: Attachment path is invalid.
- KT-CT-7621: Attachment not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The live chat conversation. |
| The ID of the Ink Live Chat message that was created. |
Mutation
mutation CreateInkLiveChatMessage($input: CreateInkLiveChatMessageInput) {
createInkLiveChatMessage(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
liveChatConversation {
...InkLiveChatConversationFragment
}
messageRelayId
}
}Variables
{
"input": CreateInkLiveChatMessageInput
}Response
{
"data": {
"createInkLiveChatMessage": {
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation,
"messageRelayId": "abc123"
}
}
}createInternalCompany
URL:https://api.st.kraken.tech/v1/graphql/
Create a new internal company.
The possible errors that can be raised are:
- KT-CT-14402: Duplicated internal company.
- KT-CT-14403: Invalid address.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The input required to create an internal company. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The result of the create internal company operation. |
Mutation
mutation CreateInternalCompany($input: CreateInternalCompanyInput!) {
createInternalCompany(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
internalCompany {
...CreateInternalCompanyResultTypeFragment
}
}
}Variables
{
"input": CreateInternalCompanyInput
}Response
{
"data": {
"createInternalCompany": {
"possibleErrors": [PossibleErrorType],
"internalCompany": CreateInternalCompanyResultType
}
}
}createLead
Type:CreateLead
URL:https://api.st.kraken.tech/v1/graphql/
Create a lead with the provided details.
The possible errors that can be raised are:
- KT-CT-8912: Funnel not found.
- KT-CT-8930: Unable to parse address.
- KT-CT-8928: The funnel is not active and cannot be used to create this entity.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8919: Funnel initial stage not set.
- KT-CT-9017: Consent type not found.
- KT-CT-8932: Lead contact details missing legal contact.
- KT-CT-8934: Lead contact details missing communications contact.
- KT-CT-8935: National ID bad input.
- KT-CT-4121: Invalid phone number.
- KT-CT-8913: Organisation is not valid to be assigned.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a lead. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The unique number of the lead. |
Mutation
mutation CreateLead($input: CreateLeadInput!) {
createLead(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
leadNumber
}
}Variables
{
"input": CreateLeadInput
}Response
{
"data": {
"createLead": {
"possibleErrors": [PossibleErrorType],
"leadNumber": "abc123"
}
}
}createMetadata
Type:CreateMetadata
URL:https://api.st.kraken.tech/v1/graphql/
Create metadata on an object.
The possible errors that can be raised are:
- KT-CT-8412: Invalid data.
- KT-CT-8414: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating metadata. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateMetadata($input: MetadataInput!) {
createMetadata(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
metadata {
...MetadataFragment
}
}
}Variables
{
"input": MetadataInput
}Response
{
"data": {
"createMetadata": {
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}
}
}createMfaDevice
Type:CreateMfaDevice
URL:https://api.st.kraken.tech/v1/graphql/
Create MFA Device for user.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1151: MFA device not found.
- KT-CT-1153: Unable to create MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Email address to send the MFA code by default. |
| Phone number to send the MFA code by default. |
| Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Mutation
mutation CreateMfaDevice($input: CreateMfaDeviceInputType!) {
createMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceEmail
devicePhone
totpSecret
}
}Variables
{
"input": CreateMfaDeviceInputType
}Response
{
"data": {
"createMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}
}
}createNewAgreementFromProductSwitchProcess
Type:CreateNewAgreementFromProductSwitchProcess
URL:https://api.st.kraken.tech/v1/graphql/
Create a new agreement from an existing product switch process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4924: Unauthorized.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-1510: Product switch process not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Validate the product switch flow data and creates a ProcessSwitchProcess model. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new agreement created. |
Mutation
mutation CreateNewAgreementFromProductSwitchProcess($input: CreateNewAgreementFromProductSwitchProcessInput!) {
createNewAgreementFromProductSwitchProcess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreement {
...CommonAgreementTypeFragment
}
}
}Variables
{
"input": CreateNewAgreementFromProductSwitchProcessInput
}Response
{
"data": {
"createNewAgreementFromProductSwitchProcess": {
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}
}
}createOfferGroupForQuoting
Type:CreateOfferGroupForQuoting
URL:https://api.st.kraken.tech/v1/graphql/
Create a quoting Offer Group.
The possible errors that can be raised are:
- KT-CT-12401: Unable to create offer group.
- KT-CT-12405: Missing rates for quoting.
- KT-CT-12406: Product not configured correctly for quoting.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an offer group from a list of offers. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Quoting Offer Group. |
Mutation
mutation CreateOfferGroupForQuoting($input: CreateOfferGroupForQuotingInput!) {
createOfferGroupForQuoting(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
offerGroup {
...CreateOfferGroupTypeFragment
}
}
}Variables
{
"input": CreateOfferGroupForQuotingInput
}Response
{
"data": {
"createOfferGroupForQuoting": {
"possibleErrors": [PossibleErrorType],
"offerGroup": CreateOfferGroupType
}
}
}createOnSiteJobsAppointment
Type:CreateOnSiteJobsAppointment
URL:https://api.st.kraken.tech/v1/graphql/
Create an Appointment.
The possible errors that can be raised are:
- KT-CT-13030: Booking session not found.
- KT-CT-13025: Booking session has expired.
- KT-CT-13033: Slot not found.
- KT-CT-13028: Agent not found.
- KT-CT-13019: Vendor not found.
- KT-CT-13034: Appointment already exists for this request.
- KT-CT-13035: Request is inactive.
- KT-CT-13032: Request does not exist.
- KT-CT-13036: Booking service currently unavailable.
- KT-CT-13037: Appointment reference not provided by booking service.
- KT-CT-13031: Timeslot is no longer available.
- KT-CT-13027: Booking system error occurred.
- KT-CT-13056: Appointment cannot be rescheduled.
- KT-CT-13044: Failed to update appointment slot.
- KT-CT-13001: Appointment does not exist.
- KT-CT-13063: Failed to derive property for the given supply points.
- KT-CT-13006: No properties found for the given supply points.
- KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The appointment booking session ID to create an appointment. |
| The slot ID to book the appointment for. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created On-Site Jobs appointment. |
Mutation
mutation CreateOnSiteJobsAppointment(
$appointmentBookingSessionId: UUID!,
$slotId: UUID!
) {
createOnSiteJobsAppointment(
appointmentBookingSessionId: $appointmentBookingSessionId,
slotId: $slotId
) {
possibleErrors {
...PossibleErrorTypeFragment
}
onSiteJobsAppointment {
...OnSiteJobsAppointmentTypeFragment
}
}
}Variables
{
"appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"slotId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}Response
{
"data": {
"createOnSiteJobsAppointment": {
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}
}
}createOnSiteJobsAppointmentWithDate
Type:CreateOnSiteJobsAppointmentWithDate
URL:https://api.st.kraken.tech/v1/graphql/
Create an Appointment using DATE booking mode. Used when the booking flow does not require selecting a specific timeslot.
The possible errors that can be raised are:
- KT-CT-13032: Request does not exist.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13020: Could not identify agent from property.
- KT-CT-13021: Invalid job type.
- KT-CT-13022: Work category not found for job type.
- KT-CT-13057: Date booking mode is not applicable for this request.
- KT-CT-13023: Appointment booking checks failed.
- KT-CT-13024: Appointment booking checks returned warnings.
- KT-CT-13028: Agent not found.
- KT-CT-13019: Vendor not found.
- KT-CT-13034: Appointment already exists for this request.
- KT-CT-13035: Request is inactive.
- KT-CT-13036: Booking service currently unavailable.
- KT-CT-13037: Appointment reference not provided by booking service.
- KT-CT-13027: Booking system error occurred.
- KT-CT-13063: Failed to derive property for the given supply points.
- KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
- KT-CT-13006: No properties found for the given supply points.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The appointment booking details. |
| The deadline date for the appointment. |
| Whether to override appointment booking check warnings. Defaults to False. |
| The preferred date for the appointment. |
| The ID of the request to book an appointment for. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created On-Site Jobs appointment. |
Mutation
mutation CreateOnSiteJobsAppointmentWithDate(
$appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
$deadlineDate: Date,
$overrideAppointmentCheckWarnings: Boolean,
$preferredDate: Date!,
$requestId: UUID!
) {
createOnSiteJobsAppointmentWithDate(
appointmentBookingDetails: $appointmentBookingDetails,
deadlineDate: $deadlineDate,
overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
preferredDate: $preferredDate,
requestId: $requestId
) {
possibleErrors {
...PossibleErrorTypeFragment
}
onSiteJobsAppointment {
...OnSiteJobsAppointmentTypeFragment
}
}
}Variables
{
"appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
"deadlineDate": "2020-01-01",
"overrideAppointmentCheckWarnings": true,
"preferredDate": "2020-01-01",
"requestId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}Response
{
"data": {
"createOnSiteJobsAppointmentWithDate": {
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}
}
}createOnSiteJobsAppointmentWithoutBooking
Type:CreateOnSiteJobsAppointmentWithoutBooking
URL:https://api.st.kraken.tech/v1/graphql/
Create an Appointment on Kraken without making a booking via the booking vendor system. This is typically used by booking vendors to inform Kraken about appointments created on their system.
The possible errors that can be raised are:
- KT-CT-13032: Request does not exist.
- KT-CT-13035: Request is inactive.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13034: Appointment already exists for this request.
- KT-CT-13021: Invalid job type.
- KT-CT-13018: Unable to record cancellationcategory/cancellationsub_category.
- KT-CT-13039: Cancellation fields require CANCELLED status.
- KT-CT-13027: Booking system error occurred.
- KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-13062: Datetime field must be timezone-aware.
- KT-CT-13044: Failed to update appointment slot.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The input objects required to create an Appointment on Kraken without making a booking. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created Appointment. |
Mutation
mutation CreateOnSiteJobsAppointmentWithoutBooking($input: OnSiteJobsCreateAppointmentInput!) {
createOnSiteJobsAppointmentWithoutBooking(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
onSiteJobsAppointment {
...OnSiteJobsAppointmentTypeFragment
}
}
}Variables
{
"input": OnSiteJobsCreateAppointmentInput
}Response
{
"data": {
"createOnSiteJobsAppointmentWithoutBooking": {
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}
}
}createOnSiteJobsRequest
URL:https://api.st.kraken.tech/v1/graphql/
Create a Request.
The possible errors that can be raised are:
- KT-CT-13002: Supply point not found.
- KT-CT-13003: Supply points must belong to the same account.
- KT-CT-13004: No account found for the given supply points.
- KT-CT-13006: No properties found for the given supply points.
- KT-CT-13028: Agent not found.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13007: At least one of the request checks failed.
- KT-CT-13008: At least one of the request checks has warnings.
- KT-CT-13009: On site jobs Request already exists.
- KT-CT-13012: Viewer is not allowed to create a request.
- KT-CT-13013: Reporter post init error.
- KT-CT-13014: Request reason is not supported.
- KT-CT-13015: Request sub_reason is not supported.
- KT-CT-13041: User is not allowed to override request/appointment checks.
- KT-CT-13042: Multiple supply points not supported by this booking adapter.
- KT-CT-13045: Failed to update appointment assets.
- KT-CT-13047: Multiple supply points found.
- KT-CT-13048: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_ids.
- KT-CT-13049: Neither supplypointidentifiertomarketnamemapping nor supplypointinternal_ids provided.
- KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-13058: Reason approval details are required when the reason requires approval.
- KT-CT-13059: Emergency approval details are required when the emergency requires approval.
- KT-CT-13060: Reason approval details should not be provided when the reason does not require approval.
- KT-CT-13061: Emergency approval details should not be provided when the emergency does not require approval.
- KT-CT-13063: Failed to derive property for the given supply points.
- KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The input objects required to create a Request. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created request. |
Mutation
mutation CreateOnSiteJobsRequest($input: CreateOnSiteJobsRequestInputType!) {
createOnSiteJobsRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
onSiteJobsRequest {
...OnSiteJobsRequestTypeFragment
}
}
}Variables
{
"input": CreateOnSiteJobsRequestInputType
}Response
{
"data": {
"createOnSiteJobsRequest": {
"possibleErrors": [PossibleErrorType],
"onSiteJobsRequest": OnSiteJobsRequestType
}
}
}createOpportunityAndLead
URL:https://api.st.kraken.tech/v1/graphql/
Create an opportunity and lead with the provided details.
The possible errors that can be raised are:
- KT-CT-8912: Funnel not found.
- KT-CT-8919: Funnel initial stage not set.
- KT-CT-8930: Unable to parse address.
- KT-CT-8907: Lead not found.
- KT-CT-8901: Unable to create lead.
- KT-CT-8902: Unable to create lead.
- KT-CT-8935: National ID bad input.
- KT-CT-4121: Invalid phone number.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-9017: Consent type not found.
- KT-CT-8913: Organisation is not valid to be assigned.
- KT-CT-8936: Only one address is required to create an opportunity.
- KT-CT-8937: One or more Supply Points cannot be validated.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The unique number of the opportunity. |
| The date the opportunity was created. |
| The stage of the opportunity. |
| The code of the funnel. |
Mutation
mutation CreateOpportunityAndLead($input: CreateOpportunityAndLeadInput!) {
createOpportunityAndLead(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
opportunityNumber
dateOfCreation
stage
funnelCode
}
}Variables
{
"input": CreateOpportunityAndLeadInput
}Response
{
"data": {
"createOpportunityAndLead": {
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123",
"dateOfCreation": "2020-01-01T00:00:00.000Z",
"stage": "abc123",
"funnelCode": "abc123"
}
}
}createOpportunityFileAttachment
Type:CreateOpportunityFileAttachment
URL:https://api.st.kraken.tech/v1/graphql/
Creates an Opportunity File Attachment.
Arguments
| Name | Description |
|---|---|
Input to create an Opportunity File Attachment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the operation was successful. |
Mutation
mutation CreateOpportunityFileAttachment($input: CreateOpportunityFileAttachmentInput!) {
createOpportunityFileAttachment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
result
}
}Variables
{
"input": CreateOpportunityFileAttachmentInput
}Response
{
"data": {
"createOpportunityFileAttachment": {
"possibleErrors": [PossibleErrorType],
"result": "abc123"
}
}
}createOpportunityForLead
URL:https://api.st.kraken.tech/v1/graphql/
Create an opportunity for a lead with the provided details.
The possible errors that can be raised are:
- KT-CT-8912: Funnel not found.
- KT-CT-8919: Funnel initial stage not set.
- KT-CT-8907: Lead not found.
- KT-CT-8913: Organisation is not valid to be assigned.
- KT-CT-8924: Unable to create opportunity.
- KT-CT-8925: Unable to create opportunity.
- KT-CT-8926: Unable to create opportunity.
- KT-CT-8928: The funnel is not active and cannot be used to create this entity.
- KT-CT-8930: Unable to parse address.
- KT-CT-8936: Only one address is required to create an opportunity.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8937: One or more Supply Points cannot be validated.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an opportunity for a lead. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The unique number of the opportunity. |
| The date the opportunity was created. |
Mutation
mutation CreateOpportunityForLead($input: CreateOpportunityForLeadInput!) {
createOpportunityForLead(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
opportunityNumber
dateOfCreation
}
}Variables
{
"input": CreateOpportunityForLeadInput
}Response
{
"data": {
"createOpportunityForLead": {
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123",
"dateOfCreation": "2020-01-01T00:00:00.000Z"
}
}
}createOrUpdateLoyaltyCard
Type:CreateOrUpdateLoyaltyCardMutation
URL:https://api.st.kraken.tech/v1/graphql/
Create or update a loyalty card for the given account user.
The possible errors that can be raised are:
- KT-CT-5412: No account user exists with the given id.
- KT-CT-8610: Invalid data.
- KT-CT-8611: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating or updating a loyalty card. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Created or updated loyalty card. |
Mutation
mutation CreateOrUpdateLoyaltyCard($input: CreateOrUpdateLoyaltyCardInput!) {
createOrUpdateLoyaltyCard(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
loyaltyCard {
...LoyaltyCardTypeFragment
}
}
}Variables
{
"input": CreateOrUpdateLoyaltyCardInput
}Response
{
"data": {
"createOrUpdateLoyaltyCard": {
"possibleErrors": [PossibleErrorType],
"loyaltyCard": LoyaltyCardType
}
}
}createOrUpdateTimeSeriesEntries
Type:CreateOrUpdateTimeSeriesEntries!
URL:https://api.st.kraken.tech/v1/graphql/
Create or update time series entries.
The possible errors that can be raised are:
- KT-CT-12014: Time series not found.
- KT-CT-12015: Characteristics mismatch.
- KT-CT-12016: Conflicting time series entries.
- KT-CT-12017: Invalid time series entries period.
- KT-CT-12038: Invalid time series entries granularity.
- KT-CT-12040: Time series entries in use.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The time series input for time series entry creation or update. |
Return fields
| Name | Description |
|---|
Mutation
mutation CreateOrUpdateTimeSeriesEntries($input: CreateOrUpdateTimeSeriesEntriesInput!) {
createOrUpdateTimeSeriesEntries(input: $input) {
code
productCode
name
description
unit
periodSize
meta
variants {
...VariantProfileFragment
}
}
}Variables
{
"input": CreateOrUpdateTimeSeriesEntriesInput
}Response
{
"data": {
"createOrUpdateTimeSeriesEntries": {
"code": "abc123",
"productCode": "abc123",
"name": "abc123",
"description": "abc123",
"unit": "abc123",
"periodSize": "abc123",
"meta": {"key": "value"},
"variants": VariantProfile
}
}
}createPaymentActionIntent
Type:CreatePaymentActionIntent
URL:https://api.st.kraken.tech/v1/graphql/
Create a new payment action intent.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3980: Invalid ledger identifier.
- KT-CT-3981: Unauthorized.
- KT-CT-3982: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a payment action intent. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The action intent token. |
Mutation
mutation CreatePaymentActionIntent($input: CreatePaymentActionIntentInput!) {
createPaymentActionIntent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
}
}Variables
{
"input": CreatePaymentActionIntentInput
}Response
{
"data": {
"createPaymentActionIntent": {
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}
}
}createPortfolio
Type:CreatePortfolio
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to create a new Portfolio instance.
The possible errors that can be raised are:
- KT-CT-9402: Received an invalid brandCode.
- KT-CT-9401: Received an invalid operationsTeamId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a portfolio. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created portfolio. |
Mutation
mutation CreatePortfolio($input: CreatePortfolioInput) {
createPortfolio(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
portfolio {
...PortfolioTypeFragment
}
}
}Variables
{
"input": CreatePortfolioInput
}Response
{
"data": {
"createPortfolio": {
"possibleErrors": [PossibleErrorType],
"portfolio": PortfolioType
}
}
}createPortfolioUserRole
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to create a new portfolio user role. This will effectively link the user to the portfolio giving them all the permissions enabled for the specific role.
The possible errors that can be raised are:
- KT-CT-9403: Received an invalid portfolioId.
- KT-CT-9404: Received an invalid accountUserId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for connecting a user to a portfolio. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created role for a user in association with a portfolio. |
Mutation
mutation CreatePortfolioUserRole($input: CreatePortfolioUserRoleInput) {
createPortfolioUserRole(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
portfolioUserRole {
...PortfolioUserRoleTypeFragment
}
}
}Variables
{
"input": CreatePortfolioUserRoleInput
}Response
{
"data": {
"createPortfolioUserRole": {
"possibleErrors": [PossibleErrorType],
"portfolioUserRole": PortfolioUserRoleType
}
}
}createPostEvents
Type:CreatePostEvents
URL:https://api.st.kraken.tech/v1/graphql/
Create post delivery events from external vendors.
The possible errors that can be raised are:
- KT-CT-9907: Post events batch size exceeded.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Batch of post events to create. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Number of events successfully created. |
Mutation
mutation CreatePostEvents($input: CreatePostEventsInput!) {
createPostEvents(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
createdEventsCount
}
}Variables
{
"input": CreatePostEventsInput
}Response
{
"data": {
"createPostEvents": {
"possibleErrors": [PossibleErrorType],
"createdEventsCount": 1
}
}
}createProduct
Type:CreateProductOutput!
URL:https://api.st.kraken.tech/v1/graphql/
Create a new product.
The possible errors that can be raised are:
- KT-CT-12003: Specified product brand does not exist.
- KT-CT-12004: Invalid product tag type.
- KT-CT-12005: A selection of a terms and conditions type does not exist.
- KT-CT-12006: Provided product characteristic overrides are not in the correct format.
- KT-CT-12007: Unable to create product.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation CreateProduct($input: CreateProductInput!) {
createProduct(input: $input) {
product {
...SupplyProductTypeFragment
}
}
}Variables
{
"input": CreateProductInput
}Response
{
"data": {
"createProduct": {
"product": SupplyProductType
}
}
}createQuoteForAccount
URL:https://api.st.kraken.tech/v1/graphql/
Create a quote for switching product.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
- KT-CT-4616: Unable to create a quote.
- KT-CT-4631: Unable to quote for the chosen market.
- KT-CT-4645: No supply point found belonging to the account for the provided identifier.
- KT-CT-4924: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Returns a quote request. |
Mutation
mutation CreateQuoteForAccount($input: CreateQuoteForAccountInput!) {
createQuoteForAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
quoteRequest {
...MarketSupplyQuoteRequestTypeFragment
}
}
}Variables
{
"input": CreateQuoteForAccountInput
}Response
{
"data": {
"createQuoteForAccount": {
"possibleErrors": [PossibleErrorType],
"quoteRequest": MarketSupplyQuoteRequestType
}
}
}createReferral
Type:CreateReferral
URL:https://api.st.kraken.tech/v1/graphql/
Create an account referral using an email address, personal link or code.This is for customers to refer other customers so it only works with friend referrals and not partner referrals.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6710: Unable to create referral.
- KT-CT-6711: Accounts may not self-refer.
- KT-CT-6713: Referring and referred account brands do not match.
- KT-CT-6712: Invalid reference.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a referral. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The reward amount to be issued to the referred account, in smallest currency subunits. |
Mutation
mutation CreateReferral($input: CreateReferralInput!) {
createReferral(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
referredAccountRewardAmount
}
}Variables
{
"input": CreateReferralInput
}Response
{
"data": {
"createReferral": {
"possibleErrors": [PossibleErrorType],
"referredAccountRewardAmount": 1
}
}
}createReminder
Type:CreateReminder
URL:https://api.st.kraken.tech/v1/graphql/
Create an account reminder.
The possible errors that can be raised are:
- KT-CT-1401: Invalid data.
- KT-CT-1402: Unable to create account reminder.
- KT-CT-1403: Missing user or team assignee.
- KT-CT-1404: This reminder type is deprecated.
- KT-CT-1405: Both user and team assignee provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for creating an account reminder. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account reminder. |
Mutation
mutation CreateReminder($input: CreateReminderInput!) {
createReminder(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
reminder {
...ReminderFragment
}
}
}Variables
{
"input": CreateReminderInput
}Response
{
"data": {
"createReminder": {
"possibleErrors": [PossibleErrorType],
"reminder": Reminder
}
}
}createScheduledTransactions
Type:CreateScheduledTransactions
URL:https://api.st.kraken.tech/v1/graphql/
Create scheduled transactions.
The possible errors that can be raised are:
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3830: Invalid action.
- KT-CT-3831: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields to create scheduled transactions. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateScheduledTransactions($input: [CreateScheduledTransactionsInput]!) {
createScheduledTransactions(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
scheduledTransactions {
...ScheduledTransactionTypeFragment
}
}
}Variables
{
"input": CreateScheduledTransactionsInput
}Response
{
"data": {
"createScheduledTransactions": {
"possibleErrors": [PossibleErrorType],
"scheduledTransactions": [ScheduledTransactionType]
}
}
}createServiceOrder
Type:CreateServiceOrder
URL:https://api.st.kraken.tech/v1/graphql/
Create a service order for a property.
The possible errors that can be raised are:
- KT-GB-4237: Unauthorized.
- KT-GB-4238: Service order cannot be created as the property does not have an external reference identifier.
- KT-GB-4241: Invalid service order payload.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for apply for meter. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The service order that was created. |
Mutation
mutation CreateServiceOrder($input: CreateServiceOrderInput!) {
createServiceOrder(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
serviceOrder {
...ServiceOrderTypeFragment
}
}
}Variables
{
"input": CreateServiceOrderInput
}Response
{
"data": {
"createServiceOrder": {
"possibleErrors": [PossibleErrorType],
"serviceOrder": ServiceOrderType
}
}
}createShellAccount
Type:CreateShellAccountPayload
URL:https://api.st.kraken.tech/v1/graphql/
Create a shell/payment account.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| This must be a string-ified version of the JSON representation of RichAddressInput type. |
| For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY. |
| For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing. |
| Day to fixed bill on if billingperiodlength set. |
| Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1. |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Mutation
mutation CreateShellAccount($input: CreateShellAccountInput!) {
createShellAccount(input: $input) {
portfolioNumber
givenName
familyName
billingName
email
mobile
landline
brand
dateOfBirth
billingAddressLine1
billingAddressLine2
billingAddressLine3
billingAddressLine4
billingAddressLine5
billingPostcode
billingRichAddress
billingPeriodLength
billingPeriodMultiplier
billingPeriodDay
billingPeriodMonth
isBusinessAccount
companyName
companyNumber
businessType
password
passwordUpdateToken
urn
errors {
...ErrorTypeFragment
}
account {
...AccountInterfaceFragment
}
clientMutationId
}
}Variables
{
"input": CreateShellAccountInput
}Response
{
"data": {
"createShellAccount": {
"portfolioNumber": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"billingName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"brand": "abc123",
"dateOfBirth": "2020-01-01",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingPostcode": "abc123",
"billingRichAddress": "abc123",
"billingPeriodLength": "abc123",
"billingPeriodMultiplier": 1,
"billingPeriodDay": 1,
"billingPeriodMonth": 1,
"isBusinessAccount": true,
"companyName": "abc123",
"companyNumber": "abc123",
"businessType": "abc123",
"password": "abc123",
"passwordUpdateToken": "abc123",
"urn": "abc123",
"errors": [ErrorType],
"account": AccountInterface,
"clientMutationId": "abc123"
}
}
}createTimeSeriesPrices
URL:https://api.st.kraken.tech/v1/graphql/
Create time series prices.
The possible errors that can be raised are:
- KT-CT-12014: Time series not found.
- KT-CT-12015: Characteristics mismatch.
- KT-CT-12016: Conflicting time series entries.
- KT-CT-12017: Invalid time series entries period.
- KT-CT-12038: Invalid time series entries granularity.
- KT-CT-12040: Time series entries in use.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'createTimeSeriesPrices' field is deprecated.
Please use the 'createOrUpdateTimeSeriesEntries' mutation instead.
- Marked as deprecated on 2025-02-03.
- Scheduled for removal on or after 2025-03-01.
Arguments
| Name | Description |
|---|---|
| The time series input for price creation. |
Return fields
| Name | Description |
|---|
Mutation
mutation CreateTimeSeriesPrices($input: CreateTimeSeriesPricesInput!) {
createTimeSeriesPrices(input: $input) {
code
productCode
name
description
unit
periodSize
meta
variants {
...VariantProfileFragment
}
}
}Variables
{
"input": CreateTimeSeriesPricesInput
}Response
{
"data": {
"createTimeSeriesPrices": {
"code": "abc123",
"productCode": "abc123",
"name": "abc123",
"description": "abc123",
"unit": "abc123",
"periodSize": "abc123",
"meta": {"key": "value"},
"variants": VariantProfile
}
}
}createVacantProperty
Type:CreateVacantProperty
URL:https://api.st.kraken.tech/v1/graphql/
Create a vacant property.
The possible errors that can be raised are:
- KT-CT-6629: Invalid data.
- KT-CT-6630: Property already exists.
- KT-CT-6631: External property reference already exists.
- KT-CT-4410: Invalid postcode.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a vacant property. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new vacant property id. |
| The account number associated with the property. |
Mutation
mutation CreateVacantProperty($input: CreateVacantPropertyInput!) {
createVacantProperty(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
propertyId
accountNumber
}
}Variables
{
"input": CreateVacantPropertyInput
}Response
{
"data": {
"createVacantProperty": {
"possibleErrors": [PossibleErrorType],
"propertyId": "abc123",
"accountNumber": "abc123"
}
}
}deductLoyaltyPoints
Type:DeductLoyaltyPoints
URL:https://api.st.kraken.tech/v1/graphql/
Deduct the passed number of Loyalty Points from the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-5420: Unauthorized.
- KT-CT-9211: Invalid reason for loyalty points award.
- KT-CT-9219: Loyalty points user not found.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9221: Idempotency key already used on ledger entry.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for deducting Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were deducted. |
| The ledger entry for the deducted loyalty points. |
Mutation
mutation DeductLoyaltyPoints($input: DeductLoyaltyPointsInput!) {
deductLoyaltyPoints(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsDeducted
ledgerEntry {
...LoyaltyPointLedgerEntryTypeFragment
}
}
}Variables
{
"input": DeductLoyaltyPointsInput
}Response
{
"data": {
"deductLoyaltyPoints": {
"possibleErrors": [PossibleErrorType],
"pointsDeducted": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}
}
}deleteAccountReference
URL:https://api.st.kraken.tech/v1/graphql/
Delete an account reference.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8312: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for removing an account reference. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation DeleteAccountReference($input: DeleteAccountReferenceInput!) {
deleteAccountReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReference {
...DeleteAccountReferenceTypeFragment
}
}
}Variables
{
"input": DeleteAccountReferenceInput
}Response
{
"data": {
"deleteAccountReference": {
"possibleErrors": [PossibleErrorType],
"accountReference": DeleteAccountReferenceType
}
}
}deleteMfaDevice
Type:DeleteMfaDevice
URL:https://api.st.kraken.tech/v1/graphql/
Delete MFA Device for user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1154: Unable to delete MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for deleting an existing multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the MFA device has been successfully deleted. |
Mutation
mutation DeleteMfaDevice($input: DeleteMfaDeviceInputType!) {
deleteMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceDeleted
}
}Variables
{
"input": DeleteMfaDeviceInputType
}Response
{
"data": {
"deleteMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}
}
}deletePropertyDescendants
Type:DeletePropertyDescendants
URL:https://api.st.kraken.tech/v1/graphql/
Delete all descendants of a property in a hierarchy.
This permanently deletes all descendant nodes (children, grandchildren, etc.) but keeps the property node itself in the hierarchy. This operation is idempotent - if the property is not in the hierarchy or has no descendants, it will succeed without error.
The possible errors that can be raised are:
- KT-CT-6622: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for deleting descendants from a property. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The property whose descendants were deleted. |
Mutation
mutation DeletePropertyDescendants($input: DeletePropertyDescendantsInput!) {
deletePropertyDescendants(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
property {
...PropertyTypeFragment
}
}
}Variables
{
"input": DeletePropertyDescendantsInput
}Response
{
"data": {
"deletePropertyDescendants": {
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}
}
}deletePushNotificationBinding
Type:DeletePushNotificationBinding
URL:https://api.st.kraken.tech/v1/graphql/
Delete a device token used for push notifications.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-5411: Invalid token or no push notification binding found for the given account user.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for deleting a push notification binding. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation DeletePushNotificationBinding($input: DeletePushNotificationBindingInput!) {
deletePushNotificationBinding(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
status
}
}Variables
{
"input": DeletePushNotificationBindingInput
}Response
{
"data": {
"deletePushNotificationBinding": {
"possibleErrors": [PossibleErrorType],
"status": "SUCCESSFUL"
}
}
}endContributionAgreement
URL:https://api.st.kraken.tech/v1/graphql/
End a contribution agreement for an account.
The possible errors that can be raised are:
- KT-CT-9603: Unable to find contribution agreement.
- KT-CT-4123: Unauthorized.
- KT-CT-9604: Unable to end contribution agreement.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for ending a contribution agreement on an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created contribution agreement. |
Mutation
mutation EndContributionAgreement($input: EndContributionAgreementInput!) {
endContributionAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
contributionAgreement {
...ContributionAgreementTypeFragment
}
}
}Variables
{
"input": EndContributionAgreementInput
}Response
{
"data": {
"endContributionAgreement": {
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
}
}enqueueInboundCall
Type:EnqueueInboundCall
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11803: Unable to enqueue the call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The call that was enqueued. |
Mutation
mutation EnqueueInboundCall($input: EnqueueInboundCallInput!) {
enqueueInboundCall(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
call {
...InboundCallTypeFragment
}
}
}Variables
{
"input": EnqueueInboundCallInput
}Response
{
"data": {
"enqueueInboundCall": {
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
}
}enqueueInboundCallForCallback
Type:EnqueueInboundCallForCallback
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11803: Unable to enqueue the call.
- KT-CT-11811: Callback requests are disabled.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The call that was enqueued. |
Mutation
mutation EnqueueInboundCallForCallback($input: EnqueueInboundCallInput!) {
enqueueInboundCallForCallback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
call {
...InboundCallTypeFragment
}
}
}Variables
{
"input": EnqueueInboundCallInput
}Response
{
"data": {
"enqueueInboundCallForCallback": {
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
}
}enrollAccountInLoyaltyProgram
Type:EnrollAccountInLoyaltyProgram
URL:https://api.st.kraken.tech/v1/graphql/
Enroll users account in Loyalty program.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9213: ineligible loyalty points enrollment.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The account number to enroll in the loyalty program. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Outcome of the loyalty points campaign enrollment. |
Mutation
mutation EnrollAccountInLoyaltyProgram($input: EnrollAccountInLoyaltyProgramInput!) {
enrollAccountInLoyaltyProgram(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
outcome {
...EnrollAccountInLoyaltyProgramOutcomeFragment
}
}
}Variables
{
"input": EnrollAccountInLoyaltyProgramInput
}Response
{
"data": {
"enrollAccountInLoyaltyProgram": {
"possibleErrors": [PossibleErrorType],
"outcome": EnrollAccountInLoyaltyProgramOutcome
}
}
}enrollment
Type:EnrollmentInitiated!
URL:https://api.st.kraken.tech/v1/graphql/
Initiate an enrollment for an account and a set of supply points.
The possible errors that can be raised are:
- KT-CT-1602: Serializer validation error.
- KT-CT-4410: Invalid postcode.
- KT-CT-4412: The supplied address is not valid.
- KT-CT-4501: Unauthorized.
- KT-CT-7719: Session not found.
- KT-CT-10312: Mutation not enabled in this environment.
- KT-CT-10313: Failed to enroll account.
- KT-CT-10314: This supply point is already on supply.
- KT-CT-10315: Unable to begin enrollment journey due to invalid data.
- KT-CT-6622: Unauthorized.
- KT-CT-10340: House move enrollment is not enabled.
- KT-CT-10302: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The Enrollment Input data for the Join Supplier. |
Return fields
| Name | Description |
|---|
Mutation
mutation Enrollment($input: EnrollmentInput!) {
enrollment(input: $input) {
enrollmentProcesses {
... on JoinSupplierProcessType {
...JoinSupplierProcessTypeFragment
}
... on OccupyPropertyProcessType {
...OccupyPropertyProcessTypeFragment
}
}
message
}
}Variables
{
"input": EnrollmentInput
}Response
{
"data": {
"enrollment": {
"enrollmentProcesses": JoinSupplierProcessType,
"message": "abc123"
}
}
}exchangeMeter
Type:ExchangeMeter
URL:https://api.st.kraken.tech/v1/graphql/
Exchange meter for a property.
The possible errors that can be raised are:
- KT-GB-11001: Could not validate meter.
- KT-GB-11002: Unable to exchange meter.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for meter exchange. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly installed meter. |
Mutation
mutation ExchangeMeter($input: ExchangeMeterInputType!) {
exchangeMeter(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
meter {
...WaterMeterTypeFragment
}
}
}Variables
{
"input": ExchangeMeterInputType
}Response
{
"data": {
"exchangeMeter": {
"possibleErrors": [PossibleErrorType],
"meter": WaterMeterType
}
}
}fetchGeneratePaymentFingerprint
Type:FetchGeneratePaymentFingerprint
URL:https://api.st.kraken.tech/v1/graphql/
Fetch or generate payment fingerprint from vendor.
The possible errors that can be raised are:
- KT-CT-12101: Payment instruction not found.
- KT-CT-12102: Payment vendor not supported.
- KT-CT-12103: Missing payment metadata from vendor.
- KT-CT-12104: Unable to fetch or generate payment fingerprint.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Fetched or generated fingerprint from vendor. |
| Vendor name. |
Mutation
mutation FetchGeneratePaymentFingerprint($input: FetchGeneratePaymentFingerprintInput!) {
fetchGeneratePaymentFingerprint(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
fingerprint
vendor
}
}Variables
{
"input": FetchGeneratePaymentFingerprintInput
}Response
{
"data": {
"fetchGeneratePaymentFingerprint": {
"possibleErrors": [PossibleErrorType],
"fingerprint": "abc123",
"vendor": "abc123"
}
}
}fetchPreSignedLinkForOpportunityAttachment
Type:FetchPreSignedLinkForOpportunityAttachment
URL:https://api.st.kraken.tech/v1/graphql/
Fetch a pre-signed link for an opportunity file attachment.
The possible errors that can be raised are:
- KT-CT-8933: Opportunity file attachment not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for fetching a pre-signed link for an opportunity file attachment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The opportunity file attachment with pre-signed URL. |
Mutation
mutation FetchPreSignedLinkForOpportunityAttachment($input: FetchPreSignedLinkForOpportunityAttachmentInput!) {
fetchPreSignedLinkForOpportunityAttachment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
opportunityFileAttachment {
...OpportunityFileAttachmentFragment
}
}
}Variables
{
"input": FetchPreSignedLinkForOpportunityAttachmentInput
}Response
{
"data": {
"fetchPreSignedLinkForOpportunityAttachment": {
"possibleErrors": [PossibleErrorType],
"opportunityFileAttachment": OpportunityFileAttachment
}
}
}forceReauthentication
URL:https://api.st.kraken.tech/v1/graphql/
Force users of Kraken Tokens and refresh tokens issued to the viewer to reauthenticate.
Calling this mutation will cause all Kraken Tokens and refresh tokens issued to the authenticated viewer before the mutation was called to become invalid.
Arguments
| Name | Description |
|---|---|
| Input object argument to the force-reauthentication mutation. |
Return fields
| Name | Description |
|---|---|
| Reports whether the mutation applied successfully. Should always be 'true'. |
| The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid. |
Mutation
mutation ForceReauthentication($input: ForceReauthenticationInput!) {
forceReauthentication(input: $input) {
tokensInvalidated
effectiveAt
}
}Variables
{
"input": ForceReauthenticationInput
}Response
{
"data": {
"forceReauthentication": {
"tokensInvalidated": true,
"effectiveAt": "2020-01-01T00:00:00.000Z"
}
}
}generateAffiliatesAudioRecordingPreSignedUrl
Type:GenerateAffiliatesAudioRecordingPreSignedUrl!
URL:https://api.st.kraken.tech/v1/graphql/
Generate a pre signed url for uploading a file for use with affiliates.
Arguments
| Name | Description |
|---|---|
Input fields for creating a pre-signed URL for uploading an audio file to S3. |
Return fields
| Name | Description |
|---|
Mutation
mutation GenerateAffiliatesAudioRecordingPreSignedUrl($input: GenerateAffiliatesAudioRecordingPreSignedUrlInput!) {
generateAffiliatesAudioRecordingPreSignedUrl(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
affiliatesAudioRecordingPreSignedUrl {
...AffiliateAudioRecordingPresignedPostTypeFragment
}
}
}Variables
{
"input": GenerateAffiliatesAudioRecordingPreSignedUrlInput
}Response
{
"data": {
"generateAffiliatesAudioRecordingPreSignedUrl": {
"possibleErrors": [PossibleErrorType],
"affiliatesAudioRecordingPreSignedUrl": AffiliateAudioRecordingPresignedPostType
}
}
}generateInkPresignedUrl
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7620: Channel not supported.
- KT-CT-7618: Unable to process message.
- KT-CT-7624: Error when generating the presigned URL.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| A presigned URL for the user to upload to the quarantine bucket. |
| The key for the item. |
| Presigned post fields required to upload the file. |
Mutation
mutation GenerateInkPresignedUrl($input: GenerateInkPresignedUrlInput) {
generateInkPresignedUrl(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
uploadUrl
key
fields
}
}Variables
{
"input": GenerateInkPresignedUrlInput
}Response
{
"data": {
"generateInkPresignedUrl": {
"possibleErrors": [PossibleErrorType],
"uploadUrl": "abc123",
"key": "abc123",
"fields": {"key": "value"}
}
}
}generateLeadsFileAttachmentDownloadPreSignedUrl
Type:GenerateLeadsFileAttachmentDownloadPreSignedUrl
URL:https://api.st.kraken.tech/v1/graphql/
Generate a pre-signed URL for downloading a leads attachment file.
The possible errors that can be raised are:
- KT-CT-8933: Opportunity file attachment not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a pre-signed URL for downloading a lead file attachment from S3. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Pre-signed S3 URL for downloading the leads file attachment. |
Mutation
mutation GenerateLeadsFileAttachmentDownloadPreSignedUrl($input: GenerateLeadsFileAttachmentDownloadPreSignedUrlInput!) {
generateLeadsFileAttachmentDownloadPreSignedUrl(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
leadsFileAttachmentDownloadPreSignedUrl {
...LeadsFileAttachmentDownloadPresignedUrlTypeFragment
}
}
}Variables
{
"input": GenerateLeadsFileAttachmentDownloadPreSignedUrlInput
}Response
{
"data": {
"generateLeadsFileAttachmentDownloadPreSignedUrl": {
"possibleErrors": [PossibleErrorType],
"leadsFileAttachmentDownloadPreSignedUrl": LeadsFileAttachmentDownloadPresignedUrlType
}
}
}generateLeadsFileAttachmentPreSignedUrl
Type:GenerateLeadsFileAttachmentsPreSignedUrl
URL:https://api.st.kraken.tech/v1/graphql/
Generate a pre signed url for uploading a leads attachment file.
Arguments
| Name | Description |
|---|---|
Input fields for creating a pre-signed URL for uploading a lead file attachment file to S3. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Input fields required to generate a presigned S3 post for leads file attachment. |
Mutation
mutation GenerateLeadsFileAttachmentPreSignedUrl($input: GenerateLeadsFileAttachmentPreSignedUrlInput!) {
generateLeadsFileAttachmentPreSignedUrl(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
leadsFileAttachmentPreSignedUrl {
...LeadsFileAttachmentPresignedPostTypeFragment
}
}
}Variables
{
"input": GenerateLeadsFileAttachmentPreSignedUrlInput
}Response
{
"data": {
"generateLeadsFileAttachmentPreSignedUrl": {
"possibleErrors": [PossibleErrorType],
"leadsFileAttachmentPreSignedUrl": LeadsFileAttachmentPresignedPostType
}
}
}generatePreSignedToken
URL:https://api.st.kraken.tech/v1/graphql/
Generate a pre-signed token with a set expiry time.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1120: The Kraken Token has expired.
- KT-CT-1131: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| |
| The number of days that the token will be available for authentication (From now on). |
| Define (and limit) the scope of the token. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| |
| |
|
Mutation
mutation GeneratePreSignedToken(
$email: String!,
$numberOfDaysAllowed: Int!,
$scope: PreSignedTokenScope!
) {
generatePreSignedToken(
email: $email,
numberOfDaysAllowed: $numberOfDaysAllowed,
scope: $scope
) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
tokenExpiryDatetime
scope
}
}Variables
{
"email": "abc123",
"numberOfDaysAllowed": 1,
"scope": "SUBMIT_METER_READINGS"
}Response
{
"data": {
"generatePreSignedToken": {
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"tokenExpiryDatetime": "2020-01-01T00:00:00.000Z",
"scope": "SUBMIT_METER_READINGS"
}
}
}getEmbeddedSecretForNewPaymentInstruction
Type:GetEmbeddedSecretForNewPaymentInstruction
URL:https://api.st.kraken.tech/v1/graphql/
Get the client secret needed to create a new payment instruction using an embedded form.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for getting the client secret for an embedded new card payment method form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation GetEmbeddedSecretForNewPaymentInstruction($input: GetEmbeddedSecretForNewPaymentInstructionInput!) {
getEmbeddedSecretForNewPaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
secretKey
}
}Variables
{
"input": GetEmbeddedSecretForNewPaymentInstructionInput
}Response
{
"data": {
"getEmbeddedSecretForNewPaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
}
}getEmbeddedSecretForNewPaymentInstructionWithoutAccount
Type:GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
URL:https://api.st.kraken.tech/v1/graphql/
Get the client secret needed to create a new payment instruction using an embedded form without tying it to a customer.
Arguments
| Name | Description |
|---|---|
| Input fields for getting the client secret for an embedded new card payment method form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The client secret needed to create a new stored payment instruction. |
Mutation
mutation GetEmbeddedSecretForNewPaymentInstructionWithoutAccount($input: GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!) {
getEmbeddedSecretForNewPaymentInstructionWithoutAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
secretKey
}
}Variables
Response
{
"data": {
"getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
}
}getHostedUrlForNewPaymentInstruction
Type:GetHostedUrlForNewPaymentInstruction
URL:https://api.st.kraken.tech/v1/graphql/
Get the external URL where the user can set up a payment instruction.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for getting the external URL for setting up a payment instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| URL at which payment instruction can be set up. |
Mutation
mutation GetHostedUrlForNewPaymentInstruction($input: GetHostedUrlForNewPaymentInstructionInput!) {
getHostedUrlForNewPaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
url
}
}Variables
{
"input": GetHostedUrlForNewPaymentInstructionInput
}Response
{
"data": {
"getHostedUrlForNewPaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"url": "abc123"
}
}
}getOrCreateAgreement
Type:GetOrCreateAgreement
URL:https://api.st.kraken.tech/v1/graphql/
Get an existing agreement or create a new one if it doesn't exist.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-4910: No product exists with the given input.
- KT-CT-1503: Agreement validto date must be later than validfrom date.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1511: Cannot create overlapping agreement.
- KT-CT-1512: Account type does not support agreements.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for getting or creating an agreement. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Indicates whether a new agreement was created (true) or an existing agreement was returned (false). |
| The agreement that was retrieved or created. |
Mutation
mutation GetOrCreateAgreement($input: CreateAgreementInput!) {
getOrCreateAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
created
agreement {
...CommonAgreementTypeFragment
}
}
}Variables
{
"input": CreateAgreementInput
}Response
{
"data": {
"getOrCreateAgreement": {
"possibleErrors": [PossibleErrorType],
"created": true,
"agreement": CommonAgreementType
}
}
}grantUserAccessToBusiness
Type:GrantUserAccessToBusiness
URL:https://api.st.kraken.tech/v1/graphql/
Grant user access to the business using the provided role.
The possible errors that can be raised are:
- KT-CT-5463: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-13501: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation GrantUserAccessToBusiness($input: GrantUserAccessToBusinessInput!) {
grantUserAccessToBusiness(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": GrantUserAccessToBusinessInput
}Response
{
"data": {
"grantUserAccessToBusiness": {
"possibleErrors": [PossibleErrorType]
}
}
}guestOneTimeAccess
Type:GuestOneTimeAccess
URL:https://api.st.kraken.tech/v1/graphql/
Send a pre-signed token email for one time access to a non-login journey.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The user's email address obfuscated. |
Mutation
mutation GuestOneTimeAccess($input: GuestOneTimeAccessInput!) {
guestOneTimeAccess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
email
}
}Variables
{
"input": GuestOneTimeAccessInput
}Response
{
"data": {
"guestOneTimeAccess": {
"possibleErrors": [PossibleErrorType],
"email": "abc123"
}
}
}initializeAccount
URL:https://api.st.kraken.tech/v1/graphql/
Initialize account for sign up. Returns the existing account if matching datafound for the provided input, otherwise creates a new account.
The possible errors that can be raised are:
- KT-CT-10324: Mutation not enabled in this environment.
- KT-CT-10325: Input data has invalid format.
- KT-CT-10326: An error occurred when trying to initialize the account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation InitializeAccount($input: BaseInitializeAccountInput!) {
initializeAccount(input: $input) {
isNewAccount
accountNumber
}
}Variables
{
"input": BaseInitializeAccountInput
}Response
{
"data": {
"initializeAccount": {
"isNewAccount": true,
"accountNumber": "abc123"
}
}
}initializeUser
URL:https://api.st.kraken.tech/v1/graphql/
Initialize user for sign up. Returns an existing user if matching datafound for the provided input, otherwise creates a new one.
The possible errors that can be raised are:
- KT-CT-10327: Mutation not enabled in this environment.
- KT-CT-10328: Input data has invalid format.
- KT-CT-10329: An error occurred when trying to initialize the user.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation InitializeUser($input: BaseInitializeUserInput!) {
initializeUser(input: $input) {
isNewUser
userNumber
}
}Variables
{
"input": BaseInitializeUserInput
}Response
{
"data": {
"initializeUser": {
"isNewUser": true,
"userNumber": "abc123"
}
}
}initiateHostedStandalonePayment
Type:InitiateHostedStandalonePayment
URL:https://api.st.kraken.tech/v1/graphql/
Initiate a standalone payment and return the url where the customer can complete it.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-3957: No collection method provided.
- KT-CT-3958: Provide either ledger ID or ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for initiating a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The details required to refer to and complete a hosted payment. |
Mutation
mutation InitiateHostedStandalonePayment($input: InitiateHostedStandalonePaymentInput!) {
initiateHostedStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...InitiateHostedStandalonePaymentOutputFragment
}
}
}Variables
{
"input": InitiateHostedStandalonePaymentInput
}Response
{
"data": {
"initiateHostedStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": InitiateHostedStandalonePaymentOutput
}
}
}initiateProductSwitch
URL:https://api.st.kraken.tech/v1/graphql/
Do a product switch for a user.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4619: Quote with given code not found.
- KT-CT-4624: Unable to accept the given product code.
- KT-CT-4924: Unauthorized.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-4640: Unable to get market or client params from quoted product.
- KT-CT-4627: No products are available for this quote.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Instigate a product switch for a specific supply point given a valid product and account number. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The selected product for a specific product switch. |
| The date at which the product switch becomes effective. |
Mutation
mutation InitiateProductSwitch($input: InitiateProductSwitchInput!) {
initiateProductSwitch(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
productCode
switchDate
}
}Variables
{
"input": InitiateProductSwitchInput
}Response
{
"data": {
"initiateProductSwitch": {
"possibleErrors": [PossibleErrorType],
"productCode": "abc123",
"switchDate": "2020-01-01"
}
}
}initiateStandalonePayment
Type:InitiateStandalonePayment
URL:https://api.st.kraken.tech/v1/graphql/
Initiate a standalone payment and return the client secret required to complete it.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for initiating a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InitiateStandalonePayment($input: InitiateStandalonePaymentInput!) {
initiateStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...InitiateStandalonePaymentOutputFragment
}
}
}Variables
{
"input": InitiateStandalonePaymentInput
}Response
{
"data": {
"initiateStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": InitiateStandalonePaymentOutput
}
}
}insertUserPsrRecords
Type:InsertUserPSRRecords
URL:https://api.st.kraken.tech/v1/graphql/
Insert special circumstance priority services for the user. This mutation replaces all the active PSR records with the given input. Make sure to include all existing PSR records for the user if you do not intend to deactivate any records.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-GB-5415: The requested PSR record type is not valid.
- KT-GB-5411: Failed to update special circumstance record.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
List of input fields for a user's Priority Service Records (PSR). |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| List of special circumstance records for the user. |
Mutation
mutation InsertUserPsrRecords($input: [SpecialCircumstanceRecordInput]!) {
insertUserPsrRecords(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
records {
...SpecialCircumstanceRecordTypeFragment
}
}
}Variables
{
"input": SpecialCircumstanceRecordInput
}Response
{
"data": {
"insertUserPsrRecords": {
"possibleErrors": [PossibleErrorType],
"records": [SpecialCircumstanceRecordType]
}
}
}installAdditionalMeter
URL:https://api.st.kraken.tech/v1/graphql/
Install an additional meter on a property.
The possible errors that can be raised are:
- KT-GB-11001: Could not validate meter.
- KT-GB-11003: Unable to install meter.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for meter installation. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly installed meter. |
Mutation
mutation InstallAdditionalMeter($input: InstallAdditionalMeterInputType!) {
installAdditionalMeter(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
meter {
...WaterMeterTypeFragment
}
}
}Variables
{
"input": InstallAdditionalMeterInputType
}Response
{
"data": {
"installAdditionalMeter": {
"possibleErrors": [PossibleErrorType],
"meter": WaterMeterType
}
}
}installMeter
Type:InstallMeter
URL:https://api.st.kraken.tech/v1/graphql/
Install meter on an unmetered property.
The possible errors that can be raised are:
- KT-GB-11001: Could not validate meter.
- KT-GB-11003: Unable to install meter.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for meter installation. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly installed meter. |
Mutation
mutation InstallMeter($input: InstallMeterInputType!) {
installMeter(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
meter {
...WaterMeterTypeFragment
}
}
}Variables
{
"input": InstallMeterInputType
}Response
{
"data": {
"installMeter": {
"possibleErrors": [PossibleErrorType],
"meter": WaterMeterType
}
}
}instigateContractTermination
Type:ContractTerminationInstigated!
URL:https://api.st.kraken.tech/v1/graphql/
Instigate a contract termination journey.
The possible errors that can be raised are:
- KT-CT-10003: Contract not found.
- KT-CT-10004: Supply loss process instigation has failed.
- KT-CT-10007: Unable to terminate contract.
- KT-CT-10008: The contract is currently undergoing an active journey.
- KT-CT-10013: Requested termination date is invalid.
- KT-CT-10014: The provided contract termination input data is invalid.
- KT-CT-10015: Supply point termination context is not serializable.
- KT-CT-10016: Error building contract termination engine.
- KT-CT-10022: Contract already terminated.
- KT-CT-10023: Contract is already revoked.
- KT-CT-10024: Contract already expired.
- KT-CT-10025: Contract has not started yet.
- KT-CT-10037: Contract notes feature is disabled.
- KT-CT-10038: Contract note reason not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation InstigateContractTermination($input: BaseInstigateContractTerminationInput!) {
instigateContractTermination(input: $input) {
message
}
}Variables
{
"input": BaseInstigateContractTerminationInput
}Response
{
"data": {
"instigateContractTermination": {
"message": "abc123"
}
}
}instigateContractVariation
Type:InstigateContractVariationOutput!
URL:https://api.st.kraken.tech/v1/graphql/
Instigate a contract variation journey.
The possible errors that can be raised are:
- KT-CT-10003: Contract not found.
- KT-CT-10008: The contract is currently undergoing an active journey.
- KT-CT-10011: Unable to vary contract terms.
- KT-CT-10033: Unable to save term.
- KT-CT-10012: Contract variation implies breach.
- KT-CT-10034: Unknown contract journey type.
- KT-CT-10035: Cannot process a non-active contract journey.
- KT-CT-10036: The contract journey manager is not found.
- KT-CT-10037: Contract notes feature is disabled.
- KT-CT-10038: Contract note reason not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'instigateContractVariation' field is deprecated.
This is a legacy mutation. The varyContractTerms should be used instead.
- Marked as deprecated on 2026-03-05.
- Scheduled for removal on or after 2026-04-11.
Mutation
mutation InstigateContractVariation($input: InstigateContractVariationInput!) {
instigateContractVariation(input: $input) {
contract {
...ContractFragment
}
}
}Variables
{
"input": InstigateContractVariationInput
}Response
{
"data": {
"instigateContractVariation": {
"contract": Contract
}
}
}instigateLeaveSupplier
URL:https://api.st.kraken.tech/v1/graphql/
Instigate a leave supplier process or update an existing process.
The possible errors that can be raised are:
- KT-CT-10304: Mutation not enabled in this environment.
- KT-CT-4501: Unauthorized.
- KT-CT-10301: Unable to instigate leave supplier process.
- KT-CT-10330: Unsupported leave supplier type.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation InstigateLeaveSupplier($input: LeaveSupplierInput!) {
instigateLeaveSupplier(input: $input) {
number
leaveSupplierProcessId
message
}
}Variables
{
"input": LeaveSupplierInput
}Response
{
"data": {
"instigateLeaveSupplier": {
"number": "abc123",
"leaveSupplierProcessId": "abc123",
"message": "abc123"
}
}
}invalidatePaymentInstruction
Type:InvalidatePaymentInstruction
URL:https://api.st.kraken.tech/v1/graphql/
Invalidate a payment instruction.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-3926: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for invalidating a payment instruction from an embedded form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidatePaymentInstruction($input: InvalidatePaymentInstructionInput!) {
invalidatePaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
instruction {
...InvalidatePaymentInstructionOutputFragment
}
}
}Variables
{
"input": InvalidatePaymentInstructionInput
}Response
{
"data": {
"invalidatePaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"instruction": InvalidatePaymentInstructionOutput
}
}
}invalidatePreSignedToken
URL:https://api.st.kraken.tech/v1/graphql/
Invalidate a previously-issued pre-signed token.
The possible errors that can be raised are:
- KT-CT-1129: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidatePreSignedToken($input: InvalidatePreSignedTokenInput!) {
invalidatePreSignedToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token {
...PreSignedTokenFragment
}
}
}Variables
{
"input": InvalidatePreSignedTokenInput
}Response
{
"data": {
"invalidatePreSignedToken": {
"possibleErrors": [PossibleErrorType],
"token": PreSignedToken
}
}
}invalidatePreSignedTokensForUser
Type:InvalidatePreSignedTokensForUser
URL:https://api.st.kraken.tech/v1/graphql/
Invalidate pre-signed tokens issued to a particular user.
The possible errors that can be raised are:
- KT-CT-1129: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidatePreSignedTokensForUser($input: InvalidatePreSignedTokensForUserInput!) {
invalidatePreSignedTokensForUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
tokens {
...PreSignedTokenFragment
}
}
}Variables
{
"input": InvalidatePreSignedTokensForUserInput
}Response
{
"data": {
"invalidatePreSignedTokensForUser": {
"possibleErrors": [PossibleErrorType],
"tokens": [PreSignedToken]
}
}
}invalidateRefreshToken
URL:https://api.st.kraken.tech/v1/graphql/
Invalidate a previously-issued refresh token.
The possible errors that can be raised are:
- KT-CT-1130: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidateRefreshToken($input: InvalidateRefreshTokenInput!) {
invalidateRefreshToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token {
...RefreshTokenFragment
}
}
}Variables
{
"input": InvalidateRefreshTokenInput
}Response
{
"data": {
"invalidateRefreshToken": {
"possibleErrors": [PossibleErrorType],
"token": RefreshToken
}
}
}invalidateRefreshTokensForUser
Type:InvalidateRefreshTokensForUser
URL:https://api.st.kraken.tech/v1/graphql/
Invalidate refresh tokens issued to a particular user.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidateRefreshTokensForUser($input: InvalidateRefreshTokensForUserInput!) {
invalidateRefreshTokensForUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
tokens {
...RefreshTokenFragment
}
}
}Variables
{
"input": InvalidateRefreshTokensForUserInput
}Response
{
"data": {
"invalidateRefreshTokensForUser": {
"possibleErrors": [PossibleErrorType],
"tokens": [RefreshToken]
}
}
}joinSupplierAcceptTermsAndConditions
Type:JoinSupplierAcceptTermsAndConditions
URL:https://api.st.kraken.tech/v1/graphql/
Accept terms and conditions for a join supplier process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4501: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Indicator that the mutation has completed successfully. |
Mutation
mutation JoinSupplierAcceptTermsAndConditions($input: JoinSupplierAcceptTermsAndConditionsInput!) {
joinSupplierAcceptTermsAndConditions(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": JoinSupplierAcceptTermsAndConditionsInput
}Response
{
"data": {
"joinSupplierAcceptTermsAndConditions": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}legacyProcessOrder
Type:LegacyProcessOrderOutput!
URL:https://api.st.kraken.tech/v1/graphql/
Process an Order (legacy)
The possible errors that can be raised are:
- KT-CT-1605: Invalid input.
- KT-CT-7701: The affiliate organisation was not found.
- KT-CT-8906: Opportunity not found.
- KT-CT-12701: Invalid sales channel code.
- KT-CT-13102: Invalid order data.
- KT-CT-13103: Unprocessable order.
- KT-CT-13104: Conflicting order.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation LegacyProcessOrder($input: LegacyProcessOrderInput!) {
legacyProcessOrder(input: $input) {
status
identifier
resources {
...LegacyOrderResourceFragment
}
}
}Variables
{
"input": LegacyProcessOrderInput
}Response
{
"data": {
"legacyProcessOrder": {
"status": "PENDING",
"identifier": NonEmptyString,
"resources": [LegacyOrderResource]
}
}
}linkAccountToBusiness
URL:https://api.st.kraken.tech/v1/graphql/
Link an account to a business.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11104: Business role already allocated.
- KT-CT-11105: Business role already allocated.
- KT-CT-11106: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for linking an account to a business. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The business the account was linked to. |
Mutation
mutation LinkAccountToBusiness($input: LinkAccountToBusinessInput!) {
linkAccountToBusiness(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
business {
...BusinessTypeFragment
}
}
}Variables
{
"input": LinkAccountToBusinessInput
}Response
{
"data": {
"linkAccountToBusiness": {
"possibleErrors": [PossibleErrorType],
"business": BusinessType
}
}
}linkUserToLine
URL:https://api.st.kraken.tech/v1/graphql/
Link an account user and line user together.
Arguments
| Name | Description |
|---|---|
| Input fields to link an account user with LINE. |
Return fields
| Name | Description |
|---|
Mutation
mutation LinkUserToLine($input: LinkUserToLineInput!) {
linkUserToLine(input: $input) {
... on LineLinkRedirectResponse {
...LineLinkRedirectResponseFragment
}
... on LinkTokenNotFound {
...LinkTokenNotFoundFragment
}
... on AlreadyLinkedError {
...AlreadyLinkedErrorFragment
}
}
}Variables
{
"input": LinkUserToLineInput
}Response
{
"data": {
"linkUserToLine": LineLinkRedirectResponse
}
}markPrintBatchAsProcessed
Type:MarkPrintBatchAsProcessed!
URL:https://api.st.kraken.tech/v1/graphql/
Mark the print batch as processed.
The possible errors that can be raised are:
- KT-CT-9011: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation MarkPrintBatchAsProcessed($printBatchId: ID!) {
markPrintBatchAsProcessed(printBatchId: $printBatchId) {
possibleErrors {
...PossibleErrorTypeFragment
}
printBatch {
...PrintBatchTypeFragment
}
}
}Variables
{
"printBatchId": "abc123"
}Response
{
"data": {
"markPrintBatchAsProcessed": {
"possibleErrors": [PossibleErrorType],
"printBatch": PrintBatchType
}
}
}masqueradeAuthentication
URL:https://api.st.kraken.tech/v1/graphql/
Provide a temporary token to get an auth token. This is intended to allow support users to view customer data through the brand interface.
Arguments
| Name | Description |
|---|---|
| The masquerade token issued by the support site. |
| The ID of the AccountUser to masquerade as. |
Return fields
| Name | Description |
|---|---|
| A Kraken Token that can be used to authenticate to the API, masquerading as the desired user. |
| A list of any errors that occurred while running this mutation. |
Mutation
mutation MasqueradeAuthentication(
$masqueradeToken: String!,
$userId: String!
) {
masqueradeAuthentication(
masqueradeToken: $masqueradeToken,
userId: $userId
) {
token
errors {
...ErrorTypeFragment
}
}
}Variables
{
"masqueradeToken": "abc123",
"userId": "abc123"
}Response
{
"data": {
"masqueradeAuthentication": {
"token": "abc123",
"errors": [ErrorType]
}
}
}modifyMeter
Type:ModifyMeter
URL:https://api.st.kraken.tech/v1/graphql/
Modify meter details
The possible errors that can be raised are:
- KT-GB-11001: Could not validate meter.
- KT-GB-11005: Could not modify meter.
- KT-GB-11006: Water meter cannot be found with the provided identifiers.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for modifying a meters' details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The meter to modify. |
Mutation
mutation ModifyMeter($input: ModifyMeterInput!) {
modifyMeter(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
meter {
...WaterMeterTypeFragment
}
}
}Variables
{
"input": ModifyMeterInput
}Response
{
"data": {
"modifyMeter": {
"possibleErrors": [PossibleErrorType],
"meter": WaterMeterType
}
}
}moveInCreateCustomer
Type:MoveInCreateCustomer
URL:https://api.st.kraken.tech/v1/graphql/
Create customer as part of a move in process.
The possible errors that can be raised are:
- KT-GB-5416: Invalid data.
- KT-GB-6610: We're sorry but we can't communicate with our address database right now to look up your address. Please try again.
- KT-CT-5450: Password is invalid.
- KT-CT-4111: Unable to use given email address.
- KT-CT-10337: Prechecks have failed.
- KT-CT-6632: Property is assessed.
- KT-GB-6637: Unable to process the move-in due to billing issues.
- KT-CT-6425: Unable to create the meter reading.
- KT-CT-4642: Unable to quote for the provided supply point.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Customer's personal details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The account number we created. |
Mutation
mutation MoveInCreateCustomer($input: MoveInCreateCustomerInput!) {
moveInCreateCustomer(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountNumber
}
}Variables
{
"input": MoveInCreateCustomerInput
}Response
{
"data": {
"moveInCreateCustomer": {
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123"
}
}
}moveOut
Type:MoveOut
URL:https://api.st.kraken.tech/v1/graphql/
Trigger a move out of a property for an account.Optionally provide details of the next property to trigger a move within.
The possible errors that can be raised are:
- KT-GB-6628: Invalid data.
- KT-GB-6610: We're sorry but we can't communicate with our address database right now to look up your address. Please try again.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for triggering move out process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The account initiating the move out. |
Mutation
mutation MoveOut($input: MoveOutInput!) {
moveOut(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": MoveOutInput
}Response
{
"data": {
"moveOut": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}moveToBucket
Type:MoveToBucket
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for moving a conversation to a bucket. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The conversation that was moved to the bucket. |
Mutation
mutation MoveToBucket($input: MoveToBucketInput) {
moveToBucket(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
conversation {
...InkConversationFragment
}
}
}Variables
{
"input": MoveToBucketInput
}Response
{
"data": {
"moveToBucket": {
"possibleErrors": [PossibleErrorType],
"conversation": InkConversation
}
}
}Arguments
| Name | Description |
|---|---|
| The name of the operations team group to select from. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The next operations team assigned in round-robin sequence. |
| Location routing information for the selected team. |
| All operations team groups that the selected team belongs to. |
| All inferred routing attributes for team, location, and team groups (e.g., ['OPERATIONSGROUP.TEAM.TeamA', 'OPERATIONSGROUP.LOCATION.London', 'OPERATIONSGROUP.GROUP_B']). Recommended for IVR usage. |
Mutation
mutation NextOperationsTeamRoundRobin($teamGroupName: String!) {
nextOperationsTeamRoundRobin(teamGroupName: $teamGroupName) {
possibleErrors {
...PossibleErrorTypeFragment
}
team {
...TeamFragment
}
location {
...TeamLocationFragment
}
teamGroups {
...TeamGroupFragment
}
allInferredRoutingAttributes
}
}Variables
{
"teamGroupName": "abc123"
}Response
{
"data": {
"nextOperationsTeamRoundRobin": {
"possibleErrors": [PossibleErrorType],
"team": Team,
"location": TeamLocation,
"teamGroups": TeamGroup,
"allInferredRoutingAttributes": "abc123"
}
}
}obtainKrakenToken
URL:https://api.st.kraken.tech/v1/graphql/
Create a Kraken Token (JWT) for authentication.
Provide the required input fields to obtain the token.
The token should be used as the Authorization header for any authenticated requests.
The possible errors that can be raised are:
- KT-CT-1135: Invalid data.
- KT-CT-1134: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields that can be used to obtain a Json Web Token (JWT) for authentication to the API. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The Kraken Token. Can be used in the |
| The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the |
| A token that can be used in a subsequent call to |
| A Unix timestamp representing the point in time at which the refresh token will expire. |
Mutation
mutation ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
obtainKrakenToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
payload
refreshToken
refreshExpiresIn
}
}Variables
{
"input": ObtainJSONWebTokenInput
}Response
{
"data": {
"obtainKrakenToken": {
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "abc123",
"refreshExpiresIn": 1
}
}
}obtainLongLivedRefreshToken
Type:ObtainLongLivedRefreshToken
URL:https://api.st.kraken.tech/v1/graphql/
For authorized third-party organizations only.
The possible errors that can be raised are:
- KT-CT-1120: The Kraken Token has expired.
- KT-CT-1121: Please use Kraken Token to issue long-lived refresh tokens.
- KT-CT-1132: Unauthorized.
- KT-CT-1122: Long-lived refresh tokens can only be issued for account users.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for obtaining a long-lived refresh token to extend the expiry claim of a Kraken token. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| |
|
Mutation
mutation ObtainLongLivedRefreshToken($input: ObtainLongLivedRefreshTokenInput!) {
obtainLongLivedRefreshToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
refreshToken
refreshExpiresIn
}
}Variables
{
"input": ObtainLongLivedRefreshTokenInput
}Response
{
"data": {
"obtainLongLivedRefreshToken": {
"possibleErrors": [PossibleErrorType],
"refreshToken": "abc123",
"refreshExpiresIn": 1
}
}
}pauseCollectionProcess
URL:https://api.st.kraken.tech/v1/graphql/
Pause a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11214: Invalid pause length for collection process.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Details for pausing a collection process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Collection process pause output. |
Mutation
mutation PauseCollectionProcess($input: PauseCollectionProcessInput!) {
pauseCollectionProcess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessPaused {
...PauseCollectionProcessOutputFragment
}
}
}Variables
{
"input": PauseCollectionProcessInput
}Response
{
"data": {
"pauseCollectionProcess": {
"possibleErrors": [PossibleErrorType],
"collectionProcessPaused": PauseCollectionProcessOutput
}
}
}pauseDunning
Type:PauseDunning
URL:https://api.st.kraken.tech/v1/graphql/
Pause the dunning process for an account.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11301: Account not in a dunning process for the given path name.
- KT-CT-11302: No active dunning process found.
- KT-CT-11303: Multiple active dunning processes found.
- KT-CT-11304: Dunning pause process failed verifying the dates.
- KT-CT-11305: Pausing the dunning process failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for pausing a dunning process for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the pause has been successfully created. |
Mutation
mutation PauseDunning($input: PauseDunningInputType!) {
pauseDunning(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pauseCreated
}
}Variables
{
"input": PauseDunningInputType
}Response
{
"data": {
"pauseDunning": {
"possibleErrors": [PossibleErrorType],
"pauseCreated": true
}
}
}payoutReferralForAccount
URL:https://api.st.kraken.tech/v1/graphql/
Pay out a referral reward for an account.
The possible errors that can be raised are:
- KT-CT-6712: Invalid reference.
- KT-CT-6723: Unauthorized.
- KT-CT-6730: Referral cannot be paid out.
- KT-CT-6731: The account is unrelated to the referral.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for paying out a referral for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The result of the payout. |
Mutation
mutation PayoutReferralForAccount($input: PayoutReferralForAccountInput!) {
payoutReferralForAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payoutResult {
...PayoutReferralForAccountResultTypeFragment
}
}
}Variables
{
"input": PayoutReferralForAccountInput
}Response
{
"data": {
"payoutReferralForAccount": {
"possibleErrors": [PossibleErrorType],
"payoutResult": PayoutReferralForAccountResultType
}
}
}postCredit
Type:PostCredit
URL:https://api.st.kraken.tech/v1/graphql/
Post credit to a ledger.
The possible errors that can be raised are:
- KT-CT-5316: Invalid data.
- KT-CT-5311: The credit reason with the requested code is deprecated.
- KT-CT-5312: The credit reason with the requested code does not exist.
- KT-CT-5313: An error occurred whilst posting the credit.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for posting a credit. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Posted account credit. |
Mutation
mutation PostCredit($input: PostCreditInput!) {
postCredit(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
credit {
...CreditFragment
}
}
}Variables
{
"input": PostCreditInput
}Response
{
"data": {
"postCredit": {
"possibleErrors": [PossibleErrorType],
"credit": Credit
}
}
}prepareAccount
URL:https://api.st.kraken.tech/v1/graphql/
Prepare account for sign up. Returns the existing account and/or user if matching datafound for the provided input, otherwise creates a new account and account user.
The possible errors that can be raised are:
- KT-CT-10303: Mutation not enabled in this environment.
- KT-CT-10316: Input data has invalid format.
- KT-CT-10317: An error occured when trying to prepare the account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation PrepareAccount($input: PrepareAccountInput!) {
prepareAccount(input: $input) {
isNewAccount
accountNumber
isNewUser
userId
userNumber
}
}Variables
{
"input": PrepareAccountInput
}Response
{
"data": {
"prepareAccount": {
"isNewAccount": true,
"accountNumber": "abc123",
"isNewUser": true,
"userId": "abc123",
"userNumber": "abc123"
}
}
}publishApprovalApprovedEvent
Type:PublishApprovalApprovedEvent
URL:https://api.st.kraken.tech/v1/graphql/
Publish an approval approved external event.
The possible errors that can be raised are:
- KT-CT-14501: Invalid event parameters.
- KT-CT-14502: Invalid input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for publishing an approval approved event. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The ID of the created approval approved event. |
Mutation
mutation PublishApprovalApprovedEvent($input: PublishApprovalApprovedEventInput!) {
publishApprovalApprovedEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
eventId
}
}Variables
{
"input": PublishApprovalApprovedEventInput
}Response
{
"data": {
"publishApprovalApprovedEvent": {
"possibleErrors": [PossibleErrorType],
"eventId": "abc123"
}
}
}publishTransactionalMessagingExternalTrigger
Type:PublishTransactionalMessagingExternalTrigger
URL:https://api.st.kraken.tech/v1/graphql/
Publish an externally defined transactional messaging trigger.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-5421: Account user not found.
- KT-CT-9901: Invalid trigger type code.
- KT-CT-9905: Top-level context fields are missing.
- KT-CT-9906: Template variables do not match the defined schema.
- KT-CT-9908: Invalid recipient information.
- KT-CT-9909: Invalid recipient information.
- KT-CT-9910: Invalid input field combination.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields to publish an external transactional messaging trigger. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The trigger that has been published. |
Mutation
mutation PublishTransactionalMessagingExternalTrigger($input: PublishTransactionalMessagingExternalTriggerInput!) {
publishTransactionalMessagingExternalTrigger(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
trigger {
...TriggerFragment
}
}
}Variables
{
"input": PublishTransactionalMessagingExternalTriggerInput
}Response
{
"data": {
"publishTransactionalMessagingExternalTrigger": {
"possibleErrors": [PossibleErrorType],
"trigger": Trigger
}
}
}publishTransactionalMessagingTrigger
Type:PublishTransactionalMessagingTrigger
URL:https://api.st.kraken.tech/v1/graphql/
Publish a trigger within the transactional messaging service.
The possible errors that can be raised are:
- KT-CT-9901: Invalid trigger type code.
- KT-CT-9902: Invalid trigger type params.
- KT-CT-9903: Trigger type cannot be published externally.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields to publish a transactional messaging trigger. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The trigger that has been published. |
Mutation
mutation PublishTransactionalMessagingTrigger($input: PublishTransactionalMessagingTriggerInput!) {
publishTransactionalMessagingTrigger(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
trigger {
...TriggerFragment
}
}
}Variables
{
"input": PublishTransactionalMessagingTriggerInput
}Response
{
"data": {
"publishTransactionalMessagingTrigger": {
"possibleErrors": [PossibleErrorType],
"trigger": Trigger
}
}
}Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| The voucher purchase created from the mutation. |
Mutation
mutation PurchaseVoucher($input: PurchaseVoucherInput!) {
purchaseVoucher(input: $input) {
voucherPurchase {
...VoucherPurchaseTypeFragment
}
}
}Variables
{
"input": PurchaseVoucherInput
}Response
{
"data": {
"purchaseVoucher": {
"voucherPurchase": VoucherPurchaseType
}
}
}reactivateCollectionProcessRecord
Type:ReactivateCollectionProcessRecord
URL:https://api.st.kraken.tech/v1/graphql/
Reactivate a Collection Process Record that was previously activated.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11217: Invalid collection process record status for reactivation.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input variables needed for reactivating a collection process record. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The reactivated collection process record. |
Mutation
mutation ReactivateCollectionProcessRecord($input: ReactivateCollectionProcessRecordInputType!) {
reactivateCollectionProcessRecord(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessReactivated {
...ReactivateCollectionProcessRecordOutputTypeFragment
}
}
}Variables
{
"input": ReactivateCollectionProcessRecordInputType
}Response
{
"data": {
"reactivateCollectionProcessRecord": {
"possibleErrors": [PossibleErrorType],
"collectionProcessReactivated": ReactivateCollectionProcessRecordOutputType
}
}
}reconsentToPSR
Type:ReconsentToPSR
URL:https://api.st.kraken.tech/v1/graphql/
Re-consent to PSR for the authenticated user. Uses the user's current PSR record details; no form data is required.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-GB-5419: PSR re-consent is not available for this user.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| List of special circumstance records for the user. |
Mutation
mutation ReconsentToPSR {
reconsentToPSR {
possibleErrors {
...PossibleErrorTypeFragment
}
records {
...SpecialCircumstanceRecordTypeFragment
}
}
}Response
{
"data": {
"reconsentToPSR": {
"possibleErrors": [PossibleErrorType],
"records": [SpecialCircumstanceRecordType]
}
}
}recordDepositAgreementAccepted
Type:RecordDepositAgreementAccepted
URL:https://api.st.kraken.tech/v1/graphql/
Record the customer's acceptance of a deposit agreement.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation RecordDepositAgreementAccepted($input: DepositAgreementInput!) {
recordDepositAgreementAccepted(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
isRecorded
}
}Variables
{
"input": DepositAgreementInput
}Response
{
"data": {
"recordDepositAgreementAccepted": {
"possibleErrors": [PossibleErrorType],
"isRecorded": true
}
}
}recordFailedPayment
Type:RecordFailedPayment
URL:https://api.st.kraken.tech/v1/graphql/
Record one or more failed payments.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
- KT-CT-3985: Received both token and options for action intent.
- KT-CT-3986: Received neither token nor options for action intent.
- KT-CT-3987: Invalid payment method type code.
- KT-CT-3988: Number of items in list exceeds maximum value.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Details about the failed payments. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The unique identifier of the notice batch created from the input. |
Mutation
mutation RecordFailedPayment($input: RecordFailedPaymentInput!) {
recordFailedPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
noticeBatchIdentifier
}
}Variables
{
"input": RecordFailedPaymentInput
}Response
{
"data": {
"recordFailedPayment": {
"possibleErrors": [PossibleErrorType],
"noticeBatchIdentifier": "abc123"
}
}
}recordPendingPayment
Type:RecordPendingPayment
URL:https://api.st.kraken.tech/v1/graphql/
Record one or more pending payments.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
- KT-CT-3985: Received both token and options for action intent.
- KT-CT-3986: Received neither token nor options for action intent.
- KT-CT-3987: Invalid payment method type code.
- KT-CT-3988: Number of items in list exceeds maximum value.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Details about the pending payments. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The unique identifier of the notice batch created from the input. |
Mutation
mutation RecordPendingPayment($input: RecordPendingPaymentInput!) {
recordPendingPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
noticeBatchIdentifier
}
}Variables
{
"input": RecordPendingPaymentInput
}Response
{
"data": {
"recordPendingPayment": {
"possibleErrors": [PossibleErrorType],
"noticeBatchIdentifier": "abc123"
}
}
}recordSuccessfulPayment
URL:https://api.st.kraken.tech/v1/graphql/
Record one or more successful payments.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
- KT-CT-3985: Received both token and options for action intent.
- KT-CT-3986: Received neither token nor options for action intent.
- KT-CT-3987: Invalid payment method type code.
- KT-CT-3988: Number of items in list exceeds maximum value.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Details about the successful payments. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The unique identifier of the notice batch created from the input. |
Mutation
mutation RecordSuccessfulPayment($input: RecordSuccessfulPaymentInput!) {
recordSuccessfulPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
noticeBatchIdentifier
}
}Variables
{
"input": RecordSuccessfulPaymentInput
}Response
{
"data": {
"recordSuccessfulPayment": {
"possibleErrors": [PossibleErrorType],
"noticeBatchIdentifier": "abc123"
}
}
}redeemLoyaltyPointsForAccountCredit
Type:RedeemLoyaltyPointsForAccountCredit
URL:https://api.st.kraken.tech/v1/graphql/
Redeem the passed number of Loyalty Points as account credit.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9201: No Loyalty Point ledger found for the user.
- KT-CT-9202: Loyalty Points adapter not configured.
- KT-CT-9203: No ledger entries for the ledger.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9206: Indivisible points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for redeeming Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were redeemed. |
Mutation
mutation RedeemLoyaltyPointsForAccountCredit($input: RedeemLoyaltyPointsInput!) {
redeemLoyaltyPointsForAccountCredit(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsRedeemed
}
}Variables
{
"input": RedeemLoyaltyPointsInput
}Response
{
"data": {
"redeemLoyaltyPointsForAccountCredit": {
"possibleErrors": [PossibleErrorType],
"pointsRedeemed": 1
}
}
}redeemReferralClaimCode
URL:https://api.st.kraken.tech/v1/graphql/
Redeem the referral claim code from certain referral scheme.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6724: Referral claim code not found.
- KT-CT-6725: Referral claim code redeeming error.
- KT-CT-6726: Referral claim code has already been redeemed.
- KT-CT-6727: Referral claim code is not available.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for redeeming referral code. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether or not the request was successful. |
Mutation
mutation RedeemReferralClaimCode($input: RedeemReferralClaimCodeInput!) {
redeemReferralClaimCode(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": RedeemReferralClaimCodeInput
}Response
{
"data": {
"redeemReferralClaimCode": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}refundPayment
Type:RefundPayment
URL:https://api.st.kraken.tech/v1/graphql/
Refund a cleared payment.
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-3929: The payment is not in a refundable state.
- KT-CT-3933: Refund amount greater than payment amount.
- KT-CT-3937: Payment not eligible for refund.
- KT-CT-3938: Partial refund not allowed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for refunding a payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The repayment for the requested refund. |
Mutation
mutation RefundPayment($input: RefundPaymentInput!) {
refundPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repayment {
...AccountRepaymentTypeFragment
}
}
}Variables
{
"input": RefundPaymentInput
}Response
{
"data": {
"refundPayment": {
"possibleErrors": [PossibleErrorType],
"repayment": AccountRepaymentType
}
}
}regenerateSecretKey
Type:RegenerateSecretKey
URL:https://api.st.kraken.tech/v1/graphql/
Regenerate the live secret key for the authenticated user.
Return fields
| Name | Description |
|---|---|
| The generated key value, which is only ever available once (here). |
| The currently authenticated user. |
Mutation
mutation RegenerateSecretKey {
regenerateSecretKey {
key
viewer {
...AccountUserTypeFragment
}
}
}Response
{
"data": {
"regenerateSecretKey": {
"key": "abc123",
"viewer": AccountUserType
}
}
}registerCustomerAsset
URL:https://api.st.kraken.tech/v1/graphql/
Register a new customer asset for an account
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-14602: Customer asset already exists.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for registering a device. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The registered customer asset. |
Mutation
mutation RegisterCustomerAsset($input: RegisterCustomerAssetInput!) {
registerCustomerAsset(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
customerAsset {
...CustomerAssetTypeFragment
}
}
}Variables
{
"input": RegisterCustomerAssetInput
}Response
{
"data": {
"registerCustomerAsset": {
"possibleErrors": [PossibleErrorType],
"customerAsset": CustomerAssetType
}
}
}registerEmail
Type:RegisterEmail
URL:https://api.st.kraken.tech/v1/graphql/
Registers the email of a user in the registration journey who currently has a placeholder (blackhole) email.
The possible errors that can be raised are:
- KT-GB-5412: User already has an email address.
- KT-GB-5413: Invalid inputs for updating a blackhole email.
- KT-CT-1133: Unable to request password reset email.
- KT-CT-10006: Account not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for assigning email address to an account user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of an account user who has updated their blackhole email. |
Mutation
mutation RegisterEmail($input: RegisterEmailInput!) {
registerEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
blackholeEmailAccountUser {
...BlackholeEmailAccountUserTypeFragment
}
}
}Variables
{
"input": RegisterEmailInput
}Response
{
"data": {
"registerEmail": {
"possibleErrors": [PossibleErrorType],
"blackholeEmailAccountUser": BlackholeEmailAccountUserType
}
}
}registerLeadFlowStatusEvent
Type:RegisterLeadFlowStatusEvent
URL:https://api.st.kraken.tech/v1/graphql/
Register a flow status event for a lead.
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for registering a flow status event for a Lead. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation RegisterLeadFlowStatusEvent($input: RegisterLeadFlowStatusEventInput!) {
registerLeadFlowStatusEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": RegisterLeadFlowStatusEventInput
}Response
{
"data": {
"registerLeadFlowStatusEvent": {
"possibleErrors": [PossibleErrorType]
}
}
}registerOpportunityFlowStatusEvent
Type:RegisterOpportunityFlowStatusEvent
URL:https://api.st.kraken.tech/v1/graphql/
Register a flow status event for an opportunity.
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for registering a flow status event for a opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation RegisterOpportunityFlowStatusEvent($input: RegisterOpportunityFlowStatusEventInput!) {
registerOpportunityFlowStatusEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": RegisterOpportunityFlowStatusEventInput
}Response
{
"data": {
"registerOpportunityFlowStatusEvent": {
"possibleErrors": [PossibleErrorType]
}
}
}registerPushNotificationBinding
Type:RegisterPushNotificationBinding
URL:https://api.st.kraken.tech/v1/graphql/
Register a device token to be used for push notifications for an app.
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
Input fields for creating an push notification binding. |
Return fields
| Name | Description |
|---|---|
|
Mutation
mutation RegisterPushNotificationBinding($input: RegisterPushNotificationBindingInput!) {
registerPushNotificationBinding(input: $input) {
pushNotificationBinding {
...PushNotificationBindingTypeFragment
}
}
}Variables
{
"input": RegisterPushNotificationBindingInput
}Response
{
"data": {
"registerPushNotificationBinding": {
"pushNotificationBinding": PushNotificationBindingType
}
}
}removeCampaignFromAccount
Type:RemoveCampaignFromAccount
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7424: Failed to remove campaign from account.
- KT-CT-7426: The account is not part of the given campaign.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for removing a campaign from an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the campaign was successfully removed from the account. |
Mutation
mutation RemoveCampaignFromAccount($input: RemoveCampaignFromAccountInput!) {
removeCampaignFromAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
campaignRemoved
}
}Variables
{
"input": RemoveCampaignFromAccountInput
}Response
{
"data": {
"removeCampaignFromAccount": {
"possibleErrors": [PossibleErrorType],
"campaignRemoved": true
}
}
}removeCampaignItems
Type:RemoveCampaignItems
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-11501: Voice campaign not found.
- KT-CT-11502: Cannot remove items from multiple campaigns at once.
- KT-CT-11505: Voice campaign item not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation RemoveCampaignItems($input: RemoveCampaignItemsInput!) {
removeCampaignItems(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
campaignItems {
...VoiceCampaignItemTypeFragment
}
}
}Variables
{
"input": RemoveCampaignItemsInput
}Response
{
"data": {
"removeCampaignItems": {
"possibleErrors": [PossibleErrorType],
"campaignItems": [VoiceCampaignItemType]
}
}
}removeItemsFromRiskList
URL:https://api.st.kraken.tech/v1/graphql/
Remove items from the risk list.
The possible errors that can be raised are:
- KT-CT-12106: Risk list item removal failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| A list of risk list items to remove. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| List of successfully removed risk identifiers. |
Mutation
mutation RemoveItemsFromRiskList($input: [RiskListItemInputType]!) {
removeItemsFromRiskList(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
riskIdentifiers {
...RiskListItemTypeFragment
}
}
}Variables
{
"input": RiskListItemInputType
}Response
{
"data": {
"removeItemsFromRiskList": {
"possibleErrors": [PossibleErrorType],
"riskIdentifiers": [RiskListItemType]
}
}
}removePropertyFromHierarchy
Type:RemovePropertyFromHierarchy
URL:https://api.st.kraken.tech/v1/graphql/
Remove a property from a hierarchy.
This operation is idempotent - if the property is not in the hierarchy, it will succeed without error. When a property is removed, its descendants are reparented to the removed property's parent. If removing a root node, its children become new root nodes.
The possible errors that can be raised are:
- KT-CT-6622: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for removing a property from a hierarchy. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The property that was removed from the hierarchy. |
Mutation
mutation RemovePropertyFromHierarchy($input: RemovePropertyFromHierarchyInput!) {
removePropertyFromHierarchy(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
property {
...PropertyTypeFragment
}
}
}Variables
{
"input": RemovePropertyFromHierarchyInput
}Response
{
"data": {
"removePropertyFromHierarchy": {
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}
}
}requestDoubleOptIn
Type:RequestDoubleOptIn
URL:https://api.st.kraken.tech/v1/graphql/
Request a double opt in
The possible errors that can be raised are:
- KT-CT-9019: Invalid input.
- KT-CT-9018: Account not found.
- KT-CT-1111: Unauthorized.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9023: Consent already accepted.
- KT-CT-1199: Too many requests.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The consent that was created or updated. |
Mutation
mutation RequestDoubleOptIn($input: DoubleOptInInput) {
requestDoubleOptIn(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
consent {
...ConsentTypeFragment
}
}
}Variables
{
"input": DoubleOptInInput
}Response
{
"data": {
"requestDoubleOptIn": {
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
}
}requestPasswordReset
Type:RequestPasswordResetOutputType
URL:https://api.st.kraken.tech/v1/graphql/
Provide the email address of an account user to send them an email with instructions on how to reset their password.
The possible errors that can be raised are:
- KT-CT-11331: Invalid input data.
- KT-CT-11332: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for requesting a password reset email. |
Return fields
| Name | Description |
|---|---|
| The email that requested a password reset email. |
| The number of the user that requested a password reset email. |
Mutation
mutation RequestPasswordReset($input: RequestPasswordResetInput!) {
requestPasswordReset(input: $input) {
email
userNumber
}
}Variables
{
"input": RequestPasswordResetInput
}Response
{
"data": {
"requestPasswordReset": {
"email": "abc123",
"userNumber": "abc123"
}
}
}requestPrintedBill
Type:RequestPrintedBill
URL:https://api.st.kraken.tech/v1/graphql/
Request an issued bill to be printed and (re)posted to billing address of the account.
The possible errors that can be raised are:
- KT-CT-3824: Unauthorized.
- KT-CT-9705: The billing document has not been issued.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields to request a printed bill. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the request was successful. |
Mutation
mutation RequestPrintedBill($input: RequestPrintedBillInput!) {
requestPrintedBill(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": RequestPrintedBillInput
}Response
{
"data": {
"requestPrintedBill": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}resetPassword
Type:ResetPasswordMutationPayload
URL:https://api.st.kraken.tech/v1/graphql/
Reset the password of an account user indicated by the userId to the value supplied.
Deprecated
The 'resetPassword' field is deprecated.
Please use `resetUserPassword` instead.
- Marked as deprecated on 2024-12-04.
- Scheduled for removal on or after 2025-06-01.
You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/81/
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
|
Mutation
mutation ResetPassword($input: ResetPasswordMutationInput!) {
resetPassword(input: $input) {
errors {
...SerializerFieldErrorsTypeFragment
}
clientMutationId
}
}Variables
{
"input": ResetPasswordMutationInput
}Response
{
"data": {
"resetPassword": {
"errors": [SerializerFieldErrorsType],
"clientMutationId": "abc123"
}
}
}resetUserPassword
URL:https://api.st.kraken.tech/v1/graphql/
Reset the password of an account user.
Raises KT-CT-5450 if password validation fails. Inspect the validationErrors extension to get the exact validation error:
json
{
"data": {"resetUserPassword": null},
"errors": [
{
"message": "Password is invalid.",
"path": ["resetUserPassword"],
"extensions": {
"errorType": "VALIDATION",
"errorCode": "KT-CT-5450",
"errorDescription": "Given password fails password policy requirements.",
"validationErrors": [
{
"code": "password_too_short",
"message": "This password is too short. It must contain at least 7 characters.",
"inputPath": ["input", "password"]
},
{
"code": "password_too_common",
"message": "This password is too common.",
"inputPath": ["input", "password"]
}
]
}
}
]
}
The validation error's code can be any of
- password_too_short
- password_too_common
- password_reused
- password_matches_current
- password_has_too_few_numeric_characters
- password_has_too_few_special_characters
- password_has_too_few_lowercase_characters
- password_has_too_few_uppercase_characters
- password_contains_account_number
- password_contains_part_of_email_address
The possible errors that can be raised are:
- KT-CT-4125: Unauthorized.
- KT-CT-1132: Unauthorized.
- KT-CT-5450: Password is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for resetting an account user's password. |
Return fields
| Name | Description |
|---|---|
| The ID of the user whose password was changed. |
| True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. |
| A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. |
| A list of codes of which password validation the new password failed against if applicable.
One of:
- Deprecated The 'failureCodes' field is deprecated. |
Mutation
mutation ResetUserPassword($input: ResetUserPasswordInput!) {
resetUserPassword(input: $input) {
userId
passwordUpdated
failureReasons
failureCodes
}
}Variables
{
"input": ResetUserPasswordInput
}Response
{
"data": {
"resetUserPassword": {
"userId": "abc123",
"passwordUpdated": true,
"failureReasons": ["abc123"],
"failureCodes": ["abc123"]
}
}
}resumeCollectionProcess
URL:https://api.st.kraken.tech/v1/graphql/
Resume a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11215: Unable to resume, collection process is not paused.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Details for resuming a collection process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Collection process resume output. |
Mutation
mutation ResumeCollectionProcess($input: ResumeCollectionProcessInput!) {
resumeCollectionProcess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessResumed {
...ResumeCollectionProcessOutputFragment
}
}
}Variables
{
"input": ResumeCollectionProcessInput
}Response
{
"data": {
"resumeCollectionProcess": {
"possibleErrors": [PossibleErrorType],
"collectionProcessResumed": ResumeCollectionProcessOutput
}
}
}reverseEnrollment
Type:EnrollmentReversed!
URL:https://api.st.kraken.tech/v1/graphql/
Reverse an enrollment (Join Supplier process).
The possible errors that can be raised are:
- KT-CT-10312: Mutation not enabled in this environment.
- KT-CT-10318: Enrollment process not found.
- KT-CT-10349: Enrollment process is not reversible.
- KT-CT-10350: Enrollment process can still be cancelled.
- KT-CT-10351: Enrollment process being cancelled cannot be reversed.
- KT-CT-10352: Market actions cannot be reversed for this enrollment process.
- KT-CT-10353: Failed to reverse enrollment process.
- KT-CT-10354: Enrollment reversal cut-off has passed.
- KT-CT-10355: Enrollment reversal is not allowed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The input required to reverse an enrollment. |
Return fields
| Name | Description |
|---|
Mutation
mutation ReverseEnrollment($input: ReverseEnrollmentInput!) {
reverseEnrollment(input: $input) {
message
enrollmentProcess {
... on JoinSupplierProcessType {
...JoinSupplierProcessTypeFragment
}
... on OccupyPropertyProcessType {
...OccupyPropertyProcessTypeFragment
}
}
}
}Variables
{
"input": ReverseEnrollmentInput
}Response
{
"data": {
"reverseEnrollment": {
"message": "abc123",
"enrollmentProcess": JoinSupplierProcessType
}
}
}reverseLeaveSupplier
URL:https://api.st.kraken.tech/v1/graphql/
Reverse a leave supplier process.
The possible errors that can be raised are:
- KT-CT-10304: Mutation not enabled in this environment.
- KT-CT-10302: Invalid data.
- KT-CT-10341: Leave supplier process is not reversible.
- KT-CT-10342: Leave supplier process can still be cancelled.
- KT-CT-10343: Leave supplier process being cancelled cannot be reversed.
- KT-CT-10344: Leave supplier reversal cut-off has passed.
- KT-CT-10345: Occupier leave with real join cannot be reversed.
- KT-CT-10346: Market action reversal is not supported for this leave supplier process.
- KT-CT-10347: Failed to reverse leave supplier process.
- KT-CT-10348: Leave supplier reversal is missing required dependencies.
- KT-CT-1607: Value cannot be empty.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation ReverseLeaveSupplier($input: ReverseLeaveSupplierInput!) {
reverseLeaveSupplier(input: $input) {
message
}
}Variables
{
"input": ReverseLeaveSupplierInput
}Response
{
"data": {
"reverseLeaveSupplier": {
"message": "abc123"
}
}
}revokeAgreement
Type:RevokeAgreement
URL:https://api.st.kraken.tech/v1/graphql/
Revoke an agreement.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-1501: Agreement not found.
- KT-CT-1502: Billed agreements cannot be revoked.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for revoking an agreement. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account responsible for the revoked agreement. |
Mutation
mutation RevokeAgreement($input: RevokeAgreementInput!) {
revokeAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": RevokeAgreementInput
}Response
{
"data": {
"revokeAgreement": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}revokeContract
URL:https://api.st.kraken.tech/v1/graphql/
Revoke an existing contract.
The possible errors that can be raised are:
- KT-CT-10003: Contract not found.
- KT-CT-10022: Contract already terminated.
- KT-CT-10023: Contract is already revoked.
- KT-CT-10024: Contract already expired.
- KT-CT-10032: Contract has already started.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation RevokeContract($input: RevokeContractInput!) {
revokeContract(input: $input) {
contract {
...ContractFragment
}
}
}Variables
{
"input": RevokeContractInput
}Response
{
"data": {
"revokeContract": {
"contract": Contract
}
}
}revokeUserAccessFromBusiness
Type:RevokeUserAccessFromBusiness
URL:https://api.st.kraken.tech/v1/graphql/
Revoke the selected role from the user for the business.
The possible errors that can be raised are:
- KT-CT-5463: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-13501: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation RevokeUserAccessFromBusiness($input: RevokeUserAccessFromBusinessInput!) {
revokeUserAccessFromBusiness(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": RevokeUserAccessFromBusinessInput
}Response
{
"data": {
"revokeUserAccessFromBusiness": {
"possibleErrors": [PossibleErrorType]
}
}
}runAgreementRollover
Type:RunAgreementRollover
URL:https://api.st.kraken.tech/v1/graphql/
Run an agreement rollover.
The possible errors that can be raised are:
- KT-CT-13705: Agreement rollover not found.
- KT-CT-13706: Agreement rollover has an invalid status for this operation.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for running an agreement rollover. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The executed agreement rollover. |
Mutation
mutation RunAgreementRollover($input: RunAgreementRolloverInput!) {
runAgreementRollover(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreementRollover {
...AgreementRolloverTypeFragment
}
}
}Variables
{
"input": RunAgreementRolloverInput
}Response
{
"data": {
"runAgreementRollover": {
"possibleErrors": [PossibleErrorType],
"agreementRollover": AgreementRolloverType
}
}
}scheduleQuoteFollowUp
URL:https://api.st.kraken.tech/v1/graphql/
Schedule a quote follow-up to the provided recipient.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4632: Invalid recipient information.
- KT-CT-4633: Mutation not enabled in this environment.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the message was scheduled successfully. |
Mutation
mutation ScheduleQuoteFollowUp($input: QuoteShareInput!) {
scheduleQuoteFollowUp(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": QuoteShareInput
}Response
{
"data": {
"scheduleQuoteFollowUp": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}selectProducts
Type:SelectProducts
URL:https://api.st.kraken.tech/v1/graphql/
Mark quoted products on a quote request as selected.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4634: Quoted product with given id not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4635: Missing a quoted product for at least one quoted supply point on the quote request.
- KT-CT-4636: Quoted product not linked to a product.
- KT-CT-4646: Attempted to select multiple products for the same quoted supply point.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether we successfully marked the chosen quoted products as selected. |
Mutation
mutation SelectProducts($input: SelectProductsInput!) {
selectProducts(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": SelectProductsInput
}Response
{
"data": {
"selectProducts": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}sendOfferQuoteSummary
URL:https://api.st.kraken.tech/v1/graphql/
Send an offer quote summary to all active account users.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-12407: The offer group does not contain an accepted offer.
- KT-CT-5518: Account user not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the triggering of the offer quote summary was successful. |
Mutation
mutation SendOfferQuoteSummary($input: OfferQuoteSummaryInput!) {
sendOfferQuoteSummary(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": OfferQuoteSummaryInput
}Response
{
"data": {
"sendOfferQuoteSummary": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}sendOneTimeLoginEmail
URL:https://api.st.kraken.tech/v1/graphql/
Send a pre-signed token email to log in to consumer site.
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The result of the operation. |
Mutation
mutation SendOneTimeLoginEmail($input: SendOneTimeLoginEmailInput!) {
sendOneTimeLoginEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
status
}
}Variables
{
"input": SendOneTimeLoginEmailInput
}Response
{
"data": {
"sendOneTimeLoginEmail": {
"possibleErrors": [PossibleErrorType],
"status": "abc123"
}
}
}sendPreSignedTokenEmail
URL:https://api.st.kraken.tech/v1/graphql/
Send a pre-signed token email to log in to consumer site.
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The result of the operation. |
Mutation
mutation SendPreSignedTokenEmail($input: SendOneTimeLoginEmailInput!) {
sendPreSignedTokenEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
status
}
}Variables
{
"input": SendOneTimeLoginEmailInput
}Response
{
"data": {
"sendPreSignedTokenEmail": {
"possibleErrors": [PossibleErrorType],
"status": "abc123"
}
}
}sendQuoteSummary
Type:SendQuoteSummary
URL:https://api.st.kraken.tech/v1/graphql/
Send a quote summary to the provided recipient.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-4632: Invalid recipient information.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the triggering of the quote summary was successful. |
Mutation
mutation SendQuoteSummary($input: QuoteShareInput!) {
sendQuoteSummary(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": QuoteShareInput
}Response
{
"data": {
"sendQuoteSummary": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}sendVerificationEmail
URL:https://api.st.kraken.tech/v1/graphql/
Verify user's email address.
The possible errors that can be raised are:
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| If the verification email was sent. |
Mutation
mutation SendVerificationEmail($input: SendVerificationEmailInput!) {
sendVerificationEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
verificationStatus
}
}Variables
{
"input": SendVerificationEmailInput
}Response
{
"data": {
"sendVerificationEmail": {
"possibleErrors": [PossibleErrorType],
"verificationStatus": true
}
}
}setLoyaltyPointsUser
Type:SetLoyaltyPointsUser
URL:https://api.st.kraken.tech/v1/graphql/
Set the Loyalty Point user for the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9214: Couldn't assign user loyalty points role.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for saving the Loyalty Points user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| ID of the new Loyalty Points user. |
Mutation
mutation SetLoyaltyPointsUser($input: SetLoyaltyPointsUserInput!) {
setLoyaltyPointsUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
newLoyaltyPointsUserId
}
}Variables
{
"input": SetLoyaltyPointsUserInput
}Response
{
"data": {
"setLoyaltyPointsUser": {
"possibleErrors": [PossibleErrorType],
"newLoyaltyPointsUserId": "abc123"
}
}
}setOpportunityOutcome
URL:https://api.st.kraken.tech/v1/graphql/
Update the opportunity outcome to mark the opportunity as won or lost.
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for setting the outcome of a opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Success message for now. |
Mutation
mutation SetOpportunityOutcome($input: SetOpportunityOutcomeInput!) {
setOpportunityOutcome(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
message
}
}Variables
{
"input": SetOpportunityOutcomeInput
}Response
{
"data": {
"setOpportunityOutcome": {
"possibleErrors": [PossibleErrorType],
"message": "abc123"
}
}
}setPaymentPreference
Type:SetPaymentPreference
URL:https://api.st.kraken.tech/v1/graphql/
Set a preference to collect payments from a specific payment method.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3967: Payment method is not valid.
- KT-CT-3968: Preference cannot be set this soon.
- KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation SetPaymentPreference($input: SetPaymentPreferenceInput!) {
setPaymentPreference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": SetPaymentPreferenceInput
}Response
{
"data": {
"setPaymentPreference": {
"possibleErrors": [PossibleErrorType]
}
}
}setUpDirectDebitInstruction
Type:SetUpDirectDebitInstruction
URL:https://api.st.kraken.tech/v1/graphql/
Set up a new direct debit instruction.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3940: Invalid data.
- KT-CT-5415: Account user not found.
- KT-CT-11103: Business not found.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating a new direct debit instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
setUpDirectDebitInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionInput
}Response
{
"data": {
"setUpDirectDebitInstruction": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}setUpDirectDebitInstructionForBusiness
Type:SetUpDirectDebitInstructionForBusiness
URL:https://api.st.kraken.tech/v1/graphql/
Set up a new direct debit instruction for a business.
The possible errors that can be raised are:
- KT-CT-3940: Invalid data.
- KT-CT-3956: Temporary error occurred.
- KT-CT-11107: Unauthorized.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating a new direct debit instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created direct debit instruction. |
Mutation
mutation SetUpDirectDebitInstructionForBusiness($input: SetUpDirectDebitInstructionForBusinessInput!) {
setUpDirectDebitInstructionForBusiness(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionForBusinessInput
}Response
{
"data": {
"setUpDirectDebitInstructionForBusiness": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}setUpDirectDebitInstructionFromStoredDetails
Type:SetUpDirectDebitInstructionFromStoredDetails
URL:https://api.st.kraken.tech/v1/graphql/
Set up a new direct debit instruction from stored details.
The possible errors that can be raised are:
- KT-CT-3956: Temporary error occurred.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-5415: Account user not found.
- KT-CT-11103: Business not found.
- KT-CT-4123: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating a new direct debit instruction from stored details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The payment instruction that was created from stored details. |
Mutation
mutation SetUpDirectDebitInstructionFromStoredDetails($input: SetUpDirectDebitInstructionFromStoredDetailsInput!) {
setUpDirectDebitInstructionFromStoredDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionFromStoredDetailsInput
}Response
{
"data": {
"setUpDirectDebitInstructionFromStoredDetails": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}shareGoodsQuote
Type:ShareGoodsQuote
URL:https://api.st.kraken.tech/v1/graphql/
Share a goods quote.
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-8203: Received an invalid quote code.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for sharing a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote shared. |
Mutation
mutation ShareGoodsQuote($input: ShareGoodsQuoteInput!) {
shareGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
share {
...GoodsQuoteShareFragment
}
}
}Variables
{
"input": ShareGoodsQuoteInput
}Response
{
"data": {
"shareGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"share": GoodsQuoteShare
}
}
}startCollectionProcess
URL:https://api.st.kraken.tech/v1/graphql/
Start a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11208: Invalid billing document identifier for collection process.
- KT-CT-11209: Collection process configuration does not have published version.
- KT-CT-11210: Active collection process for entity already exists.
- KT-CT-11211: Too many active collection processes for config.
- KT-CT-11212: Invalid collection process config code.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Details to start collection process for. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of collection process that has been started. |
Mutation
mutation StartCollectionProcess($input: StartCollectionProcessInput!) {
startCollectionProcess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessStarted {
...StartCollectionProcessOutputFragment
}
}
}Variables
{
"input": StartCollectionProcessInput
}Response
{
"data": {
"startCollectionProcess": {
"possibleErrors": [PossibleErrorType],
"collectionProcessStarted": StartCollectionProcessOutput
}
}
}startCustomerVerification
Type:StartCustomerVerification
URL:https://api.st.kraken.tech/v1/graphql/
Start the customer verification using the provided verification method.
The possible errors that can be raised are:
- KT-CT-1701: Brand does not exist.
- KT-CT-4194: Verification type not supported yet.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly created verification process. |
Mutation
mutation StartCustomerVerification($input: StartCustomerVerificationInput!) {
startCustomerVerification(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
verificationProcess {
...VerificationProcessFragment
}
}
}Variables
{
"input": StartCustomerVerificationInput
}Response
{
"data": {
"startCustomerVerification": {
"possibleErrors": [PossibleErrorType],
"verificationProcess": VerificationProcess
}
}
}startOnSiteJobsAppointmentBookingSession
Type:StartOnSiteJobsAppointmentBookingSession
URL:https://api.st.kraken.tech/v1/graphql/
Start the appointment booking process for an on-site jobs request.
The possible errors that can be raised are:
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13020: Could not identify agent from property.
- KT-CT-13021: Invalid job type.
- KT-CT-13022: Work category not found for job type.
- KT-CT-13023: Appointment booking checks failed.
- KT-CT-13024: Appointment booking checks returned warnings.
- KT-CT-13032: Request does not exist.
- KT-CT-13054: Appointment not found for rescheduling.
- KT-CT-13055: Appointment does not belong to the specified request.
- KT-CT-13056: Appointment cannot be rescheduled.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The appointment booking details. |
| The ID of an existing appointment to reschedule. If provided, this booking session will be used to reschedule the appointment instead of creating a new one. |
| Whether to override appointment booking check warnings. Defaults to False. |
| The ID of the request to book an appointment for. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The Kraken booking ID for the appointment booking session. |
Mutation
mutation StartOnSiteJobsAppointmentBookingSession(
$appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
$appointmentIdToReschedule: UUID,
$overrideAppointmentCheckWarnings: Boolean,
$requestId: UUID!
) {
startOnSiteJobsAppointmentBookingSession(
appointmentBookingDetails: $appointmentBookingDetails,
appointmentIdToReschedule: $appointmentIdToReschedule,
overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
requestId: $requestId
) {
possibleErrors {
...PossibleErrorTypeFragment
}
appointmentBookingSessionId
}
}Variables
{
"appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
"appointmentIdToReschedule": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"overrideAppointmentCheckWarnings": true,
"requestId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}Response
{
"data": {
"startOnSiteJobsAppointmentBookingSession": {
"possibleErrors": [PossibleErrorType],
"appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}
}
}stopAutomatedPayments
URL:https://api.st.kraken.tech/v1/graphql/
Set a preference to not collect automated payments.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3968: Preference cannot be set this soon.
- KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Mutation
mutation StopAutomatedPayments($input: StopAutomatedPaymentsInput!) {
stopAutomatedPayments(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
}
}Variables
{
"input": StopAutomatedPaymentsInput
}Response
{
"data": {
"stopAutomatedPayments": {
"possibleErrors": [PossibleErrorType]
}
}
}storeDirectDebitPaymentMethodDetails
Type:StoreDirectDebitPaymentMethodDetails
URL:https://api.st.kraken.tech/v1/graphql/
Store bank details with the vendor.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3940: Invalid data.
- KT-CT-3956: Temporary error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Store bank details with the vendor. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation StoreDirectDebitPaymentMethodDetails($input: StoreDirectDebitPaymentMethodDetailsInput!) {
storeDirectDebitPaymentMethodDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
storedPaymentMethodDetailsReference
}
}Variables
{
"input": StoreDirectDebitPaymentMethodDetailsInput
}Response
{
"data": {
"storeDirectDebitPaymentMethodDetails": {
"possibleErrors": [PossibleErrorType],
"storedPaymentMethodDetailsReference": "abc123"
}
}
}storePaymentInstruction
URL:https://api.st.kraken.tech/v1/graphql/
Store a new payment instruction created through the embedded process.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for storing a new payment instruction created through the embedded process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The stored payment instruction. |
Mutation
mutation StorePaymentInstruction($input: StorePaymentInstructionInput!) {
storePaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...PaymentInstructionTypeFragment
}
}
}Variables
{
"input": StorePaymentInstructionInput
}Response
{
"data": {
"storePaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType
}
}
}submitCustomerFeedback
URL:https://api.st.kraken.tech/v1/graphql/
Submit customer feedback.
The possible errors that can be raised are:
- KT-CT-5514: Unable to submit feedback.
- KT-CT-5511: The feedback_id should be provided for feedback source.
- KT-CT-5512: The feedback doesn't match the account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation SubmitCustomerFeedback($input: CustomerFeedbackInputType!) {
submitCustomerFeedback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
customerFeedback {
...CustomerFeedbackTypeFragment
}
}
}Variables
{
"input": CustomerFeedbackInputType
}Response
{
"data": {
"submitCustomerFeedback": {
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
}
}submitMeterReading
Type:SubmitMeterReading
URL:https://api.st.kraken.tech/v1/graphql/
Customer can submit a meter reading.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-GB-6414: Meter reading could not be updated. Input not valid.
- KT-CT-6422: Reading will be held.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for submitting a meter reading. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The submitted reading. |
Mutation
mutation SubmitMeterReading($input: SubmitMeterReadingInputType!) {
submitMeterReading(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
reading {
...ReadingTypeFragment
}
}
}Variables
{
"input": SubmitMeterReadingInputType
}Response
{
"data": {
"submitMeterReading": {
"possibleErrors": [PossibleErrorType],
"reading": ReadingType
}
}
}submitMeterReadings
Type:SubmitMeterReadings
URL:https://api.st.kraken.tech/v1/graphql/
Submit meter readings for one or more meters. Optionally, estimate readings for any active meters at the property that are not included in the input by setting estimateMissingReadings to true.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-GB-6414: Meter reading could not be updated. Input not valid.
- KT-CT-6422: Reading will be held.
- KT-GB-6416: Unable to estimate the reading for the given meter.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for submitting meter readings. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The submitted readings (and estimated readings if requested). |
Mutation
mutation SubmitMeterReadings($input: SubmitMeterReadingsInputType!) {
submitMeterReadings(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
readings {
...ReadingTypeFragment
}
}
}Variables
{
"input": SubmitMeterReadingsInputType
}Response
{
"data": {
"submitMeterReadings": {
"possibleErrors": [PossibleErrorType],
"readings": [ReadingType]
}
}
}submitRepaymentRequest
URL:https://api.st.kraken.tech/v1/graphql/
Submit a repayment request.
The possible errors that can be raised are:
- KT-CT-3823: Unauthorized.
- KT-CT-3978: The account cannot request repayments.
- KT-CT-1132: Unauthorized.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3823: Unauthorized.
- KT-CT-3926: Unauthorized.
- KT-CT-3927: Invalid Amount.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for requesting a repayment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly created repayment request. |
Mutation
mutation SubmitRepaymentRequest($input: RequestRepaymentInputType!) {
submitRepaymentRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentRequest {
...RequestRepaymentOutputTypeFragment
}
}
}Variables
{
"input": RequestRepaymentInputType
}Response
{
"data": {
"submitRepaymentRequest": {
"possibleErrors": [PossibleErrorType],
"repaymentRequest": RequestRepaymentOutputType
}
}
}switchAccountToMeasuredTariff
Type:SwitchAccountToMeasuredTariff
URL:https://api.st.kraken.tech/v1/graphql/
Switch an account to a measured tariff (if possible).
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
Input fields for switching an account to a measured tariff. |
Return fields
| Name | Description |
|---|---|
| Account that was switched to a measured tariff. |
Mutation
mutation SwitchAccountToMeasuredTariff($input: SwitchAccountToMeasuredTariffInput!) {
switchAccountToMeasuredTariff(input: $input) {
account {
...AccountTypeFragment
}
}
}Variables
{
"input": SwitchAccountToMeasuredTariffInput
}Response
{
"data": {
"switchAccountToMeasuredTariff": {
"account": AccountType
}
}
}switchAccountToVariablePaymentSchedule
Type:SwitchAccountToVariablePaymentSchedule
URL:https://api.st.kraken.tech/v1/graphql/
Switch account to variable payment schedule. Current schedule type will be preserved.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3921: Account not found.
- KT-CT-3922: Ledger not found for the account.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3984: Could not delete conflicting future payment schedule.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for switching to a variable payment schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| New payment schedule. |
Mutation
mutation SwitchAccountToVariablePaymentSchedule($input: SwitchAccountToVariablePaymentScheduleInput!) {
switchAccountToVariablePaymentSchedule(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
schedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": SwitchAccountToVariablePaymentScheduleInput
}Response
{
"data": {
"switchAccountToVariablePaymentSchedule": {
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
}
}terminateAgreement
Type:TerminateAgreement
URL:https://api.st.kraken.tech/v1/graphql/
Terminate an agreement.
The possible errors that can be raised are:
- KT-CT-1501: Agreement not found.
- KT-CT-1513: Unable to terminate agreement.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for terminating an agreement. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created agreement. |
Mutation
mutation TerminateAgreement($input: TerminateAgreementInput!) {
terminateAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreement {
...CommonAgreementTypeFragment
}
}
}Variables
{
"input": TerminateAgreementInput
}Response
{
"data": {
"terminateAgreement": {
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}
}
}terminateContract
URL:https://api.st.kraken.tech/v1/graphql/
Terminate an existing contract.
The possible errors that can be raised are:
- KT-CT-10003: Contract not found.
- KT-CT-10007: Unable to terminate contract.
- KT-CT-10008: The contract is currently undergoing an active journey.
- KT-CT-10013: Requested termination date is invalid.
- KT-CT-10022: Contract already terminated.
- KT-CT-10023: Contract is already revoked.
- KT-CT-10024: Contract already expired.
- KT-CT-10025: Contract has not started yet.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation TerminateContract($input: TerminateContractInput!) {
terminateContract(input: $input) {
contract {
...ContractFragment
}
}
}Variables
{
"input": TerminateContractInput
}Response
{
"data": {
"terminateContract": {
"contract": Contract
}
}
}terminateCreditTransferPermission
Type:TerminateCreditTransferPermission
URL:https://api.st.kraken.tech/v1/graphql/
Terminate credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3825: Credit transfer permission not found.
- KT-CT-3827: The ledger is not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for terminating a credit transfer permission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Datetime when the credit transfer permission ends. |
Mutation
mutation TerminateCreditTransferPermission($input: TerminateCreditTransferPermissionInput!) {
terminateCreditTransferPermission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
validTo
}
}Variables
{
"input": TerminateCreditTransferPermissionInput
}Response
{
"data": {
"terminateCreditTransferPermission": {
"possibleErrors": [PossibleErrorType],
"validTo": "2020-01-01T00:00:00.000Z"
}
}
}transferLeadOpportunities
Type:TransferLeadOpportunities
URL:https://api.st.kraken.tech/v1/graphql/
Transfer opportunities across leads.
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for transfer opportunities across leads. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Number of opportunities transferred. |
Mutation
mutation TransferLeadOpportunities($input: TransferLeadOpportunitiesInput!) {
transferLeadOpportunities(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
opportunitiesTransferred
}
}Variables
{
"input": TransferLeadOpportunitiesInput
}Response
{
"data": {
"transferLeadOpportunities": {
"possibleErrors": [PossibleErrorType],
"opportunitiesTransferred": 1
}
}
}transferLedgerBalance
URL:https://api.st.kraken.tech/v1/graphql/
Transfer value from a source ledger to a destination ledger. This decreases the balance of the source ledger by the given amount and increases the balance of the destination ledger by the same amount. If the amount is negative, the effect is reversed (the source ledger's balance increases and the destination ledger's balance decreases).
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-9701: Balance transfer to same account is not allowed.
- KT-CT-9702: Balance transfer is not support for debit account with Zero balance.
- KT-CT-9703: Balance transfer is not supported for debit account.
- KT-CT-9704: Balance transfer amount should be non-zero.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for processing an account balance transfer. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Balance transfer details. |
Mutation
mutation TransferLedgerBalance($input: TransferLedgerBalanceInputType!) {
transferLedgerBalance(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
balanceTransfer {
...AccountBalanceTransferTypeFragment
}
}
}Variables
{
"input": TransferLedgerBalanceInputType
}Response
{
"data": {
"transferLedgerBalance": {
"possibleErrors": [PossibleErrorType],
"balanceTransfer": AccountBalanceTransferType
}
}
}transferLoyaltyPointsBetweenUsers
Type:TransferLoyaltyPointsBetweenUsers
URL:https://api.st.kraken.tech/v1/graphql/
Transfer Loyalty Point from one account user to another.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for transferring Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were transferred. |
Mutation
mutation TransferLoyaltyPointsBetweenUsers($input: TransferLoyaltyPointsBetweenUsersInput!) {
transferLoyaltyPointsBetweenUsers(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsTransferred
}
}Variables
{
"input": TransferLoyaltyPointsBetweenUsersInput
}Response
{
"data": {
"transferLoyaltyPointsBetweenUsers": {
"possibleErrors": [PossibleErrorType],
"pointsTransferred": 1
}
}
}triggerCollectionProcessMessage
Type:TriggerCollectionProcessMessage
URL:https://api.st.kraken.tech/v1/graphql/
Trigger a collection process message with safety checks.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input for sending a collection process communication. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of the triggered communication. |
Mutation
mutation TriggerCollectionProcessMessage($input: TriggerCollectionProcessMessageInput!) {
triggerCollectionProcessMessage(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
triggerResult {
...TriggerCollectionProcessMessageOutputFragment
}
}
}Variables
{
"input": TriggerCollectionProcessMessageInput
}Response
{
"data": {
"triggerCollectionProcessMessage": {
"possibleErrors": [PossibleErrorType],
"triggerResult": TriggerCollectionProcessMessageOutput
}
}
}unenrollAccountFromLoyaltyProgram
Type:UnenrollAccountFromLoyaltyProgram
URL:https://api.st.kraken.tech/v1/graphql/
Unenroll users account from Loyalty program.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9220: Ineligible loyalty points unenrollment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The account number to unenroll from the loyalty program. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Outcome of the loyalty points campaign enrollment. |
Mutation
mutation UnenrollAccountFromLoyaltyProgram($input: UnenrollAccountFromLoyaltyProgramInput!) {
unenrollAccountFromLoyaltyProgram(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
outcome {
...UnenrollAccountFromLoyaltyProgramOutcomeFragment
}
}
}Variables
{
"input": UnenrollAccountFromLoyaltyProgramInput
}Response
{
"data": {
"unenrollAccountFromLoyaltyProgram": {
"possibleErrors": [PossibleErrorType],
"outcome": UnenrollAccountFromLoyaltyProgramOutcome
}
}
}unlinkUserFromLine
Type:UnlinkUserFromLineResponse!
URL:https://api.st.kraken.tech/v1/graphql/
Unlink an account user and line together.
Return fields
| Name | Description |
|---|
Mutation
mutation UnlinkUserFromLine {
unlinkUserFromLine {
... on LineUnlinkedResponse {
...LineUnlinkedResponseFragment
}
... on LinkTokenNotFound {
...LinkTokenNotFoundFragment
}
... on LineCommonError {
...LineCommonErrorFragment
}
}
}Response
{
"data": {
"unlinkUserFromLine": LineUnlinkedResponse
}
}updateAccountAddress
Type:UpdateAccountAddress
URL:https://api.st.kraken.tech/v1/graphql/
Update the billing address of given account.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-4411: Address in db is structured, cannot accept unstructured address fields.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating billing address of account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated account. |
| The currently authenticated user. This field requires the |
Mutation
mutation UpdateAccountAddress($input: UpdateAccountAddressInput!) {
updateAccountAddress(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"input": UpdateAccountAddressInput
}Response
{
"data": {
"updateAccountAddress": {
"possibleErrors": [PossibleErrorType],
"account": AccountType,
"viewer": AccountUserType
}
}
}updateAccountBillingAddress
Type:UpdateAccountBillingAddress
URL:https://api.st.kraken.tech/v1/graphql/
Update the account billing address.
The possible errors that can be raised are:
- KT-CT-4145: Invalid address.
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for updating an account billing address. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated account. |
Mutation
mutation UpdateAccountBillingAddress($input: AccountBillingAddressInput!) {
updateAccountBillingAddress(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": AccountBillingAddressInput
}Response
{
"data": {
"updateAccountBillingAddress": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}updateAccountBillingEmail
Type:UpdateAccountBillingEmail
URL:https://api.st.kraken.tech/v1/graphql/
Update account billing email.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4122: Invalid email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating billing email for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account that was changed. |
Mutation
mutation UpdateAccountBillingEmail($input: UpdateAccountBillingEmailInput!) {
updateAccountBillingEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountInterfaceFragment
}
}
}Variables
{
"input": UpdateAccountBillingEmailInput
}Response
{
"data": {
"updateAccountBillingEmail": {
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
}
}updateAccountConsents
URL:https://api.st.kraken.tech/v1/graphql/
Update the consents of an account
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9018: Account not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The account number to update consents for. |
| Consents to update for account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Consents linked to this account. |
Mutation
mutation UpdateAccountConsents(
$accountNumber: String!,
$consents: [ConsentInput]!
) {
updateAccountConsents(
accountNumber: $accountNumber,
consents: $consents
) {
possibleErrors {
...PossibleErrorTypeFragment
}
consents {
...ConsentTypeFragment
}
}
}Variables
{
"accountNumber": "abc123",
"consents": ConsentInput
}Response
{
"data": {
"updateAccountConsents": {
"possibleErrors": [PossibleErrorType],
"consents": ConsentType
}
}
}updateAccountReference
URL:https://api.st.kraken.tech/v1/graphql/
Update an account reference.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating an account reference. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateAccountReference($input: AccountReferenceInput!) {
updateAccountReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReference {
...AccountReferenceTypeFragment
}
}
}Variables
{
"input": AccountReferenceInput
}Response
{
"data": {
"updateAccountReference": {
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
}
}updateAccountReferralStatus
Type:UpdateAccountReferralStatus
URL:https://api.st.kraken.tech/v1/graphql/
Update the status of an account referral.
The possible errors that can be raised are:
- KT-CT-6712: Invalid reference.
- KT-CT-6732: Invalid referral status transition.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for updating the status of an account referral. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated account referral instance. |
Mutation
mutation UpdateAccountReferralStatus($input: UpdateAccountReferralStatusInput!) {
updateAccountReferralStatus(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReferral {
...ReferralTypeFragment
}
}
}Variables
{
"input": UpdateAccountReferralStatusInput
}Response
{
"data": {
"updateAccountReferralStatus": {
"possibleErrors": [PossibleErrorType],
"accountReferral": ReferralType
}
}
}updateAccountUserConsents
Type:UpdateAccountUserConsents
URL:https://api.st.kraken.tech/v1/graphql/
Update the consents of an account user (the authenticated user)
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-1111: Unauthorized.
- KT-CT-5421: Account user not found.
- KT-CT-5422: Invalid data.
- KT-CT-1605: Invalid input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Consents to update for account user. |
| User number of the account user to update consents for. Only needed if the viewer is an organization. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| All the consents for an account user. |
Mutation
mutation UpdateAccountUserConsents(
$consents: [ConsentTypeInput],
$userNumber: String
) {
updateAccountUserConsents(
consents: $consents,
userNumber: $userNumber
) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountUserConsents {
...AccountUserConsentsFragment
}
}
}Variables
{
"consents": ConsentTypeInput,
"userNumber": "abc123"
}Response
{
"data": {
"updateAccountUserConsents": {
"possibleErrors": [PossibleErrorType],
"accountUserConsents": AccountUserConsents
}
}
}updateActivePurchase
Type:UpdateActivePurchase
URL:https://api.st.kraken.tech/v1/graphql/
Update an active purchase.
The possible errors that can be raised are:
- KT-CT-8225: Received an invalid purchaseId.
- KT-CT-8226: The provided purchase is not active.
- KT-CT-8206: Invalid data.
- KT-CT-8227: Available grants could not be applied.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating an active purchase. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase updated. |
Mutation
mutation UpdateActivePurchase($input: UpdatePurchaseInput!) {
updateActivePurchase(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": UpdatePurchaseInput
}Response
{
"data": {
"updateActivePurchase": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}updateAffiliateLink
Type:UpdateAffiliateLink!
URL:https://api.st.kraken.tech/v1/graphql/
Update an existing affiliate link.
The possible errors that can be raised are:
- KT-CT-7711: Invalid data.
- KT-CT-7713: Invalid data.
- KT-CT-7714: Invalid data.
- KT-CT-7715: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for Updating an existing affiliate link. |
Return fields
| Name | Description |
|---|
Mutation
mutation UpdateAffiliateLink($input: UpdateAffiliateLinkInputType!) {
updateAffiliateLink(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
affiliateLink {
...AffiliateLinkTypeFragment
}
}
}Variables
{
"input": UpdateAffiliateLinkInputType
}Response
{
"data": {
"updateAffiliateLink": {
"possibleErrors": [PossibleErrorType],
"affiliateLink": AffiliateLinkType
}
}
}updateAffiliateOrganisation
Type:UpdateAffiliateOrganisation!
URL:https://api.st.kraken.tech/v1/graphql/
Update an existing affiliate organisation.
The possible errors that can be raised are:
- KT-CT-7717: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for Updating an existing affiliate organisation. |
Return fields
| Name | Description |
|---|
Mutation
mutation UpdateAffiliateOrganisation($input: UpdateAffiliateOrganisationInputType!) {
updateAffiliateOrganisation(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
affiliateOrganisation {
...AffiliateOrganisationTypeFragment
}
}
}Variables
{
"input": UpdateAffiliateOrganisationInputType
}Response
{
"data": {
"updateAffiliateOrganisation": {
"possibleErrors": [PossibleErrorType],
"affiliateOrganisation": AffiliateOrganisationType
}
}
}updateAgentAuxiliaryStatus
Type:UpdateAgentAuxiliaryStatus
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7813: Support user not found with that username.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The input data for this mutation. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the auxiliary status was successfully updated. |
Mutation
mutation UpdateAgentAuxiliaryStatus($input: UpdateAgentAuxiliaryStatusInput!) {
updateAgentAuxiliaryStatus(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": UpdateAgentAuxiliaryStatusInput
}Response
{
"data": {
"updateAgentAuxiliaryStatus": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}updateAgreementPeriod
URL:https://api.st.kraken.tech/v1/graphql/
Update the period of an agreement.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-1501: Agreement not found.
- KT-CT-1503: Agreement validto date must be later than validfrom date.
- KT-CT-1504: Account does not match with the agreement.
- KT-CT-1505: Unable to edit agreement.
- KT-CT-1506: Agreement period is not within the supply and property period.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for updating the agreement period. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account responsible for the update agreement. |
Mutation
mutation UpdateAgreementPeriod($input: UpdateAgreementPeriodInput!) {
updateAgreementPeriod(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": UpdateAgreementPeriodInput
}Response
{
"data": {
"updateAgreementPeriod": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}updateAgreementRescission
Type:UpdateAgreementRescission
URL:https://api.st.kraken.tech/v1/graphql/
Update an agreement rescission.
The possible errors that can be raised are:
- KT-CT-14101: Agreement rescission not found.
- KT-CT-14102: Cannot update completed agreement rescission.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating an agreement rescission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated agreement rescission instance. |
Mutation
mutation UpdateAgreementRescission($input: UpdateAgreementRescissionInput!) {
updateAgreementRescission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreementRescission {
...AgreementRescissionTypeFragment
}
}
}Variables
{
"input": UpdateAgreementRescissionInput
}Response
{
"data": {
"updateAgreementRescission": {
"possibleErrors": [PossibleErrorType],
"agreementRescission": AgreementRescissionType
}
}
}updateAgreementRollover
URL:https://api.st.kraken.tech/v1/graphql/
Update an agreement rollover.
The possible errors that can be raised are:
- KT-CT-4910: No product exists with the given input.
- KT-CT-13705: Agreement rollover not found.
- KT-CT-13706: Agreement rollover has an invalid status for this operation.
- KT-CT-13707: Agreement rollover has an invalid type for this operation.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input for updating an agreement rollover. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The update agreement rollover. |
Mutation
mutation UpdateAgreementRollover($input: UpdateAgreementRolloverInput!) {
updateAgreementRollover(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreementRollover {
...AgreementRolloverTypeFragment
}
}
}Variables
{
"input": UpdateAgreementRolloverInput
}Response
{
"data": {
"updateAgreementRollover": {
"possibleErrors": [PossibleErrorType],
"agreementRollover": AgreementRolloverType
}
}
}updateApiException
Type:UpdateAPIException
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to update an existing APIException instance.
The possible errors that can be raised are:
- KT-CT-7804: No fields present in the input for updating the APIException.
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-7809: Update results in no changes to API Exception.
- KT-CT-7805: Too many tags associated with this API Exception.
- KT-CT-7806: Cannot create duplicate tags for the same API exception.
- KT-CT-7801: Received an invalid operationsTeamId.
- KT-CT-7811: Received an invalid assignedUserId.
- KT-CT-7812: Support user is inactive.
- KT-CT-7814: Received an invalid accountNumber.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating an API exception. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated APIException. |
Mutation
mutation UpdateApiException($input: UpdateAPIExceptionInput!) {
updateApiException(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
apiException {
...APIExceptionTypeFragment
}
}
}Variables
{
"input": UpdateAPIExceptionInput
}Response
{
"data": {
"updateApiException": {
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
}
}updateApiExceptionNote
URL:https://api.st.kraken.tech/v1/graphql/
Mutation to update an existing APIExceptionNote instance.
The possible errors that can be raised are:
- KT-CT-7807: Received an invalid apiExceptionNoteId.
- KT-CT-7808: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an API exception note. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updates APIExceptionNote. |
Mutation
mutation UpdateApiExceptionNote($input: UpdateAPIExceptionNoteInput!) {
updateApiExceptionNote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
apiException {
...APIExceptionTypeFragment
}
}
}Variables
{
"input": UpdateAPIExceptionNoteInput
}Response
{
"data": {
"updateApiExceptionNote": {
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
}
}updateAutoTopUpAmount
URL:https://api.st.kraken.tech/v1/graphql/
Change the auto top up amount for the payment schedule.
The possible errors that can be raised are:
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-3941: Invalid data.
- KT-CT-3942: An unexpected error occurred.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3953: The payment schedule is not a balance triggered schedule.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3822: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating the auto-top-up amount for a schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new schedule created. |
Mutation
mutation UpdateAutoTopUpAmount($input: UpdateAutoTopUpAmountInput!) {
updateAutoTopUpAmount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
schedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": UpdateAutoTopUpAmountInput
}Response
{
"data": {
"updateAutoTopUpAmount": {
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
}
}updateBlackholeEmail
Type:UpdateBlackholeEmail
URL:https://api.st.kraken.tech/v1/graphql/
Update the email address of an account user that currently has a blackhole email.
The possible errors that can be raised are:
- KT-GB-5412: User already has an email address.
- KT-GB-5413: Invalid inputs for updating a blackhole email.
- KT-CT-1133: Unable to request password reset email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for assigning email address to an account user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of an account user who has updated their blackhole email. |
| Details of an account of an account user updating their blackhole email. |
Mutation
mutation UpdateBlackholeEmail($input: UpdateBlackholeEmailInput!) {
updateBlackholeEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
blackholeEmailAccountUser {
...BlackholeEmailAccountUserTypeFragment
}
blackholeEmailAccount {
...BlackholeEmailAccountTypeFragment
}
}
}Variables
{
"input": UpdateBlackholeEmailInput
}Response
{
"data": {
"updateBlackholeEmail": {
"possibleErrors": [PossibleErrorType],
"blackholeEmailAccountUser": BlackholeEmailAccountUserType,
"blackholeEmailAccount": BlackholeEmailAccountType
}
}
}updateCollectionProcessRecordToActive
Type:UpdateCollectionProcessRecordToActive
URL:https://api.st.kraken.tech/v1/graphql/
Update the Collection Process Record from raised status to active.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11202: No External reference provided.
- KT-CT-11207: Unsupported external source for collection process.
- KT-CT-11218: External reference cannot be updated once it has been set.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input variables needed for making a collection process record active. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the collection process was successfully updated. |
Mutation
mutation UpdateCollectionProcessRecordToActive($input: UpdateCollectionProcessRecordToActiveInputType!) {
updateCollectionProcessRecordToActive(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessActivated {
...UpdateCollectionProcessRecordToActiveOutputTypeFragment
}
}
}Variables
{
"input": UpdateCollectionProcessRecordToActiveInputType
}Response
{
"data": {
"updateCollectionProcessRecordToActive": {
"possibleErrors": [PossibleErrorType],
"collectionProcessActivated": UpdateCollectionProcessRecordToActiveOutputType
}
}
}updateCollectionProcessRecordToComplete
Type:UpdateCollectionProcessRecordToComplete
URL:https://api.st.kraken.tech/v1/graphql/
Update the Collection Process Record from raised status to complete.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11203: No Completion reason provided.
- KT-CT-11204: No Completion details provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input variables needed for making a collection process record complete. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the collection process was successfully updated. |
Mutation
mutation UpdateCollectionProcessRecordToComplete($input: UpdateCollectionProcessRecordToCompleteInputType!) {
updateCollectionProcessRecordToComplete(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
collectionProcessComplete {
...UpdateCollectionProcessRecordToCompleteOutputTypeFragment
}
}
}Variables
{
"input": UpdateCollectionProcessRecordToCompleteInputType
}Response
{
"data": {
"updateCollectionProcessRecordToComplete": {
"possibleErrors": [PossibleErrorType],
"collectionProcessComplete": UpdateCollectionProcessRecordToCompleteOutputType
}
}
}updateCommsDeliveryPreference
Type:UpdateCommsDeliveryPreference
URL:https://api.st.kraken.tech/v1/graphql/
Update the comms delivery preference for the input account number to the received commsDeliveryPreference value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4136: Cannot set comms preference to email when account has no email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for updating comms delivery preferences for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
updateCommsDeliveryPreference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountInterfaceFragment
}
}
}Variables
{
"input": UpdateCommsDeliveryPreferenceInput
}Response
{
"data": {
"updateCommsDeliveryPreference": {
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
}
}updateCommsPreferences
Type:UpdateAccountUserCommsPreferencesMutation
URL:https://api.st.kraken.tech/v1/graphql/
Update the comms preferences of the account user (the authenticated user).
The possible errors that can be raised are:
- KT-GB-5414: The given preferences are not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for updating an account user's comms preferences. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of comms preferences set up for a user. |
Mutation
mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesInput!) {
updateCommsPreferences(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
commsPreferences {
...AccountUserCommsPreferencesTypeFragment
}
}
}Variables
{
"input": UpdateAccountUserCommsPreferencesInput
}Response
{
"data": {
"updateCommsPreferences": {
"possibleErrors": [PossibleErrorType],
"commsPreferences": AccountUserCommsPreferencesType
}
}
}updateDcaProceeding
Type:UpdateDCAProceeding
URL:https://api.st.kraken.tech/v1/graphql/
Update the status of a DCA proceeding.
The possible errors that can be raised are:
- KT-CT-11610: unable to edit the debt collection proceeding.
- KT-CT-11604: Active debt collection proceeding does not exist for account.
- KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the update has been applied. |
Mutation
mutation UpdateDcaProceeding($input: UpdateDCAProceedingInputType!) {
updateDcaProceeding(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
dcaProceedingUpdateStatus {
...DCAProceedingUpdateStatusFragment
}
}
}Variables
{
"input": UpdateDCAProceedingInputType
}Response
{
"data": {
"updateDcaProceeding": {
"possibleErrors": [PossibleErrorType],
"dcaProceedingUpdateStatus": DCAProceedingUpdateStatus
}
}
}updateDocumentAccessibilityPreference
Type:UpdateDocumentAccessibilityPreference!
URL:https://api.st.kraken.tech/v1/graphql/
Update the document accessibility preference for an account.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for updating document accessibility preference for an account. |
Return fields
| Name | Description |
|---|
Mutation
mutation UpdateDocumentAccessibilityPreference($input: UpdateDocumentAccessibilityPreferenceInput!) {
updateDocumentAccessibilityPreference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": UpdateDocumentAccessibilityPreferenceInput
}Response
{
"data": {
"updateDocumentAccessibilityPreference": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}updateEmailAndPassword
URL:https://api.st.kraken.tech/v1/graphql/
Update the email address and password of an account user.
The possible errors that can be raised are:
- KT-CT-5413: Invalid data.
- KT-CT-5414: Invalid data.
- KT-CT-5450: Password is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields to update email and password. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the sign up was successful. |
Mutation
mutation UpdateEmailAndPassword($input: UpdateEmailAndPasswordInput!) {
updateEmailAndPassword(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": UpdateEmailAndPasswordInput
}Response
{
"data": {
"updateEmailAndPassword": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}updateLeadAssignment
Type:UpdateLeadAssignment
URL:https://api.st.kraken.tech/v1/graphql/
Update assignment fields for a Lead.
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Fields for updating a lead assignment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Arguments passed. |
Mutation
mutation UpdateLeadAssignment($input: UpdateLeadAssignmentInput!) {
updateLeadAssignment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
updatedLeadData
}
}Variables
{
"input": UpdateLeadAssignmentInput
}Response
{
"data": {
"updateLeadAssignment": {
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}
}
}updateLeadDetails
Type:UpdateLeadDetails
URL:https://api.st.kraken.tech/v1/graphql/
Update the details of a lead.
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-8912: Funnel not found.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8935: National ID bad input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Fields for updating a lead's details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Arguments passed. |
Mutation
mutation UpdateLeadDetails($input: UpdateLeadDetailsInput!) {
updateLeadDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
updatedLeadData
}
}Variables
{
"input": UpdateLeadDetailsInput
}Response
{
"data": {
"updateLeadDetails": {
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}
}
}updateLeadStage
Type:UpdateLeadStage
URL:https://api.st.kraken.tech/v1/graphql/
Update the stage of a lead.
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-8914: Stage not found.
- KT-CT-8915: Stages are not in the same funnel.
- KT-CT-8916: Current stage mismatch.
- KT-CT-8917: Stage transition not allowed.
- KT-CT-8918: Stage precondition not met.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Fields for updating a lead's stage. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Arguments passed. |
Mutation
mutation UpdateLeadStage($input: UpdateLeadStageInput!) {
updateLeadStage(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
updatedLeadData
}
}Variables
{
"input": UpdateLeadStageInput
}Response
{
"data": {
"updateLeadStage": {
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}
}
}updateLeaveSupplier
URL:https://api.st.kraken.tech/v1/graphql/
Update an existing leave supplier process.
The possible errors that can be raised are:
- KT-CT-10304: Mutation not enabled in this environment.
- KT-CT-10302: Invalid data.
- KT-CT-10309: Failed to update leave supplier process - the service is not enabled.
- KT-CT-10310: Failed to update leave supplier process. The process status is not in updatable status.
- KT-CT-1607: Value cannot be empty.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation UpdateLeaveSupplier($input: UpdateLeaveSupplierInput!) {
updateLeaveSupplier(input: $input) {
message
}
}Variables
{
"input": UpdateLeaveSupplierInput
}Response
{
"data": {
"updateLeaveSupplier": {
"message": "abc123"
}
}
}updateMessageTags
Type:UpdateMessageTags
URL:https://api.st.kraken.tech/v1/graphql/
The possible errors that can be raised are:
- KT-CT-7611: The message was not found.
- KT-CT-7614: The Ink tag was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Confirmed tags. |
Mutation
mutation UpdateMessageTags($input: UpdateMessageTagsInput) {
updateMessageTags(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
tags {
...InkTagFragment
}
}
}Variables
{
"input": UpdateMessageTagsInput
}Response
{
"data": {
"updateMessageTags": {
"possibleErrors": [PossibleErrorType],
"tags": InkTag
}
}
}updateMetadata
Type:UpdateMetadata
URL:https://api.st.kraken.tech/v1/graphql/
Update metadata on an object.
The possible errors that can be raised are:
- KT-CT-4323: Unauthorized.
- KT-CT-8413: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating metadata. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateMetadata($input: MetadataInput!) {
updateMetadata(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
metadata {
...MetadataFragment
}
}
}Variables
{
"input": MetadataInput
}Response
{
"data": {
"updateMetadata": {
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}
}
}updateNotesOnOpportunity
URL:https://api.st.kraken.tech/v1/graphql/
Update the notes of an opportunity.
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input to update the note on an opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of the opportunity. |
Mutation
mutation UpdateNotesOnOpportunity($input: UpdateNotesOnOpportunityInput!) {
updateNotesOnOpportunity(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
opportunityNumber
}
}Variables
{
"input": UpdateNotesOnOpportunityInput
}Response
{
"data": {
"updateNotesOnOpportunity": {
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123"
}
}
}updateNumberOfOccupants
URL:https://api.st.kraken.tech/v1/graphql/
Update number of occupants for a property.
The possible errors that can be raised are:
- KT-CT-6628: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for updating property details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Property id. |
Mutation
mutation UpdateNumberOfOccupants($input: UpdateNumberOfOccupantsInput!) {
updateNumberOfOccupants(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
propertyId
}
}Variables
{
"input": UpdateNumberOfOccupantsInput
}Response
{
"data": {
"updateNumberOfOccupants": {
"possibleErrors": [PossibleErrorType],
"propertyId": "abc123"
}
}
}updateOfferGroupOnOpportunity
Type:UpdateOfferGroupOnOpportunity
URL:https://api.st.kraken.tech/v1/graphql/
Update the offer group of an opportunity.
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input to update the offer group on an opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of the opportunity. |
Mutation
mutation UpdateOfferGroupOnOpportunity($input: UpdateOfferGroupOnOpportunityInput!) {
updateOfferGroupOnOpportunity(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
opportunityNumber
}
}Variables
{
"input": UpdateOfferGroupOnOpportunityInput
}Response
{
"data": {
"updateOfferGroupOnOpportunity": {
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123"
}
}
}updateOnSiteJobsAppointment
Type:UpdateOnSiteJobsAppointment
URL:https://api.st.kraken.tech/v1/graphql/
Update an Appointment.
The possible errors that can be raised are:
- KT-CT-13001: Appointment does not exist.
- KT-CT-13043: Cannot update appointment as it has terminal status.
- KT-CT-13044: Failed to update appointment slot.
- KT-CT-13018: Unable to record cancellationcategory/cancellationsub_category.
- KT-CT-13039: Cancellation fields require CANCELLED status.
- KT-CT-13045: Failed to update appointment assets.
- KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-13062: Datetime field must be timezone-aware.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The appointment and its details to update. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The Appointment that was updated. |
Mutation
mutation UpdateOnSiteJobsAppointment($input: OnSiteJobsUpdateAppointmentInput!) {
updateOnSiteJobsAppointment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
onSiteJobsAppointment {
...OnSiteJobsAppointmentTypeFragment
}
}
}Variables
{
"input": OnSiteJobsUpdateAppointmentInput
}Response
{
"data": {
"updateOnSiteJobsAppointment": {
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}
}
}updateOnSiteJobsRequest
URL:https://api.st.kraken.tech/v1/graphql/
Update an On Site Jobs Request.
The possible errors that can be raised are:
- KT-CT-13032: Request does not exist.
- KT-CT-13035: Request is inactive.
- KT-CT-13038: Invalid request status.
- KT-CT-13040: Agent not set on request.
- KT-CT-13045: Failed to update appointment assets.
- KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The input objects required to update a Request. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated request. |
Mutation
mutation UpdateOnSiteJobsRequest($input: OnSiteJobsUpdateRequestInput!) {
updateOnSiteJobsRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
onSiteJobsRequest {
...OnSiteJobsRequestTypeFragment
}
}
}Variables
{
"input": OnSiteJobsUpdateRequestInput
}Response
{
"data": {
"updateOnSiteJobsRequest": {
"possibleErrors": [PossibleErrorType],
"onSiteJobsRequest": OnSiteJobsRequestType
}
}
}updateOpportunityAssignment
Type:UpdateOpportunityAssignment
URL:https://api.st.kraken.tech/v1/graphql/
Update assignment fields for an Opportunity.
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-8903: Unable to update opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating an opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Arguments passed. |
Mutation
mutation UpdateOpportunityAssignment($input: UpdateOpportunityAssignmentInput!) {
updateOpportunityAssignment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
updatedOpportunityData
}
}Variables
{
"input": UpdateOpportunityAssignmentInput
}Response
{
"data": {
"updateOpportunityAssignment": {
"possibleErrors": [PossibleErrorType],
"updatedOpportunityData": {"key": "value"}
}
}
}updateOpportunityDetails
URL:https://api.st.kraken.tech/v1/graphql/
Update the details of an opportunity.
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-8930: Unable to parse address.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8912: Funnel not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating the address of a opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Arguments updated. |
Mutation
mutation UpdateOpportunityDetails($input: UpdateOpportunityDetailsInput!) {
updateOpportunityDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
updatedData
}
}Variables
{
"input": UpdateOpportunityDetailsInput
}Response
{
"data": {
"updateOpportunityDetails": {
"possibleErrors": [PossibleErrorType],
"updatedData": {"key": "value"}
}
}
}updateOpportunityExtraDetails
Type:UpdateOpportunityExtraDetails
URL:https://api.st.kraken.tech/v1/graphql/
Update the extra details of a opportunity.
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-8926: Unable to create opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating the extra details of a opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The opportunity's extra details to be added or updated. |
Mutation
mutation UpdateOpportunityExtraDetails($input: UpdateExtraDetailsInput!) {
updateOpportunityExtraDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
extraDetails
}
}Variables
{
"input": UpdateExtraDetailsInput
}Response
{
"data": {
"updateOpportunityExtraDetails": {
"possibleErrors": [PossibleErrorType],
"extraDetails": {"key": "value"}
}
}
}updateOpportunityStage
URL:https://api.st.kraken.tech/v1/graphql/
Update the stage of a opportunity.
The possible errors that can be raised are:
- KT-CT-8903: Unable to update opportunity.
- KT-CT-8910: Received opportunity current stage is not valid.
- KT-CT-8914: Stage not found.
- KT-CT-8915: Stages are not in the same funnel.
- KT-CT-8916: Current stage mismatch.
- KT-CT-8917: Stage transition not allowed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating the state of a opportunity. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Placeholder success message for now. |
Mutation
mutation UpdateOpportunityStage($input: UpdateOpportunityStageInput!) {
updateOpportunityStage(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
message
}
}Variables
{
"input": UpdateOpportunityStageInput
}Response
{
"data": {
"updateOpportunityStage": {
"possibleErrors": [PossibleErrorType],
"message": "abc123"
}
}
}updatePassword
Type:UpdatePassword
URL:https://api.st.kraken.tech/v1/graphql/
Update password of the authenticated user
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-5460: Old password is invalid.
- KT-CT-5450: Password is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. This field requires the |
Mutation
mutation UpdatePassword($input: UpdatePasswordInput) {
updatePassword(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"input": UpdatePasswordInput
}Response
{
"data": {
"updatePassword": {
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
}
}updateProductPrices
Type:UpdateProductPricesOutput!
URL:https://api.st.kraken.tech/v1/graphql/
Update the prices of a product.
The possible errors that can be raised are:
- KT-CT-12008: Unable to find the product.
- KT-CT-12009: Specified product does not have a specification.
- KT-CT-12010: Unable to find the product's specification.
- KT-CT-12011: The list of provided prices contains validation errors.
- KT-CT-12012: Product prices start date is in the past.
- KT-CT-12013: Product prices would overwrite existing prices.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation UpdateProductPrices($input: UpdateProductPricesInput!) {
updateProductPrices(input: $input) {
prices {
...RateGroupPricesFragment
}
}
}Variables
{
"input": UpdateProductPricesInput
}Response
{
"data": {
"updateProductPrices": {
"prices": RateGroupPrices
}
}
}updatePropertyType
Type:UpdatePropertyType
URL:https://api.st.kraken.tech/v1/graphql/
Update the property type of a property.
The possible errors that can be raised are:
- KT-GB-5418: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for updating property details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Property id. |
Mutation
mutation UpdatePropertyType($input: UpdatePropertyTypeInput!) {
updatePropertyType(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
propertyId
}
}Variables
{
"input": UpdatePropertyTypeInput
}Response
{
"data": {
"updatePropertyType": {
"possibleErrors": [PossibleErrorType],
"propertyId": "abc123"
}
}
}updateServiceOrder
Type:UpdateServiceOrder
URL:https://api.st.kraken.tech/v1/graphql/
Update an existing service order.
The possible errors that can be raised are:
- KT-GB-4242: Invalid service order update payload.
- KT-GB-4243: Service order not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields to update an existing service order. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The service order that was updated. |
Mutation
mutation UpdateServiceOrder($input: UpdateServiceOrderInput!) {
updateServiceOrder(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
serviceOrder {
...ServiceOrderTypeFragment
}
}
}Variables
{
"input": UpdateServiceOrderInput
}Response
{
"data": {
"updateServiceOrder": {
"possibleErrors": [PossibleErrorType],
"serviceOrder": ServiceOrderType
}
}
}updateSiteworksRequest
URL:https://api.st.kraken.tech/v1/graphql/
Update a Request.
The possible errors that can be raised are:
- KT-CT-4231: Unauthorized.
- KT-CT-4232: Status passed is not valid.
- KT-CT-4233: Request does not exist.
- KT-CT-4234: Terminated Request cannot be updated.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'updateSiteworksRequest' field is deprecated.
Please use updateOnSiteJobsRequest instead.
- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.
Arguments
| Name | Description |
|---|---|
| The input objects required to update a Request. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The siteworks request after the update. |
Mutation
mutation UpdateSiteworksRequest($input: UpdateSiteworksRequestInputType!) {
updateSiteworksRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
siteworksRequest {
...CoreSiteworksRequestTypeFragment
}
}
}Variables
{
"input": UpdateSiteworksRequestInputType
}Response
{
"data": {
"updateSiteworksRequest": {
"possibleErrors": [PossibleErrorType],
"siteworksRequest": CoreSiteworksRequestType
}
}
}updateUser
Type:UpdateUserMutation
URL:https://api.st.kraken.tech/v1/graphql/
Update the account user details of the authenticated user.
Only one name field can be updated per day, other fields can be updated freely. This prevents users from switching accounts to someone else (usually when moving homes). All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-5413: Invalid data.
- KT-CT-5414: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"input": UpdateUserInput
}Response
{
"data": {
"updateUser": {
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
}
}updateUserDetails
Type:UpdateAccountUserMutationPayload
URL:https://api.st.kraken.tech/v1/graphql/
DEPRECATED: Please use updateUser instead
Update the account user details of the authenticated user. Only one field can be updated per day. This prevents users from switching accounts to someone else (usually when moving homes) All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.
Deprecated
The 'updateUserDetails' field is deprecated.
Please use the 'updateUser' mutation instead.
- Marked as deprecated on 2020-10-02.
- Scheduled for removal on or after 2023-04-06.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
|
Mutation
mutation UpdateUserDetails($input: UpdateAccountUserMutationInput!) {
updateUserDetails(input: $input) {
givenName
familyName
pronouns
mobile
email
dateOfBirth
landline
errors {
...ErrorTypeFragment
}
clientMutationId
}
}Variables
{
"input": UpdateAccountUserMutationInput
}Response
{
"data": {
"updateUserDetails": {
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"mobile": "abc123",
"email": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"errors": [ErrorType],
"clientMutationId": "abc123"
}
}
}validateEmail
Type:ValidateEmail
URL:https://api.st.kraken.tech/v1/graphql/
Validate user's email address.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Whether the email is valid or not. |
Mutation
mutation ValidateEmail($input: ValidateEmailInput!) {
validateEmail(input: $input) {
isValid
}
}Variables
{
"input": ValidateEmailInput
}Response
{
"data": {
"validateEmail": {
"isValid": true
}
}
}validateMfaDevice
Type:ValidateMfaDevice
URL:https://api.st.kraken.tech/v1/graphql/
Validate MFA Device for user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1151: MFA device not found.
- KT-CT-1152: Invalid MFA token.
- KT-CT-1155: Enabled backup device is needed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for validating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the device has been verified, so it can be used for MFA. |
Mutation
mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
validateMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceIsValid
}
}Variables
{
"input": ValidateMfaDeviceInputType
}Response
{
"data": {
"validateMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}
}
}validatePhone
Type:ValidatePhone
URL:https://api.st.kraken.tech/v1/graphql/
Validate user's phone number.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Whether the phone number is valid or not. |
Mutation
mutation ValidatePhone($input: ValidatePhoneNumberInput!) {
validatePhone(input: $input) {
isValid
}
}Variables
{
"input": ValidatePhoneNumberInput
}Response
{
"data": {
"validatePhone": {
"isValid": true
}
}
}varyContractTerms
URL:https://api.st.kraken.tech/v1/graphql/
Vary the terms of a contract.
The possible errors that can be raised are:
- KT-CT-10003: Contract not found.
- KT-CT-10008: The contract is currently undergoing an active journey.
- KT-CT-10011: Unable to vary contract terms.
- KT-CT-10033: Unable to save term.
- KT-CT-10012: Contract variation implies breach.
- KT-CT-10034: Unknown contract journey type.
- KT-CT-10035: Cannot process a non-active contract journey.
- KT-CT-10036: The contract journey manager is not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation VaryContractTerms($input: VaryContractTermsInput!) {
varyContractTerms(input: $input) {
contract {
...ContractFragment
}
}
}Variables
{
"input": VaryContractTermsInput
}Response
{
"data": {
"varyContractTerms": {
"contract": Contract
}
}
}verifyCustomer
Type:VerifyCustomer
URL:https://api.st.kraken.tech/v1/graphql/
Verify a customer using the provided verification code and type.
The possible errors that can be raised are:
- KT-CT-4191: Error while verifying the customer.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. |
Mutation
mutation VerifyCustomer($input: VerifyCustomerInput!) {
verifyCustomer(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
user {
...AccountUserTypeFragment
}
}
}Variables
{
"input": VerifyCustomerInput
}Response
{
"data": {
"verifyCustomer": {
"possibleErrors": [PossibleErrorType],
"user": AccountUserType
}
}
}verifyEmail
Type:VerifyEmail
URL:https://api.st.kraken.tech/v1/graphql/
Verify user's email address.
The possible errors that can be raised are:
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the email is verified. |
Mutation
mutation VerifyEmail($input: VerifyEmailInput!) {
verifyEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
isVerified
}
}Variables
{
"input": VerifyEmailInput
}Response
{
"data": {
"verifyEmail": {
"possibleErrors": [PossibleErrorType],
"isVerified": true
}
}
}verifyIdentity
Type:VerifyIdentity
URL:https://api.st.kraken.tech/v1/graphql/
Provide identifying information about an account and user to get a scoped token that will permit access to associate an email address with the account's user.
The possible errors that can be raised are:
- KT-CT-1145: Account/user details do not match.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Details about the user to be verified. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| An expiring token that can be used to request to update the user's email address. |
Mutation
mutation VerifyIdentity($input: VerifyIdentityInput!) {
verifyIdentity(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
}
}Variables
{
"input": VerifyIdentityInput
}Response
{
"data": {
"verifyIdentity": {
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}
}
}verifyIdentityFallback
URL:https://api.st.kraken.tech/v1/graphql/
Verify the identity of a user by checking their family name, first line of address and postcode.
The possible errors that can be raised are:
- KT-CT-1145: Account/user details do not match.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Details about the user to be verified. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| An expiring token that can be used for scoped access. |
Mutation
mutation VerifyIdentityFallback($input: VerifyIdentityFallbackInput!) {
verifyIdentityFallback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
}
}Variables
{
"input": VerifyIdentityFallbackInput
}Response
{
"data": {
"verifyIdentityFallback": {
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}
}
}withdrawDunning
Type:WithdrawDunning
URL:https://api.st.kraken.tech/v1/graphql/
Withdraw a dunning process for an account
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11301: Account not in a dunning process for the given path name.
- KT-CT-11302: No active dunning process found.
- KT-CT-11303: Multiple active dunning processes found.
- KT-CT-11306: Withdrawing the dunning process failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for withdrawing a dunning process for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the dunning process was withdrawn successfully. |
Mutation
mutation WithdrawDunning($input: WithdrawDunningInputType!) {
withdrawDunning(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
withdrawSuccessful
}
}Variables
{
"input": WithdrawDunningInputType
}Response
{
"data": {
"withdrawDunning": {
"possibleErrors": [PossibleErrorType],
"withdrawSuccessful": true
}
}
}