Skip to main content

Maintaining listing data

These guides walk partners through every task needed to create and maintain listing data for their customers with the Markee API. Each guide groups one scenario, explains the steps in order and links to the endpoints you need.

All guides use the Markee API. Authenticate first as described in Authentication methods.

#GuideUse it to
1Companies and locationsCreate, update and remove companies and locations
2Location profile dataMaintain phones, opening hours, categories, media and Google attributes
3SubscriptionsBook, inspect, change and cancel listing products
4Enhanced Content ListsManage menus, products and services, events and profiles
5Social profile connectionsConnect Google, Facebook and LinkedIn profiles
6Reviews and social postsRead and answer reviews, publish posts
7AnalyticsRetrieve statistics for locations and subscriptions
8Duplicates and listing stateHandle duplicate listings and portal opt-in/out
9Testing and go-liveVerify your integration in the sandbox before going live

Environments​

EnvironmentAPI base URL
Sandboxhttps://qa-api.mark.ee/api
Productionhttps://api.mark.ee/api

Build and test everything against the sandbox first. See Testing and go-live.

Identifiers​

Most endpoints take an id in the path. Its meaning depends on the endpoint, so check which entity is expected.

EntityObtained fromUsed by
Workspace IDProvided during onboardingPOST /company/{id}, GET /company
Company IDPOST CompanyLocations, contracts, enhanced content
Location IDPOST LocationProfile data, subscriptions, listings, reviews
Contract IDGET Contract listLicences
Licence IDGET Licence listPOST /subscription/{id}
Subscription IDPOST SubscriptionSubscription changes, statistics

Conventions​

  • Create and update calls return a Success object. For creates, value holds the new ID. Store it.
  • Lists are paginated with skip/take (take is at most 500 where stated) or after/before for companies.
  • Phone numbers can be sent in any common format, for example +49 911 123456 or 0911 123456. Without an international country code, Germany is assumed.
  • Errors are returned as an Error object with errorCode, errorMessage and, where applicable, the affected fields. Log the full object.