Create a guest

POST 
/api/v1/businesses/:id/guests

Create a guest

Request

Path Parameters

id int32required

application/vnd.api+json

Body

required

data

object

type stringrequired

Possible values: [guests]

attributes

object

email stringrequired

first_name stringrequired

last_name stringrequired

birthday string

phone string

phone_country_code string

phone_country_prefix string

tags string[]

general_note string

visit_note string

Responses

201

Return created guest

application/vnd.api+json

Schema

Schema

data

object

required

id stringrequired

type stringrequired

Possible values: [guests]

links

object

required

self stringrequired

attributes

object

required

email stringrequired

first-name stringrequired

last-name stringrequired

birthday stringnullablerequired

phone stringnullablerequired

phone-country-code stringnullablerequired

phone-country-prefix stringnullablerequired

tags string[]required

general-note stringnullablerequired

visit-note stringnullablerequired

marketing-agreement boolean

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "guests",
    "links": {
      "self": "string"
    },
    "attributes": {
      "email": "string",
      "first-name": "string",
      "last-name": "string",
      "birthday": "string",
      "phone": "string",
      "phone-country-code": "string",
      "phone-country-prefix": "string",
      "tags": [
        "string"
      ],
      "general-note": "string",
      "visit-note": "string",
      "marketing-agreement": true
    }
  }
}

Example

{
  "data": {
    "id": "5c12333e-62ac-4640-af6c-66bf51a86c14",
    "type": "guests",
    "links": {
      "self": "/guests/5c12333e-62ac-4640-af6c-66bf51a86c14"
    },
    "attributes": {
      "email": "john@email.com",
      "first-name": "John",
      "last-name": "Smith",
      "birthday": null,
      "phone": "127834563",
      "phone-country-code": "FR",
      "phone-country-prefix": "33",
      "tags": [],
      "general-note": null,
      "visit-note": null,
      "marketing-agreement": false
    }
  }
}

Loading...