# Vytemes

You can use the /v2/vytemes endpoints to manage the Vyte Page of your users.

# The vyteme object

Attributes

  • nickname string

    Nickname for the user Vyte Page. The nickname is the last part of the path to access the Vyte booking page. Ex: if the nickname is john-doe, the booking page will be accessible at https://vyte.in/john-doe.

  • message string

    Message shown on the Vyte page.

  • belongs_to string

    The id of the user who own the Vyte Page.

  • secondary boolean

    Set to true if you want to set a second Vyte page for the user. Secondary Vyte Pages can only be set and customized through the API.

  • active boolean

    Whether or not the Vyte page is active.

  • custom hash

    Custom settings for the user Vyte Page.

    + Show child attributes

    • custom. auto_message string

      Auto response message when someone book a meeting on the Vyte Page.

    • custom. auto_title string

      Auto title for the event.

    • custom. ask_phone boolean

      Whether or not the user must the user must provide their phone number.

    • custom. ask_company boolean

      Whether or not the user must the user must provide their company.

    • custom. block_new_invitee boolean

      If enabled, it prevents people that have booked events on that Vyte booking page to add other invitees to those events. Defaults to false.

    • custom. duration number

      Default duration for the event.

    • custom. set_lang boolean

      Only use if you only accept bookings in one language.

    • custom. enable_api bollean

      To enable API variables.

    • custom. fixed_lang string

      Fixed lang expressed according to ISO 639-1 and the available languages are : fr, en, es, it, pt, de, sv, nl.

    • custom. set_timezone boolean

      Only use if you only accept bookings from people on your own timezone.

    • custom. fixed_timezone string

      Fixed timezone expressed according to TZ database name.

    • custom. event_hide_decline number

      Allow you to set how long (in hours) before the begining of the event the decline button will be hidden. Ex: if set to 24, the decline button will be hidden on the event page 24h before the confirmed date of the event.

    • custom. hide_places boolean

      Hide places from the booking page.

    • custom. hide_support boolean

      Hide Vyte support button from the booking page (recommended for an integration).

    • custom. hide_title boolean

      Whether or not people booking can set a title / subject for the event.

    • custom. forbid_add_places boolean

      Whether or not you forbid from suggesting other places from the booking page.

    • custom. min_dates number

      Enforces a minimum number of slots on the booking page (only works for calendar vie, not slots view).

    • custom. one_slot boolean

      Whether or not only one slot can be suggested on the calendar view.

    • custom. auto_confirm boolean

      Whether or not the event will be booked as confirmed automatically.

    • custom. invite_title string

      Customize the wording on the booking page.

    • custom. redirect_url string

      Url to redirect people after the booking is made.

    • custom. fixed_places array of hashes

      Set up a list of places on the booking page

      + Show child attributes

      • custom.fixed_places. name string

        Name for the place.

      • custom.fixed_places. adress string

        Address for the place.

      • custom.fixed_places. source string

        Source of the place.

      • custom.fixed_places. source_id string

        Id of the place in your own database/source.

THE VYTEME OBJECT

{
  "nickname": "john-doe-acme",
  "message": "Welcome to my booking page",
  "belongs_to": "5f1b018dc1ac5dc46efc0139",
  "secondary": false,
  "active": true,
  "custom": {
    "auto_message": "Thank you for your booking. See you soon.",
    "auto_title": "RDV {{invitee}} / {{me}}",
    "ask_phone": true,
    "ask_company": false,
    "block_new_invitee": false,
    "duration": 30,
    "set_lang": true,
    "enable_api": true,
    "fixed_lang": "en",
    "set_timezone": true,
    "fixed_timezone": "Europe/London",
    "event_hide_decline": false,
    "hide_places": false,
    "hide_support": true,
    "hide_title": true,
    "forbid_add_places": true,
    "min_dates": 1,
    "one_slot": true,
    "auto_confirm": true,
    "invite_title": "Book a short appointment with",
    "redirect_url": "https://www.example.com/thanks-for-booking",
    "fixed_places": [
      {
        "name": "Office",
        "address": "Office address",
        "source": "appName",
        "source_id": "placeIdInThirdPartyAppDatabase"
      },
      {
        "name": "Phone",
        "address": "0102030405"
      }
    ]
  }
}

# Retrieve a vyteme

ENDPOINT Authorization apiKey

GET /v2/vytemes/:nickname HTTP/1.1

