Skip to content
SynupAPI
Get an API key

Interaction__v3

Fields

NameTypeRequiredDescription
idstringoptionalInteraction ID
sourcestringoptionalURL of the interaction site
titlestringoptionalInteraction title
contentstringoptionalInteraction content
authorNamestringoptionalName of interaction author
authorAvatarstringoptionalURL of author's avatar
authorUrlstringoptionalURL of author's profile
ratingintegeroptionalRating value (1-5)
datestringoptionalDate and time of the interaction
permalinkstringoptionalPermanent URL to the interaction
categorystringoptionalCategory of the interaction
ReviewSocial
typestringoptionalType of the interaction
AttractionCommentConversationMessagePhotoPostRecommendationResponseReview
photoUrlstringoptionalURL of attached photo
photoThumbnailUrlstringoptionalURL of photo thumbnail
respondedbooleanoptionalWhether the interaction has been responded to
notesstringoptionalAdditional notes
responsesarray of objectoptionalArray of responses
responses[].idstringoptionalResponse ID
responses[].titlestringoptionalResponse title
responses[].contentstringoptionalResponse content
responses[].authorNamestringoptionalName of responder
responses[].authorAvatarstringoptionalURL of responder's avatar
responses[].authorUrlstringoptionalURL of responder's profile
responses[].datestringoptionalResponse timestamp
responses[].responseStatusstringoptional

Status of the response:

  • CREATED - Response submission created
  • COMPLETED - Response submission completed
  • CONFIRMED - Double confirmation from partner site
  • FAILED - Response submission failed
CREATEDCOMPLETEDCONFIRMEDFAILED
totalResponsesintegeroptionalTotal number of responses
canRespondbooleanoptionalWhether responses are allowed