POST /api/v2/visitors
Create a visitor requesting access

Examples

POST /api/v2/visitors
{
  "data": {
    "type": "visitors",
    "attributes": {
      "name": "MyString",
      "company-name": "Google",
      "email": "visitor_email1@example.com",
      "interest": "client.professional",
      "message": null,
      "note": null,
      "referrer-url": null,
      "newsletter-subscription": false
    }
  }
}
201
{
  "data": {
    "id": "1",
    "type": "visitors",
    "links": {
      "self": "http://test.host/api/v2/visitors/1"
    },
    "attributes": {
      "name": "MyString",
      "company-name": "Google",
      "email": "visitor_email1@example.com",
      "interest": "client.professional",
      "message": null,
      "note": null,
      "referrer-url": null,
      "newsletter-subscription": false
    }
  }
}

Params

Param name Description
data
required

Validations:

  • Must be a Hash

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][name]
required

Validations:

  • Must be a String

data[attributes][email]
required

Validations:

  • Must be a String