You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
customerSignMeUp
Endpoint for registering a new user. By default, it uses the customerSignMeUpDefaultQuery GraphQL query
Signature
export declare function customerSignMeUp(
context: SetupContext,
draft: CustomerSignMeUpDraft,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<CustomerSignMeUpResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
draft | Required | CustomerSignMeUpDraft | User information |
customQuery | Optional | CustomQuery | |
responseOptions | Optional | ResponseOptions |
Returns
User data