Skip to main content
POST
Create an affiliate invitation

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Body

application/json

Affiliate invitation payload

email
string
required

The email address to send the affiliate invitation to.

Example:

"partner@example.com"

name
string
required

The display name of the affiliate being invited.

Example:

"Jane Partner"

program_id
string | null

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:

"prog_1234567890"

Response

Successfully created the affiliate invitation

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

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

Example:

"affiliate-invite"

email
string
required

The email address the affiliate was invited with.

Example:

"partner@example.com"

status
string
required

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

Example:

"pending"

created_at
number
required

Creation date of the invitation as a timestamp.

name
string | null

The display name the affiliate was invited with.

Example:

"Jane Partner"