customerCreatePasswordResetToken

Create a password-reset token for a customer (to email them a reset link).

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the customerCreatePasswordResetToken action (under Customer).
Fill in the fields below, then reference the result from later steps as {{customercreatepasswordresettoken.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 CustomerCreatePasswordResetToken($email: String!, $ttlMinutes: Int, $storeKey: KeyReferenceInput, $invalidateOlderTokens: Boolean!) {
  customerCreatePasswordResetToken(
    email: $email
    ttlMinutes: $ttlMinutes
    storeKey: $storeKey
    invalidateOlderTokens: $invalidateOlderTokens
  ) {
    customerId
    expiresAt
    value
    invalidateOlderTokens
    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.

emailstringrequired

ttlMinutesnumber

The validity of the created token in minutes.

storeKeystring

The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions.

invalidateOlderTokensbooleanrequired

Invalidate older, previously created tokens when a new token is created.

json

{
  "email": "string",
  "invalidateOlderTokens": false,
  "ttlMinutes": 0,
  "storeKey": "string"
}

Response

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

customerIdstring

expiresAtstring

valuestring

invalidateOlderTokensboolean

idstring

versionstring

createdAtstring

lastModifiedAtstring

createdByobject

isPlatformClientboolean

clientIdstring

externalUserIdstring

anonymousIdstring

customerRefobject2 fields

userRefobject2 fields

associateRefobject2 fields

attributedToobject3 fields

lastModifiedByobject