PUT/api/v2/admin/referrals/invite-benefits

PUT /api/v2/admin/referrals/invite-benefits

Authentication

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

Parameters

Request parameters
FieldTypeRequiredDescription
companyId (query)unknownNo

Request body

application/json

Request body fields
FieldTypeRequiredDescription
OwnerUserIdunknownNo
ReferredTierIdunknownNo
DiscountCodeIdunknownNo
InheritBenefitsbooleanNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
OwnerUserIdunknownYes
OwnerNamestringYes
OwnerEmailstringYes
ReferralCodestringYes
ReferredTierIdunknownYes
ReferredTierNamestringYes
DiscountCodeIdunknownYes
DiscountCodestringYes
DiscountDescriptionstringYes
InheritBenefitsbooleanYes
UpdatedAtstring (date-time)Yes

Example request

curl -X PUT "https://{base_url}/api/v2/admin/referrals/invite-benefits" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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