Invite Partner

POST
/v1/partner-invitations

Invite a partner to an affiliate Program by email. RefRef sends the invitation email; only a user with this email can accept it. The optional name only pre-fills the name that the partner enters. A write applies at once. Needs the partners:write key permission.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/partner-invitations" \  -H "Content-Type: application/json" \  -d '{    "programId": "string",    "email": "string",    "projectId": "string"  }'
{  "success": true,  "data": {    "partnerRequestId": "string",    "emailQueued": true  }}