Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestBuilder

    Index

    Constructors

    constructor

    Properties

    args

    Methods

    post

    Constructors

    Properties

    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string; storeKey: string };
    }

    Methods

    post

    • post(
          methodArgs: {
              body: CustomerEmailVerify;
              headers?: { [key: string]: string | string[] };
          },
      ): ApiRequest<Customer>

      Use this method to verify a Store-specific Customer's email during their email verification process.

      Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.

If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.

After the email is verified, all email tokens issued previously through the [email verification flow](/../api/projects/customers#email-verification-of-customer) are invalidated. This invalidation of tokens is [eventually consistent](/../api/general-concepts#eventual-consistency).

      Parameters

      Returns ApiRequest<Customer>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods