Sign in
latestOpenAPI 3.0.0Commercial2026-08-1951113217.2 KB

11305a63d3c9

Affiliates

Create an affiliate invitation

Invite someone to your affiliate program by email. They receive an invitation email and become an active affiliate once they accept. If program_id is omitted, the invitation is created for your store's affiliate program.

post/v1/affiliates/invites

Request body

emailstring required

The email address to send the affiliate invitation to.

namestring required

The display name of the affiliate being invited.

program_idstring nullable

The ID of the affiliate program to invite into. Optional: when omitted, the invitation falls back to the store's affiliate program. Provide this only if your store runs more than one program.

Example request

{
  "email": "partner@example.com",
  "name": "Jane Partner",
  "program_id": "prog_1234567890"
}

Response

Successfully created the affiliate invitation

idstring required

Unique identifier for the object.

mode'test' | 'prod' | 'sandbox' required

String representing the environment.

objectstring required

String representing the object's type. Objects of the same type share the same value.

emailstring required

The email address the affiliate was invited with.

namestring nullable

The display name the affiliate was invited with.

statusstring required

The lifecycle status of the invitation: pending while the invitee has not yet accepted, accepted once they have joined the program.

created_atnumber required

Creation date of the invitation as a timestamp.

Example response

{
  "object": "affiliate-invite",
  "email": "partner@example.com",
  "name": "Jane Partner",
  "status": "pending"
}