recordVisit

POST

/people/{personId}/visits

const url = 'http://localhost:8080/api/v1/people/per_01j9x3k8m2q4r5s6t7v8w9y0z1/visits';
const options = {
  method: 'POST',
  headers: {cookie: 'hs_session=<hs_session>', 'Content-Type': 'application/json'},
  body: '{"accountId":"per_01j9x3k8m2q4r5s6t7v8w9y0z1","source":"hearth_pick"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:8080/api/v1/people/per_01j9x3k8m2q4r5s6t7v8w9y0z1/visits \
  --header 'Content-Type: application/json' \
  --cookie hs_session=<hs_session> \
  --data '{ "accountId": "per_01j9x3k8m2q4r5s6t7v8w9y0z1", "source": "hearth_pick" }'

The member opened this person on a platform (deep link) or said “I checked in”.

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

personId

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

Request Body^required

application/json

object

accountId

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

source

required

string

Allowed values: hearth_pick story_rail person_page manual extension

Responses

204

Recorded.

recordVisit

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

204

Request Body^required