API Reference
  1. Viv Public API
  2. Referrals

Create referral

post deprecated
https://{apiHost}/api/v2/public/referrals

DEPRECATED — use createReferrer instead; sunset 2026-12-31.

Create a new referrer record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Referrer input for create/update operations

string

Contact person first name

string

Contact person last name

string

Phone number (will be normalized to digits only)

string

Phone extension

string

Fax number (will be normalized to digits only)

string

Fax extension

string

Email address (will be normalized to lowercase)

string

Website URL

string

LinkedIn profile URL

string

Facebook page URL

string

Description/notes about the referrer

string
required

Geographic location ID

string
enum

Referrer status

Allowed:
string

Assigned account manager ID

address
object
string

Entry/access instructions

string

External system identifier

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?