Suggestions | Hitchhikers

Suggestion: Upsert

Create a suggestion via API.

NOTE:

If a suggestion already exists from your app on the specified field, the suggestion will be updated.
Suggestions on categories and keywords fields, as well ECLs are not currently supported.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
format	string >= 0 characters Default: "markdown" The formatting language used to parse rich text field values. Present and required if an only if the request contains a field with type "Rich Text." Valid values: `markdown` `html`

Request Body schema: application/json

The suggestion to be upserted

required

object

Responses

Request samples

Payload

Content type

application/json

{"entityFieldSuggestion": {"entity": {"id": "string",
"uid": "string",
"language": "string"
},
"suggestedContent": {"EntityType": "string",
"meta": {"countryCode": "string",
"folderId": "string",
"id": "string",
"labels": ["string"
],
"language": "string"
},
"name": "string",
"address": {"city": "string",
"countryCode": "string",
"extraDescription": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"postalCode": "string",
"region": "string",
"sublocality": "string"
},
"accessHours": {"friday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"holidayHours": [{"date": "2019-08-24",
"isClosed": true,
"isRegularHours": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
}
],
"monday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"reopenDate": "2019-08-24",
"saturday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"sunday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"thursday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"tuesday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"wednesday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
}
},
"additionalHoursText": "string",
"alternateNames": ["string"
],
"alternatePhone": "string",
"alternateWebsites": ["http://example.com"
],
"categoryIds": ["string"
],
"closed": true,
"customKeywords": ["string"
],
"description": "stringstri",
"displayCoordinate": {"latitude": -90,
"longitude": -180
},
"driveThroughHours": {"friday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"holidayHours": [{"date": "2019-08-24",
"isClosed": true,
"isRegularHours": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
}
],
"monday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"reopenDate": "2019-08-24",
"saturday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"sunday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"thursday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"tuesday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"wednesday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
}
},
"dropoffCoordinate": {"latitude": -90,
"longitude": -180
},
"facebookCallToAction": {"type": "NONE",
"value": "string"
},
"facebookCoverPhoto": {"alternateText": "string",
"url": "http://example.com"
},
"facebookDescriptor": "string",
"facebookName": "string",
"facebookOverrideCity": "string",
"facebookPageUrl": "string",
"facebookProfilePhoto": {"alternateText": "string",
"url": "http://example.com"
},
"facebookVanityUrl": "string",
"fax": "string",
"featuredMessage": {"description": "string",
"url": "http://example.com"
},
"frequentlyAskedQuestions": [{"answer": "string",
"question": "string"
}
],
"geomodifier": "string",
"googleAttributes": { },
"googleCoverPhoto": {"alternateText": "string",
"url": "http://example.com"
},
"googleMyBusinessLabels": ["string"
],
"googlePlaceId": "string",
"googleProfilePhoto": {"alternateText": "string",
"url": "http://example.com"
},
"googleWebsiteOverride": "http://example.com",
"holidayHoursConversationEnabled": true,
"hours": {"friday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"holidayHours": [{"date": "2019-08-24",
"isClosed": true,
"isRegularHours": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
}
],
"monday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"reopenDate": "2019-08-24",
"saturday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"sunday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"thursday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"tuesday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
},
"wednesday": {"isClosed": true,
"openIntervals": [{"end": "14:15:22Z",
"start": "14:15:22Z"
}
]
}
},
"impressum": "string",
"isoRegionCode": "string",
"keywords": ["string"
],
"labels": ["string"
],
"landingPageUrl": "http://example.com",
"localPhone": "string",
"locatedIn": "string",
"locationType": "LOCATION",
"logo": {"clickthroughUrl": "http://example.com",
"description": "string",
"details": "string",
"image": {"alternateText": "string",
"url": "http://example.com"
}
},
"mainPhone": "string",
"mobilePhone": "string",
"nudgeEnabled": true,
"photoGallery": [{"clickthroughUrl": "http://example.com",
"description": "string",
"details": "string",
"image": {"alternateText": "string",
"url": "http://example.com"
}
}
],
"pickupCoordinate": {"latitude": -90,
"longitude": -180
},
"priceRange": "UNSPECIFIED",
"primaryConversationContact": "string",
"questionsAndAnswers": true,
"rankTrackingCompetitors": [{"name": "string",
"website": "http://example.com"
}
],
"rankTrackingEnabled": true,
"rankTrackingFrequency": "WEEKLY",
"rankTrackingQueryTemplates": ["KEYWORD"
],
"rankTrackingSites": ["GOOGLE_DESKTOP"
],
"reviewResponseConversationEnabled": true,
"routableCoordinate": {"latitude": -90,
"longitude": -180
},
"timezone": "string",
"tollFreePhone": "string",
"ttyPhone": "string",
"walkableCoordinate": {"latitude": -90,
"longitude": -180
},
"websiteUrl": {"displayUrl": "http://example.com",
"preferDisplayUrl": true,
"url": "http://example.com"
}
}
}
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}