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.
Authorizations
API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.
Body
Affiliate invitation payload
The email address to send the affiliate invitation to.
"partner@example.com"
The display name of the affiliate being invited.
"Jane Partner"
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.
"prog_1234567890"
Response
Successfully created the affiliate invitation
Unique identifier for the object.
String representing the environment.
test, prod, sandbox String representing the object's type. Objects of the same type share the same value.
"affiliate-invite"
The email address the affiliate was invited with.
"partner@example.com"
The lifecycle status of the invitation: pending while the invitee has not yet accepted, accepted once they have joined the program.
"pending"
Creation date of the invitation as a timestamp.
The display name the affiliate was invited with.
"Jane Partner"