Contents

requestSignup(for:fields:message:emailConsent:smsConsent:termsAndConditions:)

Opens a form so that the customer can share the contact information for the purpose of sign-up activity.

Declaration

final func requestSignup(for purpose: CustomerEngagementSession.Purpose = .membership, fields: [CustomerEngagementSession.Field], message: String? = nil, emailConsent: CustomerEngagementSession.ConsentOption = .hidden, smsConsent: CustomerEngagementSession.ConsentOption = .hidden, termsAndConditions: String? = nil) async throws -> CustomerEngagement.SignUp

Parameters

  • purpose:

    An enum of pre-defined purpose of the form for .membership, .accountCreation, and .accountUpdate. The default is .membership.

  • fields:

    An array of contact field types on the form. Only .emailAddress and .phoneNumber types are supported.

  • message:

    A multi-line message text below the title.

  • emailConsent:

    A consent option to allow or decline promotions and offers over email channel.

  • smsConsent:

    A consent option to allow or decline promotions and offers over SMS channel.

  • termsAndConditions:

    An optional markdown string to display during the sign-up flow.

Return Value

CustomerEngagement.SignUp contact information shared by the customer.

Discussion

See Also

Requesting and getting customer information