deleteApiClient

Delete an API client (requires its current version).

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the deleteApiClient action (under Delete).
Fill in the fields below, then reference the result from later steps as {{deleteapiclient.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 DeleteApiClient($id: String!) {
  deleteApiClient(id: $id) {
    id
    name
    scope
    createdAt
    lastUsedAt
    deleteAt
    accessTokenValiditySeconds
    refreshTokenValiditySeconds
  }
}

Variables

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

idstringrequired

json

{
  "id": "string"
}

Response

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

idstring

namestring

scopestring

createdAtstring

lastUsedAtstring

deleteAtstring

accessTokenValiditySecondsnumber

refreshTokenValiditySecondsnumber

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

Was this page helpful?