Visits

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

post/public/api/visits

Request

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

Headers

Acceptstring

e.g. application/json

Request body

user_idstring
store_idstring
visit_datestring
group_idsstring[]

Example request

{
  "user_id": "53fb03c6546847ee0d30086a",
  "store_id": "5739b18c6b8e2ac941fbee86",
  "visit_date": "2020-01-28T00:00:00.000Z",
  "group_ids": [
    "test"
  ]
}

Response

OK

visit_idstring required
user_idstring required
creator_idstring required
store_idstring required
visit_datestring required
group_idsstring[] required
created_datestring required
updated_datestring required

Example response

[
  {
    "visit_id": "5e38279864bc4e003a2b56e0",
    "user_id": "53fb03c6546847ee0d30086a",
    "creator_id": "5caf51463a4a9a00547953f8",
    "store_id": "5739b18c6b8e2ac941fbee86",
    "visit_date": "2020-01-28T00:00:00.000Z",
    "group_ids": [
      "test"
    ],
    "created_date": "2020-02-03T14:00:56.976Z",
    "updated_date": "2020-02-03T14:00:56.976Z"
  },
  {
    "visit_id": "5e38279864bc4e003a2b56e0",
    "user_id": "53fb03c6546847ee0d30086b",
    "creator_id": "5caf51463a4a9a00547953f8",
    "store_id": "5739b18c6b8e2ac941fbee87",
    "visit_date": "2020-01-29T00:00:00.000Z",
    "group_ids": [
      "test"
    ],
    "created_date": "2020-02-03T14:00:56.976Z",
    "updated_date": "2020-02-03T14:00:56.976Z"
  }
]

Changes