createApiClient

Create a new API client.

Use it in a workflow

Query

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

mutation CreateApiClient($draft: CreateApiClient!) {
  createApiClient(draft: $draft) {
    id
    name
    scope
    createdAt
    lastUsedAt
    deleteAt
    secret
    accessTokenValiditySeconds
    refreshTokenValiditySeconds
  }
}

Variables

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

{
  "draft": {
    "name": "string",
    "scope": "string",
    "deleteDaysAfterCreation": 0,
    "accessTokenValiditySeconds": 0,
    "refreshTokenValiditySeconds": 0
  }
}

Response

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

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