Invite Affiliate
Invites an affiliate: an affiliate record with no identity (status invited; the identity attaches at the person's first sign-in) and an approved membership in each listed program, or the default program. The invitee's email is checked against the company's rejoin blocks: an exact match is 409 affiliate_banned and writes nothing; a partial match admits the invitee with pending memberships and flagged_for_review. Cookie members require Hms-Company and Hms-Livemode; Idempotency-Key returns 400 invalid_request with idempotency_not_supported_for_member_routes. Bearer callers require Idempotency-Key. Agents cannot write affiliate records.
/affiliates/inviteInvites an affiliate: an affiliate record with no identity (status invited; the identity attaches at the person's first sign-in) and an approved membership in each listed program, or the default program. The invitee's email is checked against the company's rejoin blocks: an exact match is 409 affiliate_banned and writes nothing; a partial match admits the invitee with pending memberships and flagged_for_review. Cookie members require Hms-Company and Hms-Livemode; Idempotency-Key returns 400 invalid_request with idempotency_not_supported_for_member_routes. Bearer callers require Idempotency-Key. Agents cannot write affiliate records.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/affiliates/invite" \ -H "Content-Type: application/json" \ -d '{ "handle": "string", "email": "user@example.com" }'{ "data": { "id": "string", "livemode": true, "handle": "string", "status": "invited", "display_name": "string", "email": "string", "notes": "string", "identity_attached": true, "listed_in_combined_view": true, "customer": { "id": "string", "name": "string", "email": "string" }, "memberships": [ { "program_id": "string", "status": "pending", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "flagged_for_review": true, "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}