H!HOPPA
POST/api/v2/referrals/programs/{programId}/community/members/{userId}/enable

POST /api/v2/referrals/programs/{programId}/community/members/{userId}/enable

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
programId (path)string (uuid)Yes
userId (path)integer (int32)Yes

Request body

application/json

Request body fields
FieldTypeRequiredDescription
PlanstringYes
ParentUserIdunknownNo
ExpiresAtstring (date-time)No
AgreementReferencestringNo
NotesstringNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
UserIdunknownYes
PlanstringYes
ParentUserIdunknownYes
PlanRevisionunknownYes
L2BpsunknownYes
L3BpsunknownYes
EnabledAtstring (date-time)Yes
ExpiresAtstring (date-time)Yes
RevokedAtstring (date-time)Yes
StatusstringYes
AgreementReferencestringYes
NotesstringYes

Example request

curl -X POST "https://{base_url}/api/v2/referrals/programs/{programId}/community/members/{userId}/enable" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Plan":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.