younifyd
Menu

deleteSubscription

Delete a subscription (requires its current version).

Use it in a workflow

  1. Add a step and choose the Commercetools connector.
  2. Pick the deleteSubscription action (under Delete).
  3. Fill in the fields below, then reference the result from later steps as {{deletesubscription.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
mutation DeleteSubscription($version: Long!, $id: String, $key: String) {
  deleteSubscription(version: $version, id: $id, key: $key) {
    key
    destination {
      type
    }
    messages {
      resourceTypeId
      types
    }
    changes {
      resourceTypeId
    }
    events {
      resourceTypeId
      types
    }
    format {
      type
    }
    status
    id
    version
    createdAt
    lastModifiedAt
    createdBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
    lastModifiedBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

versionstringrequired
idstring

Queries with specified ID

keystring

Queries with specified key

json
{
  "version": "string",
  "id": "string",
  "key": "string"
}

Response

Read the result with {{deletesubscription.response.data.data.deleteSubscription}}. If the API returns errors, the step fails and they are at {{deletesubscription.response.data.errors}}.

keystring
destinationobject
typestring
messagesarray<object>
resourceTypeIdobject
typesobject
changesarray<object>
resourceTypeIdobject
eventsarray<object>
resourceTypeIdobject
typesobject
formatobject
typestring
statusstring

One ofConfigurationErrorConfigurationErrorDeliveryStoppedHealthyManuallySuspendedTemporaryError

idstring
versionstring
createdAtstring
lastModifiedAtstring
createdByobject
isPlatformClientboolean
clientIdstring
externalUserIdstring
anonymousIdstring
customerRefobject2 fields
userRefobject2 fields
associateRefobject2 fields
attributedToobject3 fields
lastModifiedByobject
isPlatformClientboolean
clientIdstring
externalUserIdstring
anonymousIdstring
customerRefobject2 fields
userRefobject2 fields
associateRefobject2 fields
attributedToobject3 fields

Need more? See the Commercetools guide for connection setup and behaviour shared by every action.

Was this page helpful?