YOyoobic
Events

Create

Changed on

You may create a new single or multiple events using this action. When creating a single event object the body contains a json object, when creating multiple events objects the body contains an array of objects.
Warning: a maximum of 1000 items can be sent in a single request.

post/public/api/events

Request

  • Base URL
    https://<base_url>
  • Auth
    HTTP bearer

Headers

Acceptstring

e.g. application/json

Request body

titlestring
descriptionstring
start_datestring
end_datestring
event_typestring
group_idsstring[]
imagesstring[]
categorystring
store_idstring

Example request

{
  "title": "EVENT 1",
  "description": "<div>This is my new description 1</div>",
  "start_date": "2022-05-29T08:00:00.000Z",
  "end_date": "2022-05-29T13:00:00.000Z",
  "event_type": "public",
  "group_ids": [
    "documentation_admin",
    "documentation_stores"
  ],
  "images": [
    "test.jpg"
  ],
  "category": "EVENTCATEGORY1",
  "store_id": "5f3e4be0c920a5003b57bbec"
}

Response

OK

event_idstring required
titlestring required
descriptionstring required
start_datestring required
end_datestring required
event_typestring required
group_idsstring[]
imagesstring[] required
total_usersnumber required
virtual_event_linkstring
addressstring
categorystring required
store_idstring required
user_idsstring[]

Example response

[
  {
    "event_id": "5f3e4be0c920a5003b57bbed",
    "title": "EVENT 1",
    "description": "<div>This is my new description 1</div>",
    "start_date": "2022-05-29T08:00:00.000Z",
    "end_date": "2022-05-29T13:00:00.000Z",
    "event_type": "public",
    "group_ids": [
      "documentation_admin",
      "documentation_stores"
    ],
    "images": [
      "test1.jpg"
    ],
    "total_users": 100,
    "virtual_event_link": "https://www.google.com",
    "address": "1234, 5th Avenue, New York",
    "category": "EVENTCATEGORY1",
    "store_id": "5f3e4be0c920a5003b57bbec"
  },
  {
    "event_id": "5f3e4be0c920a5003b57bbdd",
    "title": "EVENT 2",
    "description": "<div>This is my new description 2</div>",
    "start_date": "2022-05-29T08:00:00.000Z",
    "end_date": "2022-05-29T13:00:00.000Z",
    "event_type": "private",
    "user_ids": [
      "5f3e4be0c920a5003b52bbec",
      "5f3e4be0c920a5002b57bced"
    ],
    "total_users": 2,
    "images": [
      "test2.jpg"
    ],
    "category": "EVENTCATEGORY2",
    "store_id": "5f3e4be0c920a5003b57bbec"
  }
]

Changes

  • 283b710c9a52Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      added the media type application/json for the response with the status

  • acd097fdd2f1Revision changes
    • info

      the endpoint scheme security oauth2 was removed from the API