Sign in

v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Affiliate

Invite affiliate.

Invites an affiliate, this will create a customer profile if one does not exist and takes in a customer email address instead. Requires the stores.affiliates.update permission.

post/stores/{storeId}/affiliates/invite

Path parameters

storeIdstring uuid required

Store to create the affiliate in.

Request body

emailAddressstring email required

Represents the email address associated with the form.

linkstring required

A link provided to affiliates for tracking and promotional purposes. Must not exceed 256 characters.

Response

The object was successfully created.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error