Path parameters

  • nickname string

    The nickname of the Vyte Page.

Query parameters

No parameters.

    Returns

    An Vyteme object if there is no error.

    CODE SAMPLE

    curl \
    --request GET 'https://api.vyte.in/v2/vytemes/john-doe-acme' \
    --header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
    

    RESPONSE SAMPLE

    {
      "nickname": "john-doe-acme",
      "message": "Welcome to my booking page",
      "secondary": false,
      "active": true,
      "custom": {
        "auto_message": "Thank you for your booking. See you soon.",
        "auto_title": "RDV {{invitee}} / {{me}}",
        "ask_phone": true,
        "ask_company": false,
        "block_new_invitee": false,
        "duration": 30,
        "set_lang": true,
        "enable_api": true,
        "fixed_lang": "en",
        "set_timezone": true,
        "fixed_timezone": "Europe/London",
        "event_hide_decline": false,
        "hide_places": false,
        "hide_support": true,
        "hide_title": true,
        "forbid_add_places": true,
        "min_dates": 1,
        "one_slot": true,
        "auto_confirm": true,
        "invite_title": "Book a short appointment with",
        "redirect_url": "https://www.example.com/thanks-for-booking",
        "fixed_places": [
          {
            "name": "Office",
            "address": "Office address",
            "source": "appName",
            "source_id": "placeIdInThirdPartyAppDatabase"
          },
          {
            "name": "Phone",
            "address": "0102030405"
          }
        ]
      }
    }
    

    # Create a vyteme

    ENDPOINT Authorization apiKey

    POST /v2/vytemes HTTP/1.1
    

    Path parameters

    No parameters.

      Query parameters

      No parameters.

        Body parameters

        • nickname string required

          Nickname for the user Vyte Page.

        • message string

          Message shown on the Vyte page.

        • belongs_to string required

          The id of the user who own the Vyte Page.

        • secondary boolean default to false

          Set to true if you want to set a second Vyte page for the user. Secondary Vyte Pages can only be set and customized through the API.

        • active boolean default to true

          Whether or not the Vyte page is active.

        • custom hash

          Custom settings for the user Vyte Page.

          + Show child attributes

          • custom. auto_message string

            Auto response message when someone book a meeting on the Vyte Page.

          • custom. auto_title string

            Auto title for the event.

          • custom. ask_phone boolean

            Whether or not the user must the user must provide their phone number.

          • custom. ask_company boolean

            Whether or not the user must the user must provide their company.

          • custom. block_new_invitee boolean

            If enabled, it prevents people that have booked events on that Vyte booking page to add other invitees to those events. Defaults to false.

          • custom. duration number

            Default duration for the event.

          • custom. set_lang boolean

            Only use if you only accept bookings in one language.

          • custom. enable_api bollean

            To enable API variables.

          • custom. fixed_lang string

            Fixed lang expressed according to ISO 639-1 and the available languages are : fr, en, es, it, pt, de, sv, nl.

          • custom. set_timezone boolean

            Only use if you only accept bookings from people on your own timezone.

          • custom. fixed_timezone string

            Fixed timezone expressed according to TZ database name.

          • custom. event_hide_decline number

            Allow you to set how long (in hours) before the begining of the event the decline button will be hidden. Ex: if set to 24, the decline button will be hidden on the event page 24h before the confirmed date of the event.

          • custom. hide_places boolean

            Hide places from the booking page.

          • custom. hide_support boolean

            Hide Vyte support button from the booking page (recommended for an integration).

          • custom. hide_title boolean

            Whether or not people booking can set a title / subject for the event.

          • custom. forbid_add_places boolean

            Whether or not you forbid from suggesting other places from the booking page.

          • custom. min_dates number

            Enforces a minimum number of slots on the booking page (only works for calendar vie, not slots view).

          • custom. one_slot boolean

            Whether or not only one slot can be suggested on the calendar view.

          • custom. auto_confirm boolean

            Whether or not the event will be booked as confirmed automatically.

          • custom. invite_title string

            Customize the wording on the booking page.

          • custom. redirect_url string

            Url to redirect people after the booking is made.

          • custom. fixed_places array of hashes

            Set up a list of places on the booking page

            + Show child attributes

            • custom.fixed_places. name string

              Name for the place.

            • custom.fixed_places. adress string

              Address for the place.

            • custom.fixed_places. source string

              Source of the place.

            • custom.fixed_places. source_id string

              Id of the place in your own database/source.

        Returns

        The created Vyteme object if no error occurred.

        CODE SAMPLE

        curl \
        --request POST 'https://api.vyte.in/v2/vytemes' \
        --header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
        --header 'Content-Type: application/json' \
        --data-raw '{
          "nickname": "john-doe-acme",
          "message": "Welcome to my booking page",
          "custom": {
            "auto_message": "Thank you for your booking. See you soon.",
            "auto_title": "RDV {{invitee}} / {{me}}",
            "ask_phone": true,
            "ask_company": false,
            "block_new_invitee": false,
            "duration": 30,
            "set_lang": true,
            "enable_api": true,
            "fixed_lang": "en",
            "set_timezone": true,
            "fixed_timezone": "Europe/London",
            "event_hide_decline": false,
            "hide_places": false,
            "hide_support": true,
            "hide_title": true,
            "forbid_add_places": true,
            "min_dates": 1,
            "one_slot": true,
            "auto_confirm": true,
            "invite_title": "Book a short appointment with",
            "redirect_url": "https://www.example.com/thanks-for-booking",
            "fixed_places": [
              {
                "name": "Office",
                "address": "Office address",
                "source": "appName",
                "source_id": "placeIdInThirdPartyAppDatabase"
              },
              {
                "name": "Phone",
                "address": "0102030405"
              }
            ]
          }
        }'
        

        RESPONSE SAMPLE

        {
          "nickname": "john-doe-acme",
          "message": "Welcome to my booking page",
          "secondary": false,
          "active": true,
          "custom": {
            "auto_message": "Thank you for your booking. See you soon.",
            "auto_title": "RDV {{invitee}} / {{me}}",
            "ask_phone": true,
            "ask_company": false,
            "block_new_invitee": false,
            "duration": 30,
            "set_lang": true,
            "enable_api": true,
            "fixed_lang": "en",
            "set_timezone": true,
            "fixed_timezone": "Europe/London",
            "event_hide_decline": false,
            "hide_places": false,
            "hide_support": true,
            "hide_title": true,
            "forbid_add_places": true,
            "min_dates": 1,
            "one_slot": true,
            "auto_confirm": true,
            "invite_title": "Book a short appointment with",
            "redirect_url": "https://www.example.com/thanks-for-booking",
            "fixed_places": [
              {
                "name": "Office",
                "address": "Office address",
                "source": "appName",
                "source_id": "placeIdInThirdPartyAppDatabase"
              },
              {
                "name": "Phone",
                "address": "0102030405"
              }
            ]
          }
        }
        

        # Update a vyteme

        ENDPOINT Authorization apiKey

        PUT /v2/vytemes/:nickname HTTP/1.1
        

        Path parameters

        • nickname string

          The nickname of the Vyte Page.

        Query parameters

        No parameters.

          Body parameters

          • nickname string

            Nickname for the user Vyte Page. The nickname is the last part of the path to access the Vyte booking page. Ex: if the nickname is john-doe, the booking page will be accessible at https://vyte.in/john-doe.

          • message string

            Message shown on the Vyte page.

          • belongs_to string

            The id of the user who own the Vyte Page.

          • secondary boolean default to false

            Set to true if you want to set a second Vyte page for the user. Secondary Vyte Pages can only be set and customized through the API.

          • active boolean default to true

            Whether or not the Vyte page is active.

          • custom hash

            Custom settings for the user Vyte Page.

            + Show child attributes

            • custom. auto_message string

              Auto response message when someone book a meeting on the Vyte Page.

            • custom. auto_title string

              Auto title for the event.

            • custom. ask_phone boolean

              Whether or not the user must the user must provide their phone number.

            • custom. ask_company boolean

              Whether or not the user must the user must provide their company.

            • custom. block_new_invitee boolean

              If enabled, it prevents people that have booked events on that Vyte booking page to add other invitees to those events. Defaults to false.

            • custom. duration number

              Default duration for the event.

            • custom. set_lang boolean

              Only use if you only accept bookings in one language.

            • custom. enable_api bollean

              To enable API variables.

            • custom. fixed_lang string

              Fixed lang expressed according to ISO 639-1 and the available languages are : fr, en, es, it, pt, de, sv, nl.

            • custom. set_timezone boolean

              Only use if you only accept bookings from people on your own timezone.

            • custom. fixed_timezone string

              Fixed timezone expressed according to TZ database name.

            • custom. event_hide_decline number

              Allow you to set how long (in hours) before the begining of the event the decline button will be hidden. Ex: if set to 24, the decline button will be hidden on the event page 24h before the confirmed date of the event.

            • custom. hide_places boolean

              Hide places from the booking page.

            • custom. hide_support boolean

              Hide Vyte support button from the booking page (recommended for an integration).

            • custom. hide_title boolean

              Whether or not people booking can set a title / subject for the event.

            • custom. forbid_add_places boolean

              Whether or not you forbid from suggesting other places from the booking page.

            • custom. min_dates number

              Enforces a minimum number of slots on the booking page (only works for calendar vie, not slots view).

            • custom. one_slot boolean

              Whether or not only one slot can be suggested on the calendar view.

            • custom. auto_confirm boolean

              Whether or not the event will be booked as confirmed automatically.

            • custom. invite_title string

              Customize the wording on the booking page.

            • custom. redirect_url string

              Url to redirect people after the booking is made.

            • custom. fixed_places array of hashes

              Set up a list of places on the booking page

              + Show child attributes

              • custom.fixed_places. name string

                Name for the place.

              • custom.fixed_places. adress string

                Address for the place.

              • custom.fixed_places. source string

                Source of the place.

              • custom.fixed_places. source_id string

                Id of the place in your own database/source.

          Returns

          The updated Vyteme object if no error occurred.

          CODE SAMPLE

          curl \
          --request PUT 'https://api.vyte.in/v2/vytemes/john-doe-acme' \
          --header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
          --header 'Content-Type: application/json' \
          --data-raw '{
            "nickname": "john-doe-acme",
            "message": "Welcome to my booking page",
            "custom": {
              "auto_message": "Thank you for your booking. See you soon.",
              "auto_title": "RDV {{invitee}} / {{me}}",
              "ask_phone": true,
              "ask_company": false,
              "block_new_invitee": false,
              "duration": 30,
              "set_lang": true,
              "enable_api": true,
              "fixed_lang": "en",
              "set_timezone": true,
              "fixed_timezone": "Europe/London",
              "event_hide_decline": false,
              "hide_places": false,
              "hide_support": true,
              "hide_title": true,
              "forbid_add_places": true,
              "min_dates": 1,
              "one_slot": true,
              "auto_confirm": true,
              "invite_title": "Book a short appointment with",
              "redirect_url": "https://www.example.com/thanks-for-booking",
              "fixed_places": [
                {
                  "name": "Office",
                  "address": "Office address",
                  "source": "appName",
                  "source_id": "placeIdInThirdPartyAppDatabase"
                },
                {
                  "name": "Phone",
                  "address": "0102030405"
                }
              ]
            }
          }'
          

          RESPONSE SAMPLE

          {
            "nickname": "john-doe-acme",
            "message": "Welcome to my booking page",
            "secondary": false,
            "active": true,
            "custom": {
              "auto_message": "Thank you for your booking. See you soon.",
              "auto_title": "RDV {{invitee}} / {{me}}",
              "ask_phone": true,
              "ask_company": false,
              "block_new_invitee": false,
              "duration": 30,
              "set_lang": true,
              "enable_api": true,
              "fixed_lang": "en",
              "set_timezone": true,
              "fixed_timezone": "Europe/London",
              "event_hide_decline": false,
              "hide_places": false,
              "hide_support": true,
              "hide_title": true,
              "forbid_add_places": true,
              "min_dates": 1,
              "one_slot": true,
              "auto_confirm": true,
              "invite_title": "Book a short appointment with",
              "redirect_url": "https://www.example.com/thanks-for-booking",
              "fixed_places": [
                {
                  "name": "Office",
                  "address": "Office address",
                  "source": "appName",
                  "source_id": "placeIdInThirdPartyAppDatabase"
                },
                {
                  "name": "Phone",
                  "address": "0102030405"
                }
              ]
            }
          }
          

          # Delete a vyteme

          ENDPOINT Authorization apiKey

          DELETE /v2/vytemes/:nickname HTTP/1.1
          

          Path parameters

          • nickname string

            The nickname of the Vyte Page.

          Query parameters

          No parameters.

            Returns

            Returns an object containing the number of row affected and the status if there is no error, and returns an error otherwise.

            curl --request DELETE 'https://api.vyte.in/v2/vytemes/john-doe-acme' \
            --header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0'
            

            RESPONSE SAMPLE

            {
              "n": 1,
              "ok": 1
            }