Skip to main content
POST
Invite affiliate.

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

Store to create the affiliate in.

Body

application/json

Affiliate details (link, percentages, etc.).

Form for affiliates to update or add their own affiliate link

emailAddress
string<email>
required

Represents the email address associated with the form.

Required string length: 1 - 256

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

Maximum string length: 256

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

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

code
string | null

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

data
object

Form for store owners to edit affiliate status.

Last modified on April 6, 2026