Skip to main content
PUT
/
referrals
Update a referral by ID
curl --request PUT \
  --url https://www.pushlapgrowth.com/api/v1/referrals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "email": "jsmith@example.com",
  "referredUserExternalId": "<string>",
  "plan": "<string>",
  "status": "<string>"
}'
This response does not have an example.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Referral update details

referralId
string<uuid>
required

The referral ID to update

name
string

Name of the referred user

email
string<email>

Email of the referred user

referredUserExternalId
string

The external ID of the referred user. This will be an ID you actively maintain that identifies the user on your server (for example, the User ID in your database, or Stripe Customer ID)

plan
string

The plan associated with the referred user

status
string

Status of the referral (active/inactive)

Response

Referral updated successfully