VRPlatformVRPlatform
Contacts

/contacts/{id}/viewers

Invite an owner viewer for an owner contact

POST
/contacts/{id}/viewers
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

email*string
sendEmail?boolean
Defaulttrue
[key: string]?never

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.vrplatform.app/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/viewers" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'
{
  "url": "string",
  "viewer": {
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "status": "active",
    "lastInvitedAt": "2024-01-15T12:30:00.000+00:00",
    "lastSeen": "2024-01-15T12:30:00.000+00:00"
  }
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}