Delete a referral-reward

DELETE

/referral-rewards/{id}

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Path Parameters

id

required

string

DocumentId

Responses

200

Deleted

object

data

object

referral_code

string

referrer_org_id

string

referee_email

string

reward_type

string

reward_value

number

status

string

Allowed values: pending applied expired

applied_at

string format: date-time

expires_at

string format: date-time

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)

404

Not found