Core concepts

Members

A member is the person on the organization’s team who records the video: a rep, an agent, a specialist.

Members live in VideoIntros

Each member is set up in VideoIntros with their own profile and photo. The API reads members and names one on a request. It does not create them.

Naming the member on a request

Identify the member by one of:

id: the VideoIntros identifier
external_id: your own identifier, stored on the member
email: the member’s email address

Match your users to members once with GET /v1/members, then send id or external_id.

When an email matches more than one member

Send the member’s id or external_id instead.

By your identifier

{
  "member": {
    "external_id": "rep_456"
  }
}

Response · 422

{
  "error": {
    "code": "member_ambiguous",
    "message": "More than one member has that email address. Send the member's id or external_id instead.",
    "param": "member.email"
  }
}