Core concepts

Recipients

The recipient is the customer the Video Intro is for: a homeowner, a buyer, a client.

What Video Intros needs

first_namestringrequired
Used in the script and on the page.
last_namestring
Optional.
phonestringrequired
Mobile number in E.164 form, for example +12405550100.

The first name appears in the member’s script and on the page. The phone number is where the Video Intro is delivered when Video Intros delivers it.

Send only what the moment needs

A recipient is a real person. Send the fields above and nothing else about them. Use your own reference to connect the Video Intro back to the full record in your system.

recipient

{
  "recipient": {
    "first_name": "Andrea",
    "last_name": "Smith",
    "phone": "+12405550100"
  }
}