Create a check-in
Allows you to check in to a place.
Requires Acting UserYes (learn more)
Modes supportedswarm (learn more)
All parameters are optional, unless otherwise indicated.
venueIdIHR8THISVNUrequired The venue where the user is checking in. Find venue IDs by searching or from historical APIs.
eventIdUHR8THISVNTThe event the user is checking in to.
shoutThere are crayons! Crayons!A message about your check-in. The maximum length of this field is 140 characters.
mentions5,10,HZXXY3Y;15,20,GZYYZ3Z;25,30,fbu-GZXY13YMentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based.
broadcastpublic,twitterWho to broadcast this check-in to. Accepts a comma-delimited list of values:
  • private (off the grid) or public (share with friends)
  • facebook share on facebook
  • twitter share on twitter
  • followers share with followers (celebrity mode users only)
If no valid value is found, the default is public.
ll33.7,44.2Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in.
llAcc1Accuracy of the user's latitude and longitude, in meters.
alt0Altitude of the user's location, in meters.
altAcc1Vertical accuracy of the user's location, in meters.
Response fields
checkinA checkin object.
notificationsA post-checkin notifications object.