{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/synup/main/json-schema/synup-schemas.json", "title": "Synup API v4 component schemas", "description": "The 222 reusable component schemas Synup publishes across its per-endpoint OpenAPI documents on developer.synup.com, extracted verbatim into one JSON Schema bundle. Derived from openapi/synup-api-openapi.yml.", "x-generated": "2026-08-13", "x-method": "derived", "x-source": "openapi/synup-api-openapi.yml", "$defs": { "ActionChip": { "type": "object", "properties": { "label": { "type": "string" }, "emoji": { "type": "string" }, "action": { "type": "string" } }, "x-apidog-orders": [ "label", "emoji", "action" ], "x-apidog-folder": "" }, "ChatSession": { "type": "object", "properties": { "id": { "type": "string" }, "socialProfileId": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "messageCount": { "type": "integer" }, "title": { "type": "string" }, "createdAt": { "type": "string" } }, "x-apidog-orders": [ "id", "socialProfileId", "mode", "status", "messageCount", "title", "createdAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "AddCustomersRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "reviewCampaignId", "locationCustomers" ], "properties": { "reviewCampaignId": { "type": "string" }, "locationCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInput" } } }, "x-apidog-orders": [ "reviewCampaignId", "locationCustomers" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "input" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CustomerInput": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" } }, "x-apidog-orders": [ "name", "email", "phone" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "AddLocationsInput": { "type": "object", "required": [ "userId", "locationIds" ], "properties": { "userId": { "type": "string", "description": "ID of the user to associate locations with", "examples": [ "VXNlcjoxMjMyMDE=" ] }, "locationIds": { "type": "array", "items": { "type": "string" }, "description": "Array of location IDs to associate with the user", "examples": [ [ "TG9jYXRpb246MTE3NjE5NQ==", "TG9jYXRpb246MTE0NzgxNA==" ] ] } }, "x-apidog-orders": [ "userId", "locationIds" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "AddLocationsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "addLocationsForUser": { "type": "object", "properties": { "status": { "type": "array", "items": { "$ref": "#/components/schemas/LocationAddStatus" } } }, "x-apidog-orders": [ "status" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "addLocationsForUser" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationAddStatus": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "description": "Array of error messages if any occurred", "nullable": true }, "locationId": { "type": "string", "description": "ID of the location being added" }, "success": { "type": "boolean", "description": "Indicates if the location was successfully added" } }, "x-apidog-orders": [ "errors", "locationId", "success" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CoordinateInput": { "type": "object", "required": [ "lat", "lon", "gridX", "gridY" ], "properties": { "lat": { "type": "number" }, "lon": { "type": "number" }, "gridX": { "type": "integer" }, "gridY": { "type": "integer" }, "isWater": { "type": "boolean" } }, "x-apidog-orders": [ "lat", "lon", "gridX", "gridY", "isWater" ], "x-apidog-folder": "" }, "AddKeywordRequest": { "type": "object", "required": [ "locationId", "accountId", "keyword", "gridDistance", "unit", "coordinates" ], "properties": { "locationId": { "type": "integer" }, "accountId": { "type": "integer" }, "keyword": { "type": "string" }, "gridDistance": { "type": "number" }, "unit": { "type": "string" }, "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/CoordinateInput" } }, "placeId": { "type": "string" }, "businessName": { "type": "string" } }, "x-apidog-orders": [ "locationId", "accountId", "keyword", "gridDistance", "unit", "coordinates", "placeId", "businessName" ], "x-apidog-folder": "" }, "AddKeywordResult": { "type": "object", "properties": { "keywordId": { "type": "integer" }, "status": { "type": "string", "description": "\"queued\" or \"quota_exceeded\"." } }, "x-apidog-orders": [ "keywordId", "status" ], "x-apidog-folder": "" }, "AddOnCount": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "count": { "type": "integer" } }, "x-apidog-orders": [ "id", "name", "count" ], "x-apidog-folder": "" }, "RankPoint": { "type": "object", "properties": { "rank": { "type": "number", "description": "Rank at this coordinate (-1 if not ranked)" }, "latitude": { "type": "number", "format": "float", "description": "Latitude of the grid point" }, "longitude": { "type": "number", "format": "float", "description": "Longitude of the grid point" } }, "x-apidog-orders": [ "rank", "latitude", "longitude" ], "x-apidog-folder": "" }, "GridReport": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Report ID" }, "locationId": { "type": "string", "description": "Location ID" }, "accountId": { "type": "string", "description": "Account ID" }, "keyword": { "type": "string", "description": "Keyword used for rank analysis" }, "businessName": { "type": "string", "description": "Exact name of the business in Google Maps" }, "businessStreet": { "type": "string", "description": "Street address of the business" }, "businessCity": { "type": "string", "description": "City of the business" }, "businessState": { "type": "string", "description": "State of the business" }, "businessCountry": { "type": "string", "description": "Country of the business" }, "gridSize": { "type": "integer", "enum": [ 3, 5, 7 ], "description": "Size of the grid used for analysis" }, "gridDistance": { "type": "number", "description": "Grid distance value" }, "gridDistanceUnit": { "type": "string", "enum": [ "mi", "km" ], "description": "Unit of grid distance measurement" }, "gridDistanceInKm": { "type": "number", "format": "float", "description": "Grid distance converted to kilometers" }, "ranks": { "type": "array", "items": { "$ref": "#/components/schemas/RankPoint" }, "description": "Array of ranking results for each coordinate" }, "averageRank": { "type": "number", "format": "float", "description": "Average rank across all grid points" }, "topOneShare": { "type": "number", "format": "float", "description": "Percentage of coordinates with rank <= 3" }, "topTwoShare": { "type": "number", "format": "float", "description": "Percentage of coordinates with rank <= 10" }, "status": { "type": "string", "enum": [ "PROCESSING", "COMPLETED" ], "description": "Current status of the report" }, "latitude": { "type": "number", "format": "float", "description": "Business latitude coordinate" }, "longitude": { "type": "number", "format": "float", "description": "Business longitude coordinate" }, "placeId": { "type": "string", "description": "Google Place ID of the business", "nullable": true }, "createdAt": { "type": "string", "description": "Epoch timestamp in milliseconds" } }, "x-apidog-orders": [ "id", "locationId", "accountId", "keyword", "businessName", "businessStreet", "businessCity", "businessState", "businessCountry", "gridSize", "gridDistance", "gridDistanceUnit", "gridDistanceInKm", "ranks", "averageRank", "topOneShare", "topTwoShare", "status", "latitude", "longitude", "placeId", "createdAt" ], "x-apidog-folder": "" }, "AllGridReportsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "gridrankReportsByLocationId": { "type": "array", "items": { "$ref": "#/components/schemas/GridReport" } } }, "x-apidog-orders": [ "gridrankReportsByLocationId" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "AnalyticsOverview": { "type": "object", "properties": { "data": { "type": "object", "properties": { "interactionsAnalyticsStats": { "type": "object", "properties": { "stats": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "total-reviews", "new-reviews", "overall-rating", "review-response-rate" ] }, "value": { "type": "number" }, "delta": { "type": "number" } }, "x-apidog-orders": [ "name", "value", "delta" ] } } }, "x-apidog-orders": [ "stats" ] } }, "x-apidog-orders": [ "interactionsAnalyticsStats" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "AnalyticsTimeline": { "type": "object", "properties": { "data": { "type": "object", "properties": { "interactionsChartData": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "interactionCount": { "type": "integer" }, "averageRating": { "type": "number", "nullable": true } }, "x-apidog-orders": [ "date", "interactionCount", "averageRating" ] } } }, "x-apidog-orders": [ "data" ] } }, "x-apidog-orders": [ "interactionsChartData" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "ReferenceImageAnalysis": { "type": "object", "properties": { "description": { "type": "string", "description": "Textual description of the analyzed image." } }, "x-apidog-orders": [ "description" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "AppleConfirmedMatches": { "type": "object", "properties": { "matches": { "type": "array", "items": { "$ref": "#/components/schemas/AppleConfirmedMatch" } }, "matchesCount": { "type": "integer", "description": "Total number of matches." }, "pages": { "type": "integer", "description": "Total number of pages." } }, "x-apidog-orders": [ "matches", "matchesCount", "pages" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "AppleConfirmedMatch": { "type": "object", "properties": { "id": { "type": "string" }, "appleBusinessId": { "type": "string" }, "connectedAccountId": { "type": "string" }, "connectedAccountLabel": { "type": "string" }, "connectedAccountsLocationId": { "type": "string" }, "lakeRecordId": { "type": "string" }, "matchedOn": { "type": "string", "format": "date-time" }, "synupLocationId": { "type": "integer" } }, "x-apidog-orders": [ "id", "appleBusinessId", "connectedAccountId", "connectedAccountLabel", "connectedAccountsLocationId", "lakeRecordId", "matchedOn", "synupLocationId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "AppleConnectedListingInfo": { "type": "object", "description": "Connected listing details when the source is Apple", "properties": { "name": { "type": "string" }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "storeCode": { "type": "string", "nullable": true }, "liveLink": { "type": "string", "nullable": true } }, "x-apidog-orders": [ "name", "street", "city", "state", "zip", "country", "phone", "storeCode", "liveLink" ], "x-apidog-folder": "" }, "MutationError": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "contextInfo": { "type": "array", "items": { "type": "object", "x-apidog-orders": [] } } }, "x-apidog-orders": [ "code", "message", "contextInfo" ], "x-apidog-folder": "" }, "AppleOauthBulkPayload": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string", "description": "OAuth link to redirect the user to (1-day TTL)." }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/MutationError" } }, "clientMutationId": { "type": "string" } }, "x-apidog-orders": [ "success", "url", "errors", "clientMutationId" ], "x-apidog-folder": "" }, "AppleOauthBulkRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "successUrl", "errorUrl" ], "properties": { "successUrl": { "type": "string", "description": "Redirect URL on successful authorization." }, "errorUrl": { "type": "string", "description": "Redirect URL on failed authorization." }, "platform": { "type": "string", "description": "`local` (default) or `social`." }, "entityId": { "type": "string", "description": "Brand ID when platform is `social`." }, "onboarding": { "type": "boolean" }, "clientMutationId": { "type": "string" } }, "x-apidog-orders": [ "successUrl", "errorUrl", "platform", "entityId", "onboarding", "clientMutationId" ] } }, "x-apidog-orders": [ "input" ], "x-apidog-folder": "" }, "AppleOauthPayload": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string", "description": "OAuth link to redirect the user to (1-day TTL)." }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/MutationError" } }, "clientMutationId": { "type": "string" } }, "x-apidog-orders": [ "success", "url", "errors", "clientMutationId" ], "x-apidog-folder": "" }, "AppleOauthRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "locationId", "successUrl", "errorUrl" ], "properties": { "locationId": { "type": "string", "description": "Relay-encoded location ID to connect." }, "successUrl": { "type": "string", "description": "Redirect URL on successful authorization." }, "errorUrl": { "type": "string", "description": "Redirect URL on failed authorization." }, "clientMutationId": { "type": "string" } }, "x-apidog-orders": [ "locationId", "successUrl", "errorUrl", "clientMutationId" ] } }, "x-apidog-orders": [ "input" ], "x-apidog-folder": "" }, "AppleRenewOauthPayload": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string", "description": "OAuth renewal link to redirect the user to (1-day TTL)." }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/MutationError" } }, "clientMutationId": { "type": "string" } }, "x-apidog-orders": [ "success", "url", "errors", "clientMutationId" ], "x-apidog-folder": "" }, "AppleRenewOauthRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "successUrl" ], "properties": { "locationId": { "type": "string", "description": "Relay-encoded location ID of the connection to renew." }, "connectedAccountId": { "type": "string", "description": "ID of the connected Apple account to renew (alternative to locationId)." }, "successUrl": { "type": "string", "description": "Redirect URL on successful re-authorization." }, "clientMutationId": { "type": "string" } }, "x-apidog-orders": [ "locationId", "connectedAccountId", "successUrl", "clientMutationId" ] } }, "x-apidog-orders": [ "input" ], "x-apidog-folder": "" }, "BadRequestError": { "type": "object", "properties": { "data": { "type": "object", "properties": { "archiveKeyword": { "type": null } }, "x-apidog-orders": [ "archiveKeyword" ], "x-apidog-ignore-properties": [] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Invalid keyword ID provided" ] } }, "x-apidog-orders": [ "message" ], "x-apidog-ignore-properties": [] } } }, "x-apidog-orders": [ "data", "errors" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UnauthorizedError": { "type": "object", "properties": { "data": { "type": "object", "properties": { "archiveKeyword": { "type": null } }, "x-apidog-orders": [ "archiveKeyword" ], "x-apidog-ignore-properties": [] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "SY90001: Not authorized to access this resource" ] } }, "x-apidog-orders": [ "message" ], "x-apidog-ignore-properties": [] } } }, "x-apidog-orders": [ "data", "errors" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ArchiveIdeaRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" } }, "x-apidog-orders": [ "ideaId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "MutationResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Error": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "contextInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "x-apidog-orders": [ "key", "value" ], "x-apidog-ignore-properties": [] } } }, "x-apidog-orders": [ "message", "code", "contextInfo" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ArchiveLocalIdeaRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" } }, "x-apidog-orders": [ "ideaId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalMutationResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "$ref": "#/components/schemas/LocalError" } }, "x-apidog-orders": [ "success", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalError": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "contextInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "x-apidog-orders": [ "key", "value" ], "x-apidog-ignore-properties": [] } } }, "x-apidog-orders": [ "message", "code", "contextInfo" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ArchiveLocalSeriesRequest": { "type": "object", "required": [ "seriesId" ], "properties": { "seriesId": { "type": "string" } }, "x-apidog-orders": [ "seriesId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ArchiveSeriesRequest": { "type": "object", "required": [ "seriesId" ], "properties": { "seriesId": { "type": "string" } }, "x-apidog-orders": [ "seriesId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationAdvancedSearchFilterType": { "type": "object", "properties": { "country": { "type": "array", "description": "Countries present across the account's locations.", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "state": { "type": "array", "description": "States present across the account's locations.", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "city": { "type": "array", "items": { "type": "string" } }, "zipcode": { "type": "array", "items": { "type": "string" } }, "customAttrs": { "type": "array", "description": "Custom attribute names defined for the account.", "items": { "type": "string" } } }, "x-apidog-orders": [ "country", "state", "city", "zipcode", "customAttrs" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationSearchFilterType": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "folders": { "type": "array", "items": { "type": "string" } }, "categories": { "type": "array", "items": { "type": "string" } }, "additionalCategories": { "type": "array", "items": { "type": "string" } }, "primaryGbpSiteCategories": { "type": "array", "items": { "$ref": "#/components/schemas/SitePublisherCategory" } }, "additionalGbpSiteCategories": { "type": "array", "items": { "$ref": "#/components/schemas/SitePublisherCategory" } } }, "x-apidog-orders": [ "tags", "folders", "categories", "additionalCategories", "primaryGbpSiteCategories", "additionalGbpSiteCategories" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SitePublisherCategory": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the category." }, "value": { "type": "integer", "description": "Internal numeric identifier of the category." }, "id": { "type": "string", "description": "GBP site category identifier." } }, "x-apidog-orders": [ "name", "value", "id" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "BranchChatSessionRequest": { "type": "object", "required": [ "parentSessionId", "subjectType" ], "properties": { "parentSessionId": { "type": "string" }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" } }, "x-apidog-orders": [ "parentSessionId", "subjectType", "subjectId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ChatSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "session": { "$ref": "#/components/schemas/ChatSession" }, "suggestions": { "type": "array", "items": { "type": "string" } }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "session", "suggestions", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "BranchLocalChatSessionRequest": { "type": "object", "required": [ "parentSessionId" ], "properties": { "parentSessionId": { "type": "string" }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" } }, "x-apidog-orders": [ "parentSessionId", "subjectType", "subjectId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalChatSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "session": { "$ref": "#/components/schemas/LocalChatSession" }, "suggestions": { "type": "array", "items": { "type": "string" } }, "error": { "$ref": "#/components/schemas/LocalError" } }, "x-apidog-orders": [ "success", "session", "suggestions", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalChatSession": { "type": "object", "properties": { "id": { "type": "string" }, "locationId": { "type": "integer" }, "mode": { "type": "string" }, "status": { "type": "string" }, "messageCount": { "type": "integer" }, "title": { "type": "string" }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "x-apidog-orders": [ "id", "locationId", "mode", "status", "messageCount", "title", "subjectType", "subjectId", "createdAt", "updatedAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "BrandInfo": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "siteUrl": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "country": { "type": "string" } }, "x-apidog-orders": [ "id", "name", "siteUrl", "categories", "country" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Business hours": { "type": "object", "properties": { "businessHours": { "type": "array", "description": "Business hours for each day of the week", "items": { "type": "object", "properties": { "day": { "type": "string", "description": "Day of the week | Special", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY", "SPECIAL" ], "x-apidog-enum": [ { "value": "MONDAY", "name": "", "description": "" }, { "value": "TUESDAY", "name": "", "description": "" }, { "value": "WEDNESDAY", "name": "", "description": "" }, { "value": "THURSDAY", "name": "", "description": "" }, { "value": "FRIDAY", "name": "", "description": "" }, { "value": "SATURDAY", "name": "", "description": "" }, { "value": "SUNDAY", "name": "", "description": "" }, { "value": "SPECIAL", "name": "", "description": "" } ] }, "slots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "description": "Opening time. Valid formats: `:am` OR `:pm` " }, "end": { "type": "string", "description": "Closing time. Valid formats: `:am` OR `:pm` " } }, "x-apidog-orders": [ "start", "end" ], "title": "" }, "description": "Array of time slots (minimum 1, maximum 2). Required only if type is OPEN.", "title": "" }, "type": { "type": "string", "description": "Type of business hours (e.g., OPEN, CLOSED, OPEN_24x7)", "enum": [ "OPEN", "OPEN_24x7", "CLOSED" ], "x-apidog-enum": [ { "value": "OPEN", "name": "", "description": "" }, { "value": "OPEN_24x7", "name": "", "description": "" }, { "value": "CLOSED", "name": "", "description": "" } ] }, "specialDate": { "type": "string", "description": "Day should be `SPECIAL`. Regular hours is mandatory. \n**Regular hours is mandatory for special hours to be allowed **" } }, "x-apidog-orders": [ "day", "slots", "type", "specialDate" ], "required": [ "type", "slots", "day" ] } } }, "x-apidog-orders": [ "businessHours" ], "x-apidog-folder": "" }, "BusinessHours": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY", "SPECIAL" ] }, "type": { "type": "string", "enum": [ "OPEN", "CLOSED", "OPEN_24x7" ] }, "slots": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "description": "Opening time in format HH:MMam/pm", "examples": [ "09:00am" ] }, "end": { "type": "string", "description": "Closing time in format HH:MMam/pm", "examples": [ "05:00pm" ] } }, "x-apidog-orders": [ "start", "end" ] }, "nullable": true }, "specialDate": { "type": "string", "format": "date", "description": "Date for special hours", "nullable": true } }, "x-apidog-orders": [ "day", "type", "slots", "specialDate" ], "x-apidog-folder": "" }, "CalendarDay": { "type": "object", "properties": { "day": { "type": "integer" }, "posts": { "type": "array", "description": "Post ideas for the day (see Post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } } }, "x-apidog-orders": [ "day", "posts" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CampaignStat": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "emails_sent", "sms_sent", "invite_open_rate", "clicks_rate", "customer_exp_score" ] }, "value": { "type": "string" } }, "x-apidog-orders": [ "name", "value" ], "x-apidog-folder": "" }, "ChatMessage": { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string" }, "content": { "type": "string" }, "messageType": { "type": "string" }, "metadata": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "sequence": { "type": "integer" }, "createdAt": { "type": "string" } }, "x-apidog-orders": [ "id", "role", "content", "messageType", "metadata", "sequence", "createdAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ChatMessageResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "$ref": "#/components/schemas/ChatMessage" }, "postCard": { "type": "object", "description": "Generated post idea card (see Post idea for the full shape), when produced.", "x-apidog-orders": [] }, "seriesPlan": { "type": "object", "description": "Content-series plan, when produced.", "x-apidog-orders": [] }, "actionChips": { "type": "array", "items": { "$ref": "#/components/schemas/ActionChip" } }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "message", "postCard", "seriesPlan", "actionChips", "error" ], "x-apidog-folder": "" }, "CloseChatSessionRequest": { "type": "object", "required": [ "sessionId" ], "properties": { "sessionId": { "type": "string" } }, "x-apidog-orders": [ "sessionId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CloseLocalChatSessionRequest": { "type": "object", "required": [ "sessionId" ], "properties": { "sessionId": { "type": "string" } }, "x-apidog-orders": [ "sessionId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ConfirmMatchesRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "matchRecordIds" ], "properties": { "matchRecordIds": { "type": "array", "description": "Array of base64 encoded match record IDs.\nFor GMB accounts: Encode `GmbLocationMatchedData:{matchedDataDatabaseId}`\nFor FB accounts: Encode `FbLocationMatchedData:{matchedDataDatabaseId}`\n", "minItems": 1, "items": { "type": "string", "pattern": "^[A-Za-z0-9+/=]+$", "examples": [ "R21iTG9jYXRpb25NYXRjaGVkRGF0YTplNGZhNTFkYi04NWEwLTRjYzItYjdmMS01OWNhMzQ1NjlhZWM=" ] } } }, "x-apidog-orders": [ "matchRecordIds" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "input" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ConfirmMatchesResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "confirmConnectMatches": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Indicates if all match records were confirmed successfully.\nReturns false if any match failed to confirm.\n" }, "failedIds": { "type": "array", "description": "List of original (non-encoded) match record IDs that failed to confirm.\nOnly present when some matches fail.\n", "items": { "type": "string", "format": "uuid", "examples": [ "e4fa51db-85a0-4cc2-b7f1-59ca34569aec" ] } } }, "x-apidog-orders": [ "success", "failedIds" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "confirmConnectMatches" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ConnectListingRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "locationId", "connectedAccountId", "connectedAccountListingId" ], "properties": { "locationId": { "type": "string", "description": "Base64 encoded location ID", "pattern": "^[A-Za-z0-9+/=]+$", "examples": [ "TG9jYXRpb246NzM5MzM=" ] }, "connectedAccountId": { "type": "string", "format": "uuid", "description": "ID of the connected account", "examples": [ "3db66afa-151d-4212-a8b7-949f9fe9aaf9" ] }, "connectedAccountListingId": { "type": "string", "description": "ID of the listing from the fetch listings API response.\nThis is typically a base64 encoded string.\n", "pattern": "^[A-Za-z0-9+/=]+$", "examples": [ "R21iQnVsa0RhdGFMYWtlOmMyMWRiOWY5LTZmYTctNDE0My1hNDU2LTQzMjZkMmZiN2UwZg==" ] } }, "x-apidog-orders": [ "locationId", "connectedAccountId", "connectedAccountListingId" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "input" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ConnectListingResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectListing": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Indicates if the connection was successful" }, "message": { "type": "string", "description": "Error message if the connection failed.\nReturns null on successful connection.\n", "examples": [ "Internal System Error" ], "nullable": true } }, "x-apidog-orders": [ "success", "message" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "connectListing" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ConnectedAccount": { "type": "object", "properties": { "connectedAccountId": { "type": "string", "description": "Unique identifier of the connected account" }, "connectedAccountType": { "type": "string", "enum": [ "GoogleAccount", "FacebookAccount" ], "description": "Type of the connected account" }, "connectedLocationsCount": { "type": "integer", "description": "Number of locations connected with this account" }, "connectivityIssue": { "type": "string", "description": "Type of connectivity issue if any:\n* `CONNECTED_LOCATIONS_ISSUE` - Connected to inaccessible listings\n* `CREDENTIALS_INVALIDATED` - Expired credentials\n", "nullable": true }, "email": { "type": "string", "format": "email", "description": "Email address associated with the connected account" }, "lastFetchMatchesRequestedAt": { "type": "string", "format": "date-time", "description": "Timestamp of the last matches request" }, "requestMatches": { "type": "boolean", "description": "Indicates if the account can trigger matches" }, "requestMatchesStatus": { "type": "string", "description": "Status of the last request matches triggered" }, "status": { "type": "string", "enum": [ "CONNECTED", "ConnectionIssue" ], "description": "Current connection status" }, "remarks": { "type": "string", "description": "Additional information about account status or errors", "nullable": true } }, "x-apidog-orders": [ "connectedAccountId", "connectedAccountType", "connectedLocationsCount", "connectivityIssue", "email", "lastFetchMatchesRequestedAt", "requestMatches", "requestMatchesStatus", "status", "remarks" ], "x-apidog-folder": "" }, "ConnectedAccountDetailsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectedAccountDetails": { "type": "object", "properties": { "details": { "type": "object", "properties": { "connectedAccountId": { "type": "string", "format": "uuid", "description": "ID of the connected account" }, "connectedAccountType": { "type": "string", "enum": [ "GoogleAccount", "FacebookAccount" ], "description": "Type of the connected account" }, "connectedLocationsCount": { "type": "integer", "description": "Number of locations connected with the account" }, "connectivityIssue": { "type": "string", "description": "Connection error message if any", "nullable": true }, "email": { "type": "string", "format": "email", "description": "Email of the user for the connected account" }, "lastFetchMatchesRequestedAt": { "type": "string", "format": "date-time", "description": "Timestamp when the last matches requests were fetched" }, "requestMatches": { "type": "boolean", "description": "Indicates whether the connected account can trigger for matches" }, "requestMatchesStatus": { "type": "string", "enum": [ "MATCH_COMPLETED", "MATCH_IN_PROGRESS", "MATCH_FAILED" ], "description": "Status of the last request matches triggered" }, "status": { "type": "string", "enum": [ "CONNECTED", "DISCONNECTED", "CONNECTION_ISSUE" ], "description": "Connection status of the connected account" }, "remarks": { "type": "string", "description": "Connected Account Fetch Status Error", "nullable": true } }, "required": [ "connectedAccountId", "connectedAccountType", "connectedLocationsCount", "email", "requestMatches", "status" ], "x-apidog-orders": [ "connectedAccountId", "connectedAccountType", "connectedLocationsCount", "connectivityIssue", "email", "lastFetchMatchesRequestedAt", "requestMatches", "requestMatchesStatus", "status", "remarks" ] } }, "x-apidog-orders": [ "details" ] } }, "x-apidog-orders": [ "connectedAccountDetails" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "ConnectedAccountsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectedAccountsInfo": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccount" } } }, "x-apidog-orders": [ "pageInfo", "records" ] } }, "x-apidog-orders": [ "connectedAccountsInfo" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "PageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean", "description": "Indicates if there are more pages available" }, "hasPreviousPage": { "type": "boolean", "description": "Indicates if there are previous pages available" }, "totalPages": { "type": "integer", "description": "Total number of pages available" }, "totalRecords": { "type": "integer", "description": "Total number of records across all pages" } }, "x-apidog-orders": [ "hasNextPage", "hasPreviousPage", "totalPages", "totalRecords" ], "x-apidog-folder": "" }, "ConnectFacebookInput": { "type": "object", "required": [ "errorUrl", "successUrl" ], "properties": { "errorUrl": { "type": "string", "description": "Redirect URL in case of Error" }, "successUrl": { "type": "string", "description": "Redirect URL in case of Success" } }, "x-apidog-orders": [ "errorUrl", "successUrl" ], "x-apidog-folder": "" }, "ConnectFacebookResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "bulkConnectLinkForFacebook": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "success": { "type": "boolean" }, "url": { "type": "string" } }, "x-apidog-orders": [ "errors", "success", "url" ] } }, "x-apidog-orders": [ "bulkConnectLinkForFacebook" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "ConnectGoogleInput": { "type": "object", "required": [ "errorUrl", "successUrl" ], "properties": { "errorUrl": { "type": "string", "description": "Redirect URL in case of Error" }, "successUrl": { "type": "string", "description": "Redirect URL in case of Success" } }, "x-apidog-orders": [ "errorUrl", "successUrl" ], "x-apidog-folder": "" }, "ConnectGoogleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "bulkConnectLinkForGoogle": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "success": { "type": "boolean" }, "url": { "type": "string" } }, "x-apidog-orders": [ "errors", "success", "url" ] } }, "x-apidog-orders": [ "bulkConnectLinkForGoogle" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "SuggestedLocationInfo": { "type": "object", "properties": { "liveLink": { "type": "string", "description": "Live link to the location profile", "nullable": true }, "locationInfo": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } }, "x-apidog-orders": [ "city", "country", "name", "phone", "postalCode", "state", "street" ] }, "mainAccount": { "type": "string", "description": "Name of the main account" }, "mainAccountId": { "type": "string", "description": "ID of the main account", "nullable": true }, "storeCode": { "type": "string", "nullable": true }, "subAccount": { "type": "string", "nullable": true }, "ownerRole": { "type": "string", "description": "GBP role of the connecting/importing user on this listing (e.g. PRIMARY_OWNER, OWNER, MANAGER, SITE_MANAGER). Google (GMB) only; null when Google exposes no matching admin or for non-Google listings.", "nullable": true } }, "x-apidog-orders": [ "liveLink", "locationInfo", "mainAccount", "mainAccountId", "storeCode", "subAccount", "ownerRole" ], "x-apidog-folder": "" }, "LocationInfo": { "type": "object", "properties": { "approved": { "type": "boolean", "description": "Whether the location is approved" }, "name": { "type": "string", "description": "Location name" }, "street": { "type": "string", "description": "Street address line 1", "nullable": true }, "street1": { "type": "string", "description": "Street address line 2", "nullable": true }, "city": { "type": "string", "description": "City", "nullable": true }, "postalCode": { "type": "string", "description": "Postal / ZIP code", "nullable": true }, "countryIso": { "type": "string", "description": "ISO country code (e.g. `IN`, `US`)", "nullable": true }, "storeCode": { "type": "string", "description": "Store code of the location, if set", "nullable": true }, "liveLink": { "type": "string", "description": "Public live link of the location's listing on the source", "nullable": true } }, "x-apidog-orders": [ "approved", "name", "street", "street1", "city", "postalCode", "countryIso", "storeCode", "liveLink" ], "x-apidog-folder": "" }, "ConnectionSuggestion": { "type": "object", "properties": { "accountEmail": { "type": "string", "format": "email", "description": "Email of the user for the connected account" }, "accountType": { "type": "string", "enum": [ "GMB", "FB" ], "description": "Type of the connected account (GMB for Google My Business, FB for Facebook)" }, "connectedAccountId": { "type": "string", "format": "uuid", "description": "ID of the connected account" }, "locationId": { "type": "string", "description": "ID of the location" }, "locationInfo": { "$ref": "#/components/schemas/LocationInfo" }, "matchedDataDatabaseId": { "type": "string", "description": "ID of the suggestion record, used for confirming the match" }, "suggestedLocationInfo": { "$ref": "#/components/schemas/SuggestedLocationInfo" } }, "x-apidog-orders": [ "accountEmail", "accountType", "connectedAccountId", "locationId", "locationInfo", "matchedDataDatabaseId", "suggestedLocationInfo" ], "x-apidog-folder": "" }, "ConnectionSuggestionsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectionSuggestionsForAccount": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionSuggestion" } } }, "x-apidog-orders": [ "pageInfo", "records" ] } }, "x-apidog-orders": [ "connectionSuggestionsForAccount" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "Contact Support": { "type": "object", "properties": { "support_email": { "type": "string" } }, "required": [ "support_email" ], "x-apidog-orders": [ "support_email" ], "x-apidog-folder": "" }, "ContentSeries": { "type": "object", "properties": { "id": { "type": "string" }, "socialProfileId": { "type": "string" }, "name": { "type": "string" }, "theme": { "type": "string" }, "status": { "type": "string" }, "postCount": { "type": "integer" }, "publishedCount": { "type": "integer" }, "unpublishedCount": { "type": "integer" }, "posts": { "type": "array", "description": "Posts in the series (see Post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "chatSessionId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "x-apidog-orders": [ "id", "socialProfileId", "name", "theme", "status", "postCount", "publishedCount", "unpublishedCount", "posts", "chatSessionId", "createdAt", "updatedAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationResponseSchema": { "type": "object", "properties": { "accountId": { "type": "integer" }, "additionalCategoryIds": { "type": "array", "items": { "type": "string" } }, "additionalInfo": { "type": "null" }, "additionalPhones": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean" }, "archivedAt": { "type": "null" }, "billingPeriod": { "type": "null" }, "bizUrl": { "type": "string", "nullable": true }, "bookingUrl": { "type": "string", "nullable": true }, "categoryId": { "type": "integer" }, "city": { "type": "string" }, "countryIso": { "type": "string" }, "customAttributes": { "type": "array", "items": { "type": "object", "properties": { "archived": { "type": "boolean" }, "enumValues": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } }, "x-apidog-orders": [ "archived", "enumValues", "name", "slug", "type", "value" ], "x--orders": [ "archived", "enumValues", "name", "slug", "type", "value" ], "x--ignore-properties": [] } }, "databaseId": { "type": "integer" }, "description": { "type": "string" }, "facebookUrl": { "type": "string", "nullable": true }, "folderId": { "type": "string" }, "folderName": { "type": "string" }, "googleAdsPhone": { "type": "string" }, "googleplusUrl": { "type": "null" }, "hideAddress": { "type": "boolean" }, "id": { "type": "string" }, "instagramUrl": { "type": "string", "nullable": true }, "isRestaurant": { "type": "boolean" }, "latitude": { "type": "number" }, "linkedinUrl": { "type": "string" }, "locationPhotos": { "type": "array", "items": { "type": "string" } }, "longitude": { "type": "number" }, "moreHours": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "offeringsUrl": { "type": "string", "nullable": true }, "ownerEmail": { "type": "string" }, "ownerName": { "type": "string" }, "package": { "type": "string" }, "paymentMethods": { "type": "array", "items": { "type": "string" } }, "phone": { "type": "string" }, "pinterestUrl": { "type": "string" }, "planId": { "type": "integer" }, "planName": { "type": "string" }, "postalCode": { "type": "string" }, "publisherAttributes": { "type": "array", "items": { "type": "string" } }, "reservationUrl": { "type": "string" }, "serviceItems": { "type": "array", "items": { "type": "string" } }, "stateIso": { "type": "string" }, "storeId": { "type": "null" }, "street": { "type": "string" }, "street1": { "type": "string" }, "subCategory": { "type": "object", "properties": { "databaseId": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "databaseId", "id", "name", "primary" ], "x-apidog-orders": [ "databaseId", "id", "name", "primary" ], "x--orders": [ "databaseId", "id", "name", "primary" ], "x--ignore-properties": [] }, "subCategoryId": { "type": "integer" }, "subCategoryName": { "type": "string" }, "tagline": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "temporarilyClosed": { "type": "boolean" }, "tiktokUrl": { "type": "null" }, "toplineMessage": { "type": "null" }, "toplineMessageText": { "type": "null" }, "twitterUrl": { "type": "string" }, "videos": { "type": "array", "items": { "type": "string" } }, "yearOfIncorporation": { "type": "integer" }, "youtubeUrl": { "type": "null" }, "placeActionLinks": { "type": "array", "items": { "type": "object", "properties": { "placeActionType": { "type": "string", "enum": [ "FOOD_ORDERING FOOD_ORDERING", "ONLINE_APPOINTMENT", "APPOINTMENT", "DINING_RESERVATION", "FOOD_DELIVERY", "FOOD_TAKEOUT", "SHOP_ONLINE" ], "x-apidog-enum": [ { "value": "FOOD_ORDERING FOOD_ORDERING", "name": "", "description": "" }, { "value": "ONLINE_APPOINTMENT", "name": "", "description": "" }, { "value": "APPOINTMENT", "name": "", "description": "" }, { "value": "DINING_RESERVATION", "name": "", "description": "" }, { "value": "FOOD_DELIVERY", "name": "", "description": "" }, { "value": "FOOD_TAKEOUT", "name": "", "description": "" }, { "value": "SHOP_ONLINE", "name": "", "description": "" } ] }, "uri": { "type": "string" }, "isPreferred": { "type": "boolean" }, "name": { "type": "string" }, "submissionStatus": { "type": "string" }, "submissionMessage": { "type": "string" }, "lastSubmittedAt": { "type": "string" }, "isEditable": { "type": "string" } }, "x-apidog-orders": [ "placeActionType", "uri", "isPreferred", "name", "submissionStatus", "submissionMessage", "lastSubmittedAt", "isEditable" ], "required": [ "placeActionType", "uri" ], "x--orders": [ "placeActionType", "uri", "isPreferred", "name", "submissionStatus", "submissionMessage", "lastSubmittedAt", "isEditable" ], "x--ignore-properties": [] } }, "discoveredPlaceActionLinks": { "type": "array", "items": { "type": "object", "properties": { "placeActionType": { "type": "string" }, "uri": { "type": "string" }, "isPreferred": { "type": "boolean" }, "name": { "type": "string" }, "providerType": { "type": "string" }, "isEditable": { "type": "boolean" } }, "x-apidog-orders": [ "placeActionType", "uri", "isPreferred", "name", "providerType", "isEditable" ], "required": [ "placeActionType", "uri", "isPreferred", "name", "providerType", "isEditable" ], "x--orders": [ "placeActionType", "uri", "isPreferred", "name", "providerType", "isEditable" ], "x--ignore-properties": [] } } }, "required": [ "accountId", "additionalCategoryIds", "additionalInfo", "additionalPhones", "archived", "archivedAt", "billingPeriod", "categoryId", "city", "countryIso", "customAttributes", "databaseId", "description", "folderId", "folderName", "googleAdsPhone", "googleplusUrl", "hideAddress", "id", "latitude", "locationPhotos", "longitude", "moreHours", "name", "ownerEmail", "ownerName", "package", "paymentMethods", "phone", "pinterestUrl", "planId", "planName", "postalCode", "publisherAttributes", "reservationUrl", "serviceItems", "stateIso", "storeId", "street", "street1", "subCategory", "subCategoryId", "subCategoryName", "tagline", "tags", "temporarilyClosed", "tiktokUrl", "toplineMessage", "toplineMessageText", "twitterUrl", "videos", "yearOfIncorporation", "youtubeUrl" ], "x-apidog-orders": [ "accountId", "additionalCategoryIds", "additionalInfo", "additionalPhones", "archived", "archivedAt", "billingPeriod", "bizUrl", "bookingUrl", "categoryId", "01JW6M5BJGNZ18EAK11FHYJF6H", "city", "countryIso", "customAttributes", "databaseId", "description", "facebookUrl", "folderId", "folderName", "googleAdsPhone", "googleplusUrl", "hideAddress", "id", "instagramUrl", "isRestaurant", "latitude", "linkedinUrl", "locationPhotos", "longitude", "moreHours", "name", "offeringsUrl", "ownerEmail", "ownerName", "package", "paymentMethods", "phone", "pinterestUrl", "planId", "planName", "postalCode", "publisherAttributes", "reservationUrl", "serviceItems", "stateIso", "storeId", "street", "street1", "subCategory", "subCategoryId", "subCategoryName", "tagline", "tags", "temporarilyClosed", "tiktokUrl", "toplineMessage", "toplineMessageText", "twitterUrl", "videos", "yearOfIncorporation", "youtubeUrl", "placeActionLinks", "discoveredPlaceActionLinks" ], "x-apidog-refs": { "01JW6M5BJGNZ18EAK11FHYJF6H": { "$ref": "#/components/schemas/Business%20hours" } }, "x--orders": [ "accountId", "additionalCategoryIds", "additionalInfo", "additionalPhones", "archived", "archivedAt", "billingPeriod", "bizUrl", "bookingUrl", "categoryId", "city", "countryIso", "customAttributes", "databaseId", "description", "facebookUrl", "folderId", "folderName", "googleAdsPhone", "googleplusUrl", "hideAddress", "id", "instagramUrl", "isRestaurant", "latitude", "linkedinUrl", "locationPhotos", "longitude", "moreHours", "name", "offeringsUrl", "ownerEmail", "ownerName", "package", "paymentMethods", "phone", "pinterestUrl", "planId", "planName", "postalCode", "publisherAttributes", "reservationUrl", "serviceItems", "stateIso", "storeId", "street", "street1", "subCategory", "subCategoryId", "subCategoryName", "tagline", "tags", "temporarilyClosed", "tiktokUrl", "toplineMessage", "toplineMessageText", "twitterUrl", "videos", "yearOfIncorporation", "youtubeUrl", "placeActionLinks", "discoveredPlaceActionLinks" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "CreateFolderRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Unique name for the folder" }, "parentFolderName": { "type": "string", "description": "Name of the parent folder (optional)" }, "parentFolder": { "type": "string", "description": "UUID of the parent folder (optional)" } }, "x-apidog-orders": [ "name", "parentFolderName", "parentFolder" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "input" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CreateFolderResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createFolder": { "type": "object", "properties": { "clientMutationId": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "folder": { "$ref": "#/components/schemas/Folder" }, "success": { "type": "boolean" } }, "x-apidog-orders": [ "clientMutationId", "errors", "folder", "success" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "createFolder" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Folder": { "type": "object", "properties": { "accountId": { "type": "integer", "description": "ID of the account owning this folder" }, "archived": { "type": "boolean", "description": "Whether the folder is archived" }, "createdAt": { "type": "string", "description": "UTC timestamp of folder creation" }, "id": { "type": "string", "description": "Unique identifier (UUID) of the folder" }, "locationCount": { "type": "integer", "description": "Number of locations in this folder", "nullable": true }, "name": { "type": "string", "description": "Name of the folder" }, "root": { "type": "boolean", "description": "Whether this is the root folder" } }, "x-apidog-orders": [ "accountId", "archived", "createdAt", "id", "locationCount", "name", "root" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CreateReviewCampaignRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "locationId", "name", "locationCustomers" ], "properties": { "locationId": { "type": "string", "description": "Encoded Location ID" }, "name": { "type": "string", "description": "Review Campaign Name" }, "locationCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInput" }, "description": "Campaign customers to create\t" }, "screening": { "type": "boolean", "description": "Flag for screening enabled/disabled" }, "landingPageTemplate": { "$ref": "#/components/schemas/LandingPageTemplate", "description": "Landing page template(Use only when screening = true).\t" }, "openingEmailTemplate": { "$ref": "#/components/schemas/EmailTemplate", "description": "Template for the very first email sent out.\t" }, "smsTemplate": { "$ref": "#/components/schemas/SMSTemplate", "description": "Template for the very first SMS sent out.\t" } }, "x-apidog-orders": [ "locationId", "name", "locationCustomers", "screening", "landingPageTemplate", "openingEmailTemplate", "smsTemplate" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "input" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SMSTemplate": { "type": "object", "properties": { "content": { "type": "string" }, "reviewSiteHash": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewSite" }, "description": "Max 1 for smsTemplate\nNot required when screening is true" } }, "x-apidog-orders": [ "content", "reviewSiteHash" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ReviewSite": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string", "description": "URL for connected sites (maps.google.com, facebook.com, foursquare.com) or custom sites" } }, "x-apidog-orders": [ "name", "url" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "EmailTemplate": { "type": "object", "properties": { "replyTo": { "type": "string", "format": "email" }, "subject": { "type": "string" }, "heading": { "type": "string" }, "content": { "type": "string" }, "reviewSiteHash": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewSite" }, "description": "Not required when screening is true" } }, "x-apidog-orders": [ "replyTo", "subject", "heading", "content", "reviewSiteHash" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LandingPageTemplate": { "type": "object", "properties": { "content": { "type": "string" }, "heading": { "type": "string" }, "reviewSiteHash": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewSite" } } }, "x-apidog-orders": [ "content", "heading", "reviewSiteHash" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CreateContentSeriesRequest": { "type": "object", "required": [ "socialProfileId", "name" ], "properties": { "socialProfileId": { "type": "string" }, "name": { "type": "string" }, "theme": { "type": "string" }, "postIdeaIds": { "type": "array", "items": { "type": "string" } } }, "x-apidog-orders": [ "socialProfileId", "name", "theme", "postIdeaIds" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CreateGridReportInput": { "type": "object", "required": [ "locationId", "keywords", "businessName", "businessStreet", "businessCity", "businessState", "businessCountry", "latitude", "longitude", "distance", "distanceUnit", "gridSize" ], "properties": { "locationId": { "type": "string", "description": "Base64 encoded location ID" }, "keywords": { "type": "array", "items": { "type": "string" }, "maxItems": 25, "description": "Keywords for analysis of rank for the business (maximum 25)" }, "businessName": { "type": "string", "description": "Exact name of the business in Google Maps" }, "businessStreet": { "type": "string", "description": "Street address of the business" }, "businessCity": { "type": "string", "description": "City of the business" }, "businessState": { "type": "string", "description": "State of the business" }, "businessCountry": { "type": "string", "description": "Country of the business" }, "latitude": { "type": "number", "format": "float", "description": "Latitude coordinate of the business" }, "longitude": { "type": "number", "format": "float", "description": "Longitude coordinate of the business" }, "distance": { "type": "number", "description": "Grid Distance" }, "distanceUnit": { "type": "string", "enum": [ "mi", "km" ], "description": "Distance unit (mi for Miles, km for Kilometers)" }, "gridSize": { "type": "integer", "enum": [ 3, 5, 7 ], "description": "Size of the grid for analysis" } }, "x-apidog-orders": [ "locationId", "keywords", "businessName", "businessStreet", "businessCity", "businessState", "businessCountry", "latitude", "longitude", "distance", "distanceUnit", "gridSize" ], "x--orders": [ "locationId", "keywords", "businessName", "businessStreet", "businessCity", "businessState", "businessCountry", "latitude", "longitude", "distance", "distanceUnit", "gridSize" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "CreateGridReportResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createGridrankReport": { "type": "object", "properties": { "data": { "type": "object", "properties": { "reportIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of created report IDs" } }, "x-apidog-orders": [ "reportIds" ], "x--orders": [ "reportIds" ], "x--ignore-properties": [] }, "errors": { "type": "string", "description": "Error message if request failed", "nullable": true } }, "x-apidog-orders": [ "data", "errors" ], "x--orders": [ "data", "errors" ], "x--ignore-properties": [] } }, "x-apidog-orders": [ "createGridrankReport" ], "x--orders": [ "createGridrankReport" ], "x--ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x--orders": [ "data" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "CreateUserInput": { "type": "object", "required": [ "email", "roleId", "firstName", "directCustomer" ], "properties": { "email": { "type": "string", "format": "email", "description": "User's email address" }, "roleId": { "type": "string", "description": "ID of the role to assign to the user" }, "firstName": { "type": "string", "description": "User's first name" }, "directCustomer": { "type": "boolean", "description": "Indicates if the user is a direct customer" } }, "x-apidog-orders": [ "email", "roleId", "firstName", "directCustomer" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CreateUserResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "addUser": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the user creation was successful" }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Array of error messages if any" }, "user": { "$ref": "#/components/schemas/CreatedUser" } }, "x-apidog-orders": [ "success", "errors", "user" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "addUser" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CreatedUser": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the created user" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the user was created" }, "directCustomer": { "type": "boolean", "description": "Indicates if the user is a direct customer" }, "email": { "type": "string", "format": "email", "description": "User's email address" }, "firstName": { "type": "string", "description": "User's first name" }, "lastName": { "type": "string", "description": "User's last name", "nullable": true }, "inviteStatus": { "type": "string", "enum": [ "ACTIVE", "INVITE_SENT", "RESEND_INVITE" ], "description": "Current status of the user's invitation" }, "customRole": { "type": "object", "properties": { "id": { "type": "string", "description": "Role identifier" }, "name": { "type": "string", "description": "Role name" } }, "x-apidog-orders": [ "id", "name" ], "x-apidog-ignore-properties": [] }, "accountId": { "type": "string", "description": "ID of the account the user belongs to" }, "preferences": { "type": "object", "properties": { "locale": { "type": "string", "description": "User's locale preference" }, "dateFormat": { "type": "string", "description": "User's preferred date format", "nullable": true }, "timezone": { "type": "string", "description": "User's timezone preference", "nullable": true }, "columnOrder": { "type": "string", "description": "User's column order preference", "nullable": true } }, "x-apidog-orders": [ "locale", "dateFormat", "timezone", "columnOrder" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "id", "createdAt", "directCustomer", "email", "firstName", "lastName", "inviteStatus", "customRole", "accountId", "preferences" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "CustomAttribute": { "type": "object", "properties": { "name": { "type": "string", "description": "Attribute name" }, "slug": { "type": "string", "description": "friendly identifier. supported from google" }, "type": { "type": "string", "enum": [ "STRING", "BOOLEAN", "INTEGER", "ARRAY", "ENUM" ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Attribute values" }, "enumValues": { "type": "array", "items": { "type": "string" }, "description": "Possible values for ENUM type" }, "archived": { "type": "boolean", "description": "Whether the attribute is archived" } }, "x-apidog-orders": [ "name", "slug", "type", "value", "enumValues", "archived" ], "x-apidog-folder": "" }, "DefaultFolderType": { "type": "object", "properties": { "id": { "type": "string", "description": "Default folder ID." }, "name": { "type": "string", "description": "Default folder name." } }, "x-apidog-orders": [ "id", "name" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "DisconnectListingRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "locationId", "site" ], "properties": { "locationId": { "type": "string", "description": "Base64 encoded location ID", "pattern": "^[A-Za-z0-9+/=]+$", "examples": [ "TG9jYXRpb246MTM5OTg=" ] }, "site": { "type": "string", "description": "The platform from which to disconnect the listing", "enum": [ "GOOGLE", "FACEBOOK" ], "examples": [ "GOOGLE" ] } }, "x-apidog-orders": [ "locationId", "site" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "input" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "DisconnectListingResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "disconnectConnectedAccountsLocations": { "type": "object", "required": [ "success" ], "properties": { "clientMutationId": { "type": "string", "description": "Client mutation identifier if provided", "nullable": true }, "errors": { "type": "object", "description": "Hash containing any errors that occurred during disconnection", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [], "nullable": true }, "success": { "type": "boolean", "description": "Indicates if the disconnection was successful.\nReturns true if the account was successfully disconnected from the location.\n" } }, "x-apidog-orders": [ "clientMutationId", "errors", "success" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "disconnectConnectedAccountsLocations" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "DisconnectGoogleRequest": { "type": "object", "properties": { "input": { "type": "object", "required": [ "connectedAccountId" ], "properties": { "connectedAccountId": { "type": "string", "description": "Connected Account Id which needs to be disconnected" } }, "x-apidog-orders": [ "connectedAccountId" ] } }, "x-apidog-orders": [ "input" ], "x-apidog-folder": "" }, "DisconnectGoogleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "gmbBulkDisconnect": { "type": "object", "properties": { "success": { "type": "boolean", "description": "True if the request was successful" }, "__typename": { "type": "string", "examples": [ "BulkDisconnectResult" ] } }, "x-apidog-orders": [ "success", "__typename" ] } }, "x-apidog-orders": [ "gmbBulkDisconnect" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "DownloadLocationsInBulkType": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the export request was accepted." }, "csvUrl": { "type": "string", "description": "URL of the CSV file (populated when the export completes)." } }, "x-apidog-orders": [ "success", "csvUrl" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ExtendedBrandConfig": { "type": "object", "properties": { "id": { "type": "string" }, "socialProfileId": { "type": "string" }, "tone": { "type": "string" }, "targetCustomers": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "string" }, "location": { "type": "string" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "logoLight": { "type": "string" }, "logoDark": { "type": "string" }, "services": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "products": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "contentRules": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "additionalContext": { "type": "string" }, "insights": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "id", "socialProfileId", "tone", "targetCustomers", "country", "phone", "address", "location", "primaryColor", "secondaryColor", "logoLight", "logoDark", "services", "products", "contentRules", "additionalContext", "insights" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ExtendedLocationConfig": { "type": "object", "properties": { "id": { "type": "string" }, "locationId": { "type": "integer" }, "tone": { "type": "string" }, "targetCustomers": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "string" }, "location": { "type": "string" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "logoLight": { "type": "string" }, "logoDark": { "type": "string" }, "services": { "type": "object", "description": "Free-form JSON describing services.", "x-apidog-orders": [] }, "products": { "type": "object", "description": "Free-form JSON describing products.", "x-apidog-orders": [] }, "contentRules": { "type": "object", "description": "Free-form JSON content rules.", "x-apidog-orders": [] }, "additionalContext": { "type": "string" }, "insights": { "type": "object", "description": "Free-form JSON insights.", "x-apidog-orders": [] } }, "x-apidog-orders": [ "id", "locationId", "tone", "targetCustomers", "country", "phone", "address", "location", "primaryColor", "secondaryColor", "logoLight", "logoDark", "services", "products", "contentRules", "additionalContext", "insights" ], "x-apidog-folder": "" }, "FbConnectedListingInfo": { "type": "object", "description": "Connected listing details when the source is Facebook", "properties": { "name": { "type": "string" }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "storeCode": { "type": "string", "nullable": true }, "parentPageName": { "type": "string", "nullable": true }, "liveLink": { "type": "string", "nullable": true } }, "x-apidog-orders": [ "name", "street", "city", "state", "zip", "country", "phone", "storeCode", "parentPageName", "liveLink" ], "x-apidog-folder": "" }, "InteractionsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "interactions": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/InteractionEdge" } }, "totalCount": { "type": "integer", "description": "Total number of interactions matching the filters" } }, "x-apidog-orders": [ "pageInfo", "edges", "totalCount" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "interactions" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "InteractionEdge": { "type": "object", "properties": { "node": { "$ref": "#/components/schemas/Interaction" }, "cursor": { "type": "string", "description": "Cursor for pagination" } }, "x-apidog-orders": [ "node", "cursor" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Interaction": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the interaction" }, "source": { "type": "string", "description": "Source website of the interaction" }, "title": { "type": "string", "description": "Title of the interaction", "nullable": true }, "content": { "type": "string", "description": "Content of the interaction", "nullable": true }, "authorName": { "type": "string", "description": "Name of the author" }, "authorAvatar": { "type": "string", "description": "URL of author's avatar", "nullable": true }, "authorUrl": { "type": "string", "description": "URL of author's profile", "nullable": true }, "rating": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Rating value (1-5)" }, "date": { "type": "string", "format": "date-time", "description": "Date and time of the interaction" }, "permalink": { "type": "string", "description": "Permanent URL to the interaction", "nullable": true }, "category": { "type": "string", "description": "Category of the interaction" }, "type": { "type": "string", "description": "Type of the interaction" }, "photoUrl": { "type": "string", "description": "URL of attached photo", "nullable": true }, "photoThumbnailUrl": { "type": "string", "description": "URL of photo thumbnail", "nullable": true }, "responded": { "type": "boolean", "description": "Whether the interaction has been responded to" }, "notes": { "type": "string", "description": "Additional notes", "nullable": true }, "responses": { "type": "array", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "description": "Array of responses" }, "canRespond": { "type": "boolean", "description": "Whether responses are allowed" }, "totalResponses": { "type": "integer", "description": "Total number of responses" } }, "x-apidog-orders": [ "id", "source", "title", "content", "authorName", "authorAvatar", "authorUrl", "rating", "date", "permalink", "category", "type", "photoUrl", "photoThumbnailUrl", "responded", "notes", "responses", "canRespond", "totalResponses" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "FetchListingsRequest": { "type": "object", "required": [ "connectedAccountId" ], "properties": { "connectedAccountId": { "type": "string", "format": "uuid", "description": "ID of the connected account to fetch listings for" }, "locationInfo": { "type": "string", "description": "Optional filter string to search across location fields:\n- Street address\n- Postal code\n- City\n- Phone number\n- Business name\n" }, "page": { "type": "integer", "minimum": 1, "default": 1, "description": "Page number for pagination" }, "perPage": { "type": "integer", "minimum": 1, "maximum": 500, "default": 20, "description": "Number of records per page (maximum 500)" } }, "x-apidog-orders": [ "connectedAccountId", "locationInfo", "page", "perPage" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "FetchListingsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectedAccountListings": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/LocationListing" } } }, "x-apidog-orders": [ "pageInfo", "records" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "connectedAccountListings" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationListing": { "type": "object", "properties": { "accountTypeName": { "type": "string", "enum": [ "Google", "Facebook" ], "description": "Publisher type of the listing" }, "address": { "type": "string", "description": "Full address of the location" }, "id": { "type": "string", "description": "Reference Listing ID that can be used to connect a location" }, "liveLink": { "type": "string", "description": "Live link provided by Google/Facebook if available", "nullable": true }, "locationName": { "type": "string", "description": "Name of the location" }, "phone": { "type": "string", "description": "Phone number of the location" }, "type": { "type": "string", "description": "Type of the listing if specified", "nullable": true }, "ownerRole": { "type": "string", "description": "GBP role of the connecting/importing user on this listing (e.g. PRIMARY_OWNER, OWNER, MANAGER, SITE_MANAGER). Google (GMB) only; null when Google exposes no matching admin or for non-Google listings.", "nullable": true } }, "x-apidog-orders": [ "accountTypeName", "address", "id", "liveLink", "locationName", "phone", "type", "ownerRole" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GridReportResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "gridrankReportById": { "$ref": "#/components/schemas/GridReport" } }, "x-apidog-orders": [ "gridrankReportById" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationSummaryConnectionType": { "type": "object", "properties": { "edges": { "type": "array", "items": { "$ref": "#/components/schemas/LocationSummaryEdge" } }, "nodes": { "type": "array", "items": { "type": "string" } }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "totalCount": { "type": "integer", "description": "Total number of records matching the filter." } }, "x-apidog-orders": [ "edges", "nodes", "pageInfo", "totalCount" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationSummaryEdge": { "type": "object", "properties": { "cursor": { "type": "string" }, "node": { "type": "string" } }, "x-apidog-orders": [ "cursor", "node" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "FolderInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the folder" }, "name": { "type": "string", "description": "Name of the folder" }, "level": { "type": "integer", "description": "Hierarchical level of the folder (0 for root)", "minimum": 0 }, "locationCount": { "type": "integer", "description": "Number of locations in this folder", "minimum": 0 }, "parentFolderId": { "type": "string", "format": "uuid", "description": "ID of the parent folder (null for root folder)", "nullable": true }, "parentFolderName": { "type": "string", "description": "Name of the parent folder (null for root folder)", "nullable": true } }, "x-apidog-orders": [ "id", "name", "level", "locationCount", "parentFolderId", "parentFolderName" ], "x-apidog-folder": "" }, "FolderNode": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the folder", "examples": [ "67049f29-3bc6-4e82-875b-02159b4b1fea" ] }, "name": { "type": "string", "description": "Name of the folder", "examples": [ "root" ] }, "level": { "type": "integer", "description": "Hierarchical level of the folder (0 being root)", "minimum": 0, "examples": [ 0 ] }, "locationCount": { "type": "integer", "description": "Number of locations contained within this folder", "minimum": 0, "examples": [ 25 ] }, "subFolders": { "type": "array", "description": "List of child folders under this folder", "items": { "$ref": "#/components/schemas/FolderNode" } } }, "required": [ "id", "name", "level", "locationCount", "subFolders" ], "x-apidog-orders": [ "id", "name", "level", "locationCount", "subFolders" ], "x-apidog-folder": "" }, "GenerateAllLocalSeriesPostsRequest": { "type": "object", "required": [ "locationId", "seriesId" ], "properties": { "locationId": { "type": "string" }, "seriesId": { "type": "string" } }, "x-apidog-orders": [ "locationId", "seriesId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalGenerateIdeasResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "ideas": { "type": "array", "description": "Generated post ideas (see Local post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "pipelineId": { "type": "string" }, "generatedCount": { "type": "integer" }, "error": { "$ref": "#/components/schemas/LocalError" } }, "x-apidog-orders": [ "success", "ideas", "pipelineId", "generatedCount", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateAllSeriesPostsRequest": { "type": "object", "required": [ "seriesId", "socialProfileId" ], "properties": { "seriesId": { "type": "string" }, "socialProfileId": { "type": "string" } }, "x-apidog-orders": [ "seriesId", "socialProfileId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateAllSeriesPostsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "generatedCount": { "type": "integer" }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "generatedCount", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateCalendarDayRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" } }, "x-apidog-orders": [ "ideaId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RegenerateResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "idea": { "type": "object", "description": "The updated post idea (see Post idea for the full shape).", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "idea", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateHolidayIdeaVariantRequest": { "type": "object", "required": [ "socialProfileId", "observanceName" ], "properties": { "socialProfileId": { "type": "string" }, "observanceName": { "type": "string" }, "observanceDate": { "type": "string" }, "topic": { "type": "string" } }, "x-apidog-orders": [ "socialProfileId", "observanceName", "observanceDate", "topic" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateIdeaVisualRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "prompt": { "type": "string" }, "referenceImageUrls": { "type": "array", "items": { "type": "string" } }, "imageSize": { "type": "string" } }, "x-apidog-orders": [ "ideaId", "prompt", "referenceImageUrls", "imageSize" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateLocalHolidayIdeaVariantRequest": { "type": "object", "required": [ "locationId", "observanceName" ], "properties": { "locationId": { "type": "string" }, "observanceName": { "type": "string" }, "observanceDate": { "type": "string" }, "topic": { "type": "string" } }, "x-apidog-orders": [ "locationId", "observanceName", "observanceDate", "topic" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalRegenerateResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "idea": { "type": "object", "description": "The updated post idea (see Local post idea for the full shape).", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "error": { "$ref": "#/components/schemas/LocalError" } }, "x-apidog-orders": [ "success", "idea", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateLocalSeriesPostRequest": { "type": "object", "required": [ "seriesId", "slotIndex" ], "properties": { "seriesId": { "type": "string" }, "slotIndex": { "type": "string" } }, "x-apidog-orders": [ "seriesId", "slotIndex" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateObservanceIdeaRequest": { "type": "object", "required": [ "socialProfileId", "observanceName" ], "properties": { "socialProfileId": { "type": "string" }, "observanceName": { "type": "string" }, "observanceDate": { "type": "string" }, "hint": { "type": "string" } }, "x-apidog-orders": [ "socialProfileId", "observanceName", "observanceDate", "hint" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateSeriesPostRequest": { "type": "object", "required": [ "seriesId", "slotIndex", "socialProfileId" ], "properties": { "seriesId": { "type": "string" }, "slotIndex": { "type": "integer" }, "socialProfileId": { "type": "string" } }, "x-apidog-orders": [ "seriesId", "slotIndex", "socialProfileId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GenerateIdeasResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "ideas": { "type": "array", "description": "Generated post ideas (see Post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [] } }, "pipelineId": { "type": "string" }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "ideas", "pipelineId", "error" ], "x-apidog-folder": "" }, "NotFoundError": { "type": "object", "properties": { "data": { "type": "object", "properties": { "bingInsights": { "type": null } }, "x-apidog-orders": [ "bingInsights" ], "x-apidog-ignore-properties": [] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Location not found" ] } }, "x-apidog-orders": [ "message" ], "x-apidog-ignore-properties": [] } } }, "x-apidog-orders": [ "data", "errors" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "InsightMetric": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Start time of the analytics period", "examples": [ "2018-11-13T00:00:00+00:00" ] }, "value": { "type": "integer", "description": "Metric value for the period", "examples": [ 0 ] } }, "x-apidog-orders": [ "startTime", "value" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "GmbConnectedListingInfo": { "type": "object", "description": "Connected listing details when the source is Google (GMB)", "properties": { "name": { "type": "string" }, "addressLines": { "type": "array", "items": { "type": "string" } }, "administrativeArea": { "type": "string", "nullable": true }, "locality": { "type": "string", "nullable": true }, "regionCode": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "storeCode": { "type": "string", "nullable": true }, "gmbAccountNumber": { "type": "string", "nullable": true }, "gmbGroup": { "type": "string", "nullable": true }, "suspended": { "type": "boolean", "nullable": true }, "liveLink": { "type": "string", "nullable": true } }, "x-apidog-orders": [ "name", "addressLines", "administrativeArea", "locality", "regionCode", "postalCode", "phone", "storeCode", "gmbAccountNumber", "gmbGroup", "suspended", "liveLink" ], "x-apidog-folder": "" }, "GoogleVerificationLocationStats": { "type": "object", "properties": { "total": { "type": "integer" }, "verified": { "type": "integer" }, "underReview": { "type": "integer" }, "pendingVerification": { "type": "integer" }, "duplicate": { "type": "integer" }, "suspended": { "type": "integer" }, "notVerified": { "type": "integer" }, "errorWhileFetching": { "type": "integer" }, "notConnected": { "type": "integer" }, "listingNotPresent": { "type": "integer" } }, "x-apidog-orders": [ "total", "verified", "underReview", "pendingVerification", "duplicate", "suspended", "notVerified", "errorWhileFetching", "notConnected", "listingNotPresent" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "IdeaJobStatus": { "type": "object", "properties": { "status": { "type": "string" }, "imageUrl": { "type": "string" } }, "x-apidog-orders": [ "status", "imageUrl" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ImageCredits": { "type": "object", "properties": { "socialProfileId": { "type": "string" }, "monthlyLimit": { "type": "integer" }, "isActive": { "type": "boolean" }, "usedThisMonth": { "type": "integer" }, "remainingThisMonth": { "type": "integer" }, "addonPurchased": { "type": "integer" }, "addonConsumed": { "type": "integer" }, "addonRemaining": { "type": "integer" } }, "x-apidog-orders": [ "socialProfileId", "monthlyLimit", "isActive", "usedThisMonth", "remainingThisMonth", "addonPurchased", "addonConsumed", "addonRemaining" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Response": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Response ID" }, "title": { "type": "string", "description": "Response title", "nullable": true }, "content": { "type": "string", "description": "Response content" }, "authorName": { "type": "string", "description": "Name of responder" }, "authorAvatar": { "type": "string", "description": "URL of responder's avatar", "nullable": true }, "authorUrl": { "type": "string", "description": "URL of responder's profile", "nullable": true }, "date": { "type": "string", "format": "date-time", "description": "Response timestamp" }, "responseStatus": { "type": "string", "enum": [ "CREATED", "COMPLETED", "CONFIRMED", "FAILED" ], "description": "Status of the response:\n* CREATED - Response submission created\n* COMPLETED - Response submission completed\n* CONFIRMED - Double confirmation from partner site\n* FAILED - Response submission failed\n" } }, "x-apidog-orders": [ "id", "title", "content", "authorName", "authorAvatar", "authorUrl", "date", "responseStatus" ], "x-apidog-folder": "" }, "Keyword": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "The unique ID attached to the keyword" }, "name": { "type": "string", "description": "The text value of the keyword" } }, "x-apidog-orders": [ "id", "name" ], "x-apidog-folder": "" }, "LinkPostIdeaToSocialPostRequest": { "type": "object", "required": [ "postIdeaId", "socialPostId" ], "properties": { "postIdeaId": { "type": "string" }, "socialPostId": { "type": "string" } }, "x-apidog-orders": [ "postIdeaId", "socialPostId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LinkPostIdeaToSocialPostResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SubscriptionsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "activeSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "x-apidog-orders": [ "activeSubscriptions" ], "required": [ "activeSubscriptions" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "required": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Subscription": { "type": "object", "properties": { "name": { "type": "string", "description": "The display name of the subscription plan", "examples": [ "Premium plan - Monthly" ] }, "paymentSubscriptionId": { "type": "string", "description": "Unique identifier for the subscription", "examples": [ "b8b5075f-35ff-4aaf-9580-44271e0dde34" ] }, "planId": { "type": "string", "description": "Identifier for the subscription plan", "examples": [ "premium-1month" ] }, "tenure": { "type": "string", "description": "The subscription period", "examples": [ "Monthly" ] } }, "x-apidog-orders": [ "name", "paymentSubscriptionId", "planId", "tenure" ], "required": [ "name", "paymentSubscriptionId", "planId", "tenure" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ListFoldersResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "getUserFolders": { "type": "array", "items": { "$ref": "#/components/schemas/FolderInfo" } } }, "x-apidog-orders": [ "getUserFolders" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationConnectionsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "locationsConnectInfo": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/LocationConnectInfo" } } }, "x-apidog-orders": [ "pageInfo", "records" ], "x--orders": [ "pageInfo", "records" ], "x--ignore-properties": [] } }, "x-apidog-orders": [ "locationsConnectInfo" ], "x--orders": [ "locationsConnectInfo" ], "x--ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x--orders": [ "data" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "LocationConnectInfo": { "type": "object", "properties": { "locationId": { "type": "string", "description": "Base64-encoded location id (`Location:`)" }, "accountId": { "type": "string", "description": "Account id the location belongs to" }, "clientName": { "type": "string", "description": "Client / sub-account name", "nullable": true }, "accountType": { "type": "string", "enum": [ "GoogleAccount", "FacebookAccount", "AppleAccount", "YelpAccount", "TripadvisorAccount" ], "description": "Source / publisher this record represents" }, "status": { "type": "string", "description": "Raw connection status of the location for this source. Values\ninclude `CONNECTED`, `NOT_CONNECTED`, `CONNECTION_ISSUE`, `EXPIRED`,\n`RENEW`, `MISSING`, `SUSPENDED`, etc.\n" }, "connectedAccountId": { "type": "string", "description": "Id of the connected account, when connected", "nullable": true }, "providerId": { "type": "string", "description": "Provider-side id of the connected listing, when connected", "nullable": true }, "accountMail": { "type": "string", "description": "Email of the connected (publisher) account, when connected", "nullable": true }, "publisherAccountName": { "type": "string", "description": "Display name of the connected publisher account", "nullable": true }, "publisherAccountId": { "type": "string", "description": "Id of the connected publisher account", "nullable": true }, "listingSiteId": { "type": "integer", "description": "Site id of the connected listing", "nullable": true }, "locationInfo": { "$ref": "#/components/schemas/LocationInfo" }, "connectedListingInfo": { "description": "Details of the connected listing on the source. `null` when the location is not connected. When present, its shape depends on the source.", "oneOf": [ { "$ref": "#/components/schemas/GmbConnectedListingInfo" }, { "$ref": "#/components/schemas/FbConnectedListingInfo" }, { "$ref": "#/components/schemas/AppleConnectedListingInfo" }, { "type": "null" } ] } }, "x-apidog-orders": [ "locationId", "accountId", "clientName", "accountType", "status", "connectedAccountId", "providerId", "accountMail", "publisherAccountName", "publisherAccountId", "listingSiteId", "locationInfo", "connectedListingInfo" ], "x--orders": [ "locationId", "accountId", "clientName", "accountType", "status", "connectedAccountId", "providerId", "accountMail", "publisherAccountName", "publisherAccountId", "listingSiteId", "locationInfo", "connectedListingInfo" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "ReviewCampaignCustomersResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "reviewCampaignInfo": { "$ref": "#/components/schemas/ReviewCampaignInfo" } }, "x-apidog-orders": [ "reviewCampaignInfo" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ReviewCampaignInfo": { "type": "object", "properties": { "campaignName": { "type": "string", "description": "Name of the review campaign" }, "reviewCampaignCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewCampaignCustomer" } } }, "x-apidog-orders": [ "campaignName", "reviewCampaignCustomers" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ReviewCampaignCustomer": { "type": "object", "properties": { "name": { "type": "string", "description": "Customer's name" }, "phone": { "type": "string", "description": "Customer's phone number" }, "email": { "type": "string", "format": "email", "description": "Customer's email address" }, "rating": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Customer's rating" }, "response": { "type": "string", "description": "Customer's feedback response" }, "date": { "type": "string", "format": "date", "description": "Date of the response" }, "followUpSent": { "type": "integer", "description": "Number of follow-ups sent" }, "smsDeliveredAt": { "type": "string", "format": "date-time", "description": "Timestamp when SMS was delivered" }, "smsOpenedAt": { "type": "string", "format": "date-time", "description": "Timestamp when SMS was opened" }, "emailDeliveredAt": { "type": "string", "format": "date-time", "description": "Timestamp when email was delivered" }, "emailLastOpenedAt": { "type": "string", "format": "date-time", "description": "Timestamp when email was last opened" }, "emailLastClickedAt": { "type": "string", "format": "date-time", "description": "Timestamp when email was last clicked" }, "firstFollowUpAt": { "type": "string", "format": "date-time", "description": "Timestamp when first follow-up was sent" }, "firstFollowUpDeliveredAt": { "type": "string", "format": "date-time", "description": "Timestamp when first follow-up was delivered" }, "secondFollowUpAt": { "type": "string", "format": "date-time", "description": "Timestamp when second follow-up was sent" }, "secondFollowUpDeliveredAt": { "type": "string", "format": "date-time", "description": "Timestamp when second follow-up was delivered" } }, "x-apidog-orders": [ "name", "phone", "email", "rating", "response", "date", "followUpSent", "smsDeliveredAt", "smsOpenedAt", "emailDeliveredAt", "emailLastOpenedAt", "emailLastClickedAt", "firstFollowUpAt", "firstFollowUpDeliveredAt", "secondFollowUpAt", "secondFollowUpDeliveredAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ReviewCampaignsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "listReviewCampaigns": { "type": "object", "properties": { "reviewCampaigns": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewCampaign" } } }, "x-apidog-orders": [ "reviewCampaigns" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "listReviewCampaigns" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ReviewCampaign": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the review campaign" }, "locationId": { "type": "string", "description": "Location identifier" }, "name": { "type": "string", "description": "Name of the campaign" }, "screening": { "type": "boolean", "description": "Whether screening is enabled" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp" }, "openingEmailTemplate": { "$ref": "#/components/schemas/EmailTemplate" }, "smsTemplate": { "$ref": "#/components/schemas/SmsTemplate" }, "firstFollowUpSchedule": { "type": "string", "enum": [ "DAYS_2", "DAYS_5" ] }, "firstFollowUpTemplate": { "$ref": "#/components/schemas/EmailTemplate" }, "secondFollowUpSchedule": { "type": "string", "enum": [ "DAYS_2", "DAYS_5" ] }, "secondFollowUpTemplate": { "$ref": "#/components/schemas/EmailTemplate" }, "stats": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStat" } }, "numberOfFeedbacks": { "type": "integer", "description": "Total number of feedbacks received" } }, "x-apidog-orders": [ "id", "locationId", "name", "screening", "createdAt", "openingEmailTemplate", "smsTemplate", "firstFollowUpSchedule", "firstFollowUpTemplate", "secondFollowUpSchedule", "secondFollowUpTemplate", "stats", "numberOfFeedbacks" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SmsTemplate": { "type": "object", "properties": { "content": { "type": "string" }, "reviewSiteHash": { "type": "array", "items": { "type": "string" } } }, "x-apidog-orders": [ "content", "reviewSiteHash" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UserRole": { "type": "object", "properties": { "id": { "type": "string", "description": "Base64 encoded unique identifier for the role" }, "name": { "type": "string", "description": "Name of the role" }, "createdAt": { "type": "string", "format": "date-time", "description": "Role creation timestamp" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Role last update timestamp" } }, "required": [ "id", "name", "createdAt", "updatedAt" ], "x-apidog-orders": [ "id", "name", "createdAt", "updatedAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UsersResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "users": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Total number of users in the system" }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/UserEdge" } } }, "x-apidog-orders": [ "totalCount", "pageInfo", "edges" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "users" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UserEdge": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Unique cursor for this user record" }, "node": { "$ref": "#/components/schemas/User" } }, "x-apidog-orders": [ "cursor", "node" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "User": { "type": "object", "required": [ "id", "email", "firstName", "customRole", "directCustomer", "createdAt", "inviteStatus" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the user" }, "email": { "type": "string", "format": "email", "description": "User's email address" }, "firstName": { "type": "string", "description": "User's first name" }, "lastName": { "type": "string", "description": "User's last name (optional)", "nullable": true }, "customRole": { "type": "object", "properties": { "id": { "type": "string", "description": "Role identifier" }, "name": { "type": "string", "description": "Role name" } }, "x-apidog-orders": [ "id", "name" ], "x-apidog-ignore-properties": [] }, "directCustomer": { "type": "boolean", "description": "Indicates if the user is a direct customer" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the user was created" }, "inviteStatus": { "type": "string", "enum": [ "ACTIVE", "INVITE_SENT", "RESEND_INVITE" ], "description": "Current status of the user's invitation" } }, "x-apidog-orders": [ "id", "email", "firstName", "lastName", "customRole", "directCustomer", "createdAt", "inviteStatus" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UsersByIdsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "usersByIds": { "type": "array", "items": { "$ref": "#/components/schemas/UserDetail" } } }, "x-apidog-orders": [ "usersByIds" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UserDetail": { "type": "object", "required": [ "id", "firstName", "email", "customRole", "directCustomer", "createdAt", "inviteStatus" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the user" }, "firstName": { "type": "string", "description": "User's first name" }, "lastName": { "type": "string", "description": "User's last name", "nullable": true }, "email": { "type": "string", "format": "email", "description": "User's email address" }, "customRole": { "type": "object", "properties": { "id": { "type": "string", "description": "Role identifier" }, "name": { "type": "string", "description": "Role name" } }, "x-apidog-orders": [ "id", "name" ], "x-apidog-ignore-properties": [] }, "directCustomer": { "type": "boolean", "description": "Indicates if the user is a direct customer" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the user was created" }, "inviteStatus": { "type": "string", "enum": [ "ACTIVE", "INVITE_SENT", "RESEND_INVITE" ], "description": "Current status of the user's invitation" }, "preferences": { "type": "object", "properties": { "locale": { "type": "string", "description": "User's locale preference" }, "dateFormat": { "type": "string", "description": "User's preferred date format", "nullable": true }, "timezone": { "type": "string", "description": "User's timezone preference", "nullable": true } }, "x-apidog-orders": [ "locale", "dateFormat", "timezone" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "id", "firstName", "lastName", "email", "customRole", "directCustomer", "createdAt", "inviteStatus", "preferences" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Site": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" } }, "x-apidog-orders": [ "id", "name", "url" ], "x-apidog-folder": "" }, "Listing": { "type": "object", "properties": { "id": { "type": "string" }, "site": { "$ref": "#/components/schemas/Site" }, "syncStatus": { "type": "string", "enum": [ "IN_PROGRESS", "SYNCED", "FAILED", "REQUIRING_ACTION", "AVAILABLE", "COMPLETED", "PENDING_APPROVAL" ] }, "displayStatus": { "type": "string" }, "actionRequired": { "type": "boolean" }, "listingUrl": { "type": "string", "nullable": true }, "syncIssue": { "type": "string", "nullable": true }, "lastUpdate": { "type": "string", "format": "date-time" }, "verified": { "type": "boolean", "nullable": true } }, "x-apidog-orders": [ "id", "site", "syncStatus", "displayStatus", "actionRequired", "listingUrl", "syncIssue", "lastUpdate", "verified" ], "x-apidog-folder": "" }, "ListingRecord": { "type": "object", "properties": { "accountTypeName": { "type": "string", "enum": [ "Google", "Facebook" ], "description": "Publisher type of the listing" }, "address": { "type": "string", "description": "Full address of the location" }, "id": { "type": "string", "description": "Reference listing ID that can be used to connect a location" }, "liveLink": { "type": "string", "description": "Live link provided by Google/Facebook if available", "nullable": true }, "locationName": { "type": "string", "description": "Name of the location" }, "phone": { "type": "string", "description": "Phone number of the location" }, "type": { "type": "string", "description": "Type of the listing if specified", "nullable": true } }, "x-apidog-orders": [ "accountTypeName", "address", "id", "liveLink", "locationName", "phone", "type" ], "x-apidog-folder": "" }, "ListingsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "listingsForLocation": { "type": "array", "items": { "$ref": "#/components/schemas/Listing" } } }, "x-apidog-orders": [ "listingsForLocation" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "LocalCalendarDay": { "type": "object", "properties": { "day": { "type": "integer" }, "posts": { "type": "array", "description": "Post ideas for the day (see Local post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [], "x--orders": [], "properties": {}, "x--ignore-properties": [] } } }, "x-apidog-orders": [ "day", "posts" ], "x--orders": [ "day", "posts" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "LocalChatMessage": { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string" }, "content": { "type": "string" }, "messageType": { "type": "string" }, "metadata": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "sequence": { "type": "integer" }, "createdAt": { "type": "string" } }, "x-apidog-orders": [ "id", "role", "content", "messageType", "metadata", "sequence", "createdAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalContentSeries": { "type": "object", "properties": { "id": { "type": "string" }, "locationId": { "type": "integer" }, "name": { "type": "string" }, "theme": { "type": "string" }, "status": { "type": "string" }, "postCount": { "type": "integer" }, "publishedCount": { "type": "integer" }, "unpublishedCount": { "type": "integer" }, "posts": { "type": "array", "description": "Posts in the series (see Local post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "chatSessionId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "x-apidog-orders": [ "id", "locationId", "name", "theme", "status", "postCount", "publishedCount", "unpublishedCount", "posts", "chatSessionId", "createdAt", "updatedAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalIdeaJobStatus": { "type": "object", "properties": { "status": { "type": "string" }, "imageUrl": { "type": "string" } }, "x-apidog-orders": [ "status", "imageUrl" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalImageCredits": { "type": "object", "properties": { "locationId": { "type": "string" }, "monthlyLimit": { "type": "integer" }, "isActive": { "type": "boolean" }, "usedThisMonth": { "type": "integer" }, "remainingThisMonth": { "type": "integer" }, "addonPurchased": { "type": "integer" }, "addonConsumed": { "type": "integer" }, "addonRemaining": { "type": "integer" } }, "x-apidog-orders": [ "locationId", "monthlyLimit", "isActive", "usedThisMonth", "remainingThisMonth", "addonPurchased", "addonConsumed", "addonRemaining" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalLocationInfo": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "siteUrl": { "type": "string" }, "primaryCategory": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "country": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } }, "x-apidog-orders": [ "id", "name", "siteUrl", "primaryCategory", "categories", "country", "phone", "address", "city", "state" ], "x--orders": [ "id", "name", "siteUrl", "primaryCategory", "categories", "country", "phone", "address", "city", "state" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "LocalObservance": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "date": { "type": "string" }, "imageUrl": { "type": "string" }, "isMonthLong": { "type": "boolean" } }, "x-apidog-orders": [ "id", "title", "description", "date", "imageUrl", "isMonthLong" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalObservanceWithIdea": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "date": { "type": "string" }, "imageUrl": { "type": "string" }, "isMonthLong": { "type": "boolean" }, "ideasReady": { "type": "boolean" }, "isRelevant": { "type": "boolean" }, "postIdeaId": { "type": "string" }, "postImageUrl": { "type": "string" }, "postTitle": { "type": "string" }, "postType": { "type": "string" }, "postContent": { "type": "string" }, "postImagePrompt": { "type": "string" } }, "x-apidog-orders": [ "id", "title", "description", "date", "imageUrl", "isMonthLong", "ideasReady", "isRelevant", "postIdeaId", "postImageUrl", "postTitle", "postType", "postContent", "postImagePrompt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalPipelineStatus": { "type": "object", "properties": { "id": { "type": "string" }, "locationId": { "type": "integer" }, "pipelineType": { "type": "string" }, "status": { "type": "string" }, "currentStep": { "type": "string" }, "stepsCompleted": { "type": "array", "items": { "type": "string" } }, "stepsRemaining": { "type": "array", "items": { "type": "string" } }, "errorMessage": { "type": "string" }, "startedAt": { "type": "string" }, "completedAt": { "type": "string" } }, "x-apidog-orders": [ "id", "locationId", "pipelineType", "status", "currentStep", "stepsCompleted", "stepsRemaining", "errorMessage", "startedAt", "completedAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalPostIdea": { "type": "object", "properties": { "id": { "type": "string" }, "locationId": { "type": "integer" }, "title": { "type": "string" }, "content": { "type": "string" }, "imagePrompt": { "type": "string" }, "imageUrl": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "string" } }, "bucket": { "type": "string" }, "calendarDay": { "type": "integer" }, "scheduledDate": { "type": "string" }, "scheduledTime": { "type": "string" }, "ctaText": { "type": "string" }, "ctaUrl": { "type": "string" }, "note": { "type": "string" }, "seriesId": { "type": "string" }, "localPostId": { "type": "string" }, "isRecurring": { "type": "boolean" }, "isUserGenerated": { "type": "boolean" }, "observanceName": { "type": "string" }, "observanceDate": { "type": "string" }, "language": { "type": "string" }, "generationBatchId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "referenceImageOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceImageOption" } }, "generationState": { "type": "string" }, "relevanceScore": { "type": "number" }, "theme": { "type": "string" }, "isRelevant": { "type": "boolean" }, "generationJobId": { "type": "string" } }, "x-apidog-orders": [ "id", "locationId", "title", "content", "imagePrompt", "imageUrl", "type", "status", "platforms", "bucket", "calendarDay", "scheduledDate", "scheduledTime", "ctaText", "ctaUrl", "note", "seriesId", "localPostId", "isRecurring", "isUserGenerated", "observanceName", "observanceDate", "language", "generationBatchId", "createdAt", "updatedAt", "referenceImageOptions", "generationState", "relevanceScore", "theme", "isRelevant", "generationJobId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ReferenceImageOption": { "type": "object", "properties": { "url": { "type": "string" }, "category": { "type": "string" } }, "x-apidog-orders": [ "url", "category" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "PostIdeaCounts": { "type": "object", "properties": { "ai": { "type": "integer" }, "mine": { "type": "integer" }, "series": { "type": "integer" }, "all": { "type": "integer" } }, "x-apidog-orders": [ "ai", "mine", "series", "all" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ScrapedLocationContext": { "type": "object", "properties": { "id": { "type": "string" }, "locationId": { "type": "integer" }, "businessName": { "type": "string" }, "category": { "type": "string" }, "businessDescription": { "type": "string" }, "location": { "type": "string" }, "services": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "products": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "subcategories": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "pricing": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "availability": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "uniqueSellingPoints": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "tone": { "type": "string" }, "targetCustomers": { "type": "string" }, "scrapedImages": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "insights": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "brandPrimaryColor": { "type": "string" }, "brandSecondaryColor": { "type": "string" }, "brandLogoUrl": { "type": "string" }, "scrapedContext": { "type": "string" }, "visualContext": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "id", "locationId", "businessName", "category", "businessDescription", "location", "services", "products", "subcategories", "pricing", "availability", "uniqueSellingPoints", "tone", "targetCustomers", "scrapedImages", "insights", "brandPrimaryColor", "brandSecondaryColor", "brandLogoUrl", "scrapedContext", "visualContext" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocalChatMessageResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "$ref": "#/components/schemas/LocalChatMessage" }, "postCard": { "type": "object", "description": "Generated post idea card (see Local post ideas), when produced.", "x-apidog-orders": [] }, "seriesPlan": { "type": "object", "description": "Content-series plan, when produced.", "x-apidog-orders": [] }, "actionChips": { "type": "array", "items": { "$ref": "#/components/schemas/ActionChip" } }, "error": { "$ref": "#/components/schemas/LocalError" } }, "x-apidog-orders": [ "success", "message", "postCard", "seriesPlan", "actionChips", "error" ], "x-apidog-folder": "" }, "LocalScheduleSeriesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "scheduledPosts": { "type": "array", "description": "The scheduled posts (see Local post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [] } }, "error": { "$ref": "#/components/schemas/LocalError" } }, "x-apidog-orders": [ "success", "scheduledPosts", "error" ], "x-apidog-folder": "" }, "LocalTriggerPipelineResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "pipelineId": { "type": "string" }, "error": { "$ref": "#/components/schemas/LocalError" } }, "x-apidog-orders": [ "success", "pipelineId", "error" ], "x-apidog-folder": "" }, "LocationAddOnCount": { "type": "object", "properties": { "enabled": { "type": "integer", "description": "Locations with the add-on enabled." }, "disabled": { "type": "integer", "description": "Locations with the add-on disabled." }, "othersEnabled": { "type": "array", "description": "Counts for other add-ons in the same product umbrella.", "items": { "$ref": "#/components/schemas/AddOnCount" } } }, "x-apidog-orders": [ "enabled", "disabled", "othersEnabled" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationPackageCount": { "type": "object", "properties": { "freemiumCount": { "type": "integer", "description": "Number of freemium-tier locations." }, "premiumCount": { "type": "integer", "description": "Number of premium-tier locations." } }, "x-apidog-orders": [ "freemiumCount", "premiumCount" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "LocationConnectedEvent": { "type": "object", "properties": { "event": { "type": "string", "description": "Dotted event name." }, "timestamp": { "type": "string", "description": "ISO-8601 UTC emit time." }, "account_id": { "type": "integer", "description": "Synup account the event belongs to." }, "location_id": { "type": "string", "description": "Numeric string; location-scoped event." }, "data": { "type": "object", "properties": { "platform": { "type": "string", "description": "\"google\" or \"facebook\"." }, "connected_account_id": { "type": "string", "description": "UUID of the connected account that was linked." } }, "x-apidog-orders": [ "platform", "connected_account_id" ] } }, "x-apidog-orders": [ "event", "timestamp", "account_id", "location_id", "data" ], "x-apidog-folder": "" }, "LocationEdge": { "type": "object", "properties": { "cursor": { "type": "string" }, "node": { "type": "object", "properties": {} } }, "x-apidog-orders": [ "cursor", "node" ], "x-apidog-folder": "" }, "LocationListResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "locations" ], "properties": { "locations": { "type": "array", "description": "Array of location objects containing details about each connected location", "items": { "type": "object", "required": [ "locationId", "name", "status", "connectedAccountType" ], "properties": { "locationId": { "type": "string", "description": "Unique Node ID of the location", "examples": [ "TG9jYXRpb246MTE3MTM4OQ==" ] }, "name": { "type": "string", "description": "Business name of the location", "examples": [ "Downtown Coffee Shop" ] }, "address": { "type": "string", "description": "Full address of the location", "examples": [ "123 Main St, Seattle, WA 98101" ] }, "status": { "type": "string", "description": "Current status of the location", "enum": [ "ACTIVE", "INACTIVE", "ARCHIVED" ], "examples": [ "ACTIVE" ] }, "connectedAccountType": { "type": "string", "description": "Type of the connected account platform", "enum": [ "GOOGLE", "FACEBOOK" ], "examples": [ "GOOGLE" ] } }, "x-apidog-orders": [ "locationId", "name", "address", "status", "connectedAccountType" ] } } }, "x-apidog-orders": [ "locations" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "LocationPhoto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the photo" }, "databaseId": { "type": "integer", "description": "Internal database ID" }, "type": { "type": "string", "enum": [ "LOGO", "COVER", "ADDITIONAL" ] }, "url": { "type": "string", "description": "Full resolution photo URL" }, "thumbnailUrl": { "type": "string", "description": "Thumbnail photo URL" }, "fileSize": { "type": "integer", "description": "Photo file size in bytes" }, "name": { "type": "string", "description": "Original filename" }, "starred": { "type": "boolean", "description": "Whether photo is starred/featured" } }, "x-apidog-orders": [ "id", "databaseId", "type", "url", "thumbnailUrl", "fileSize", "name", "starred" ], "x-apidog-folder": "" }, "LocationResponseErrorSchema": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "contextInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "x-apidog-orders": [ "key", "value" ] } }, "message": { "type": "string" } }, "x-apidog-orders": [ "code", "contextInfo", "message" ] }, "x-apidog-folder": "" }, "MetricWithDelta": { "type": "object", "properties": { "value": { "type": "number" }, "delta": { "type": "number" } }, "x-apidog-orders": [ "value", "delta" ], "x-apidog-folder": "" }, "Observance": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "date": { "type": "string" }, "imageUrl": { "type": "string" }, "isMonthLong": { "type": "boolean" }, "isRelevant": { "type": "boolean" }, "ideasReady": { "type": "boolean" }, "postIdeaId": { "type": "string" }, "postImageUrl": { "type": "string" }, "postTitle": { "type": "string" }, "postType": { "type": "string" }, "postContent": { "type": "string" }, "postImagePrompt": { "type": "string" } }, "x-apidog-orders": [ "id", "title", "description", "date", "imageUrl", "isMonthLong", "isRelevant", "ideasReady", "postIdeaId", "postImageUrl", "postTitle", "postType", "postContent", "postImagePrompt" ], "x-apidog-folder": "" }, "ObservanceWithIdea": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "date": { "type": "string" }, "imageUrl": { "type": "string" }, "isMonthLong": { "type": "boolean" }, "ideasReady": { "type": "boolean" }, "postIdeaId": { "type": "string" }, "postImageUrl": { "type": "string" }, "postTitle": { "type": "string" }, "postType": { "type": "string" }, "postContent": { "type": "string" }, "postImagePrompt": { "type": "string" } }, "x-apidog-orders": [ "id", "title", "description", "date", "imageUrl", "isMonthLong", "ideasReady", "postIdeaId", "postImageUrl", "postTitle", "postType", "postContent", "postImagePrompt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Pagination": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of items" }, "page": { "type": "integer", "description": "Current page number" }, "limit": { "type": "integer", "description": "Items per page" }, "total_pages": { "type": "integer", "description": "Total number of pages" } }, "x-apidog-orders": [ "total", "page", "limit", "total_pages" ], "x-apidog-folder": "" }, "paymentMethods": { "type": "object", "properties": { "": { "type": "object", "properties": { "paymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "VISA", "MASTERCARD", "AMEX", "CASH", "CHEQUE", "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING", "INVOICE", "TRAVELERS_CHECK", "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL", "ANDROID_PAY" ], "x-apidog-enum": [ { "value": "VISA", "name": "", "description": "" }, { "value": "MASTERCARD", "name": "", "description": "" }, { "value": "AMEX", "name": "", "description": "" }, { "value": "CASH", "name": "", "description": "" }, { "value": "CHEQUE", "name": "", "description": "" }, { "value": "CRYPTO", "name": "", "description": "" }, { "value": "DINERS_CLUB", "name": "", "description": "" }, { "value": "DISCOVER", "name": "", "description": "" }, { "value": "FINANCING", "name": "", "description": "" }, { "value": "INVOICE", "name": "", "description": "" }, { "value": "TRAVELERS_CHECK", "name": "", "description": "" }, { "value": "APPLE_PAY", "name": "", "description": "" }, { "value": "SAMSUNG_PAY", "name": "", "description": "" }, { "value": "PAYPAL", "name": "", "description": "" }, { "value": "ANDROID_PAY", "name": "", "description": "" } ] }, "description": "Accepted payment methods (\"VISA\", \"MASTERCARD\", \"AMEX\", \"CASH\", \"CHEQUE\", \"CRYPTO\", \"DINERS_CLUB\", \"DISCOVER\", \"FINANCING\", \"INVOICE\", \"TRAVELERS_CHECK\", \"APPLE_PAY\", \"SAMSUNG_PAY\", \"PAYPAL\", \"ANDROID_PAY\" )" } }, "x-apidog-orders": [ "paymentMethods" ] } }, "x-apidog-orders": [ "" ], "x-apidog-folder": "" }, "PipelineStatus": { "type": "object", "properties": { "id": { "type": "string" }, "socialProfileId": { "type": "string" }, "pipelineType": { "type": "string" }, "status": { "type": "string" }, "currentStep": { "type": "string" }, "stepsCompleted": { "type": "array", "items": { "type": "string" } }, "stepsRemaining": { "type": "array", "items": { "type": "string" } }, "errorMessage": { "type": "string" }, "startedAt": { "type": "string" }, "completedAt": { "type": "string" } }, "x-apidog-orders": [ "id", "socialProfileId", "pipelineType", "status", "currentStep", "stepsCompleted", "stepsRemaining", "errorMessage", "startedAt", "completedAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "PostIdea": { "type": "object", "properties": { "id": { "type": "string" }, "socialProfileId": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "imagePrompt": { "type": "string" }, "imageUrl": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "string" } }, "bucket": { "type": "string" }, "calendarDay": { "type": "integer" }, "scheduledDate": { "type": "string" }, "scheduledTime": { "type": "string" }, "ctaText": { "type": "string" }, "ctaUrl": { "type": "string" }, "note": { "type": "string" }, "seriesId": { "type": "string" }, "socialPostId": { "type": "string" }, "isRecurring": { "type": "boolean" }, "isUserGenerated": { "type": "boolean" }, "observanceName": { "type": "string" }, "observanceDate": { "type": "string" }, "language": { "type": "string" }, "generationBatchId": { "type": "string" }, "fluxJobId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "x-apidog-orders": [ "id", "socialProfileId", "title", "content", "imagePrompt", "imageUrl", "type", "status", "platforms", "bucket", "calendarDay", "scheduledDate", "scheduledTime", "ctaText", "ctaUrl", "note", "seriesId", "socialPostId", "isRecurring", "isUserGenerated", "observanceName", "observanceDate", "language", "generationBatchId", "fluxJobId", "createdAt", "updatedAt" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "PremiumListing": { "type": "object", "properties": { "id": { "type": "string" }, "site": { "type": "object", "properties": { "id": { "type": "string", "format": "base64" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "x-apidog-orders": [ "id", "name", "url" ] }, "syncStatus": { "type": "string", "enum": [ "IN_PROGRESS", "SYNCED", "FAILED", "REQUIRING_ACTION", "AVAILABLE", "COMPLETED", "PENDING_APPROVAL" ] }, "displayStatus": { "type": "string" }, "actionRequired": { "type": "boolean" }, "listingUrl": { "type": "string", "format": "uri", "nullable": true }, "syncIssue": { "type": "string", "nullable": true } }, "x-apidog-orders": [ "id", "site", "syncStatus", "displayStatus", "actionRequired", "listingUrl", "syncIssue" ], "x-apidog-folder": "" }, "RefreshIdeasRequest": { "type": "object", "required": [ "socialProfileId", "profileName" ], "properties": { "socialProfileId": { "type": "string" }, "profileName": { "type": "string" }, "siteUrl": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "brandHashtags": { "type": "array", "items": { "type": "string" } }, "businessIntent": { "type": "string" }, "contentPreferredLanguage": { "type": "string" } }, "x-apidog-orders": [ "socialProfileId", "profileName", "siteUrl", "categories", "brandHashtags", "businessIntent", "contentPreferredLanguage" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "TriggerPipelineResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "pipelineId": { "type": "string" }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "pipelineId", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RefreshLocalIdeasRequest": { "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string" } }, "x-apidog-orders": [ "locationId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RegenerateIdeaRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "topic": { "type": "string" }, "referenceImageUrl": { "type": "string" } }, "x-apidog-orders": [ "ideaId", "topic", "referenceImageUrl" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RegenerateIdeaContentRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "topic": { "type": "string" } }, "x-apidog-orders": [ "ideaId", "topic" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RegenerateIdeaImageRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "referenceImageUrl": { "type": "string" } }, "x-apidog-orders": [ "ideaId", "referenceImageUrl" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RegenerateLocalIdeaRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "topic": { "type": "string" } }, "x-apidog-orders": [ "ideaId", "topic" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RegenerateLocalIdeaContentRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "topic": { "type": "string" } }, "x-apidog-orders": [ "ideaId", "topic" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "RegenerateLocalIdeaImageRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" } }, "x-apidog-orders": [ "ideaId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ResponseInteraction": { "type": "object", "properties": { "interactionId": { "type": "string", "format": "uuid", "description": "Parent interaction ID for the response" }, "source": { "type": "string", "description": "URL of the interaction site" }, "content": { "type": "string", "description": "Interaction response content" }, "authorName": { "type": "string", "description": "Name of person who responded", "nullable": true }, "authorAvatar": { "type": "string", "description": "URL of response author's image", "nullable": true }, "authorUrl": { "type": "string", "description": "URL of response author's profile", "nullable": true }, "date": { "type": "string", "format": "date-time", "description": "Response timestamp" }, "interactionStatus": { "type": "string", "enum": [ "Created", "Completed", "Confirmed", "Failed" ], "description": "Status of the response:\n* Created - Initial creation\n* Completed - Posted to partner site\n* Confirmed - Verified on partner site\n* Failed - Response posting failed\n" } }, "x-apidog-orders": [ "interactionId", "source", "content", "authorName", "authorAvatar", "authorUrl", "date", "interactionStatus" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ScheduleLocalSeriesRequest": { "type": "object", "required": [ "seriesId", "startDate" ], "properties": { "seriesId": { "type": "string" }, "startDate": { "type": "string", "description": "Series start date (YYYY-MM-DD)." } }, "x-apidog-orders": [ "seriesId", "startDate" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ScheduleSeriesRequest": { "type": "object", "required": [ "seriesId", "startDate" ], "properties": { "seriesId": { "type": "string" }, "startDate": { "type": "string", "description": "Series start date (YYYY-MM-DD)." } }, "x-apidog-orders": [ "seriesId", "startDate" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ScheduleSeriesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "scheduledPosts": { "type": "array", "description": "The scheduled posts (see Post idea for the full shape).", "items": { "type": "object", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "error": { "$ref": "#/components/schemas/Error" } }, "x-apidog-orders": [ "success", "scheduledPosts", "error" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ScrapeBrandRequest": { "type": "object", "required": [ "socialProfileId", "siteUrl" ], "properties": { "socialProfileId": { "type": "string" }, "siteUrl": { "type": "string" }, "trigger": { "type": "string" } }, "x-apidog-orders": [ "socialProfileId", "siteUrl", "trigger" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ScrapeLocationRequest": { "type": "object", "required": [ "locationId", "siteUrl" ], "properties": { "locationId": { "type": "string" }, "siteUrl": { "type": "string" }, "trigger": { "type": "string" } }, "x-apidog-orders": [ "locationId", "siteUrl", "trigger" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "ScrapedBrandContext": { "type": "object", "properties": { "id": { "type": "string" }, "socialProfileId": { "type": "string" }, "businessName": { "type": "string" }, "category": { "type": "string" }, "businessDescription": { "type": "string" }, "location": { "type": "string" }, "services": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "products": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "subcategories": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "pricing": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "availability": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "uniqueSellingPoints": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "tone": { "type": "string" }, "targetCustomers": { "type": "string" }, "scrapedImages": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "insights": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "brandPrimaryColor": { "type": "string" }, "brandSecondaryColor": { "type": "string" }, "brandLogoUrl": { "type": "string" }, "scrapedContext": { "type": "string" }, "visualContext": { "type": "object", "description": "Free-form JSON.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "id", "socialProfileId", "businessName", "category", "businessDescription", "location", "services", "products", "subcategories", "pricing", "availability", "uniqueSellingPoints", "tone", "targetCustomers", "scrapedImages", "insights", "brandPrimaryColor", "brandSecondaryColor", "brandLogoUrl", "scrapedContext", "visualContext" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SearchResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "searchLocations": { "type": "object", "properties": { "edges": { "type": "array", "items": { "$ref": "#/components/schemas/LocationEdge" } }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" } }, "x-apidog-orders": [ "edges", "pageInfo" ] } }, "x-apidog-orders": [ "searchLocations" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "SendChatMessageRequest": { "type": "object", "required": [ "sessionId", "message" ], "properties": { "sessionId": { "type": "string" }, "message": { "type": "string" }, "referenceImageUrls": { "type": "array", "items": { "type": "string" } } }, "x-apidog-orders": [ "sessionId", "message", "referenceImageUrls" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SendLocalChatMessageRequest": { "type": "object", "required": [ "sessionId", "message" ], "properties": { "sessionId": { "type": "string" }, "message": { "type": "string" }, "referenceImageUrls": { "type": "array", "items": { "type": "string" } } }, "x-apidog-orders": [ "sessionId", "message", "referenceImageUrls" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SetBrandImageCreditsRequest": { "type": "object", "required": [ "socialProfileId" ], "properties": { "socialProfileId": { "type": "string" }, "monthlyLimit": { "type": "integer" }, "isActive": { "type": "boolean" } }, "x-apidog-orders": [ "socialProfileId", "monthlyLimit", "isActive" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SetLocationImageCreditsRequest": { "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string" }, "monthlyLimit": { "type": "integer" }, "isActive": { "type": "boolean" } }, "x-apidog-orders": [ "locationId", "monthlyLimit", "isActive" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SiteWiseAnalytics": { "type": "object", "properties": { "data": { "type": "object", "properties": { "interactionsSitesStats": { "type": "object", "properties": { "stats": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "siteUrl": { "type": "string" }, "averageRating": { "$ref": "#/components/schemas/MetricWithDelta" }, "totalInteractions": { "$ref": "#/components/schemas/MetricWithDelta" }, "newInteractions": { "$ref": "#/components/schemas/MetricWithDelta" }, "recency": { "type": "string" }, "baseRating": { "type": "number" }, "baseInteractions": { "type": "integer" }, "humanizedRecency": { "type": "string" } }, "x-apidog-orders": [ "key", "siteUrl", "averageRating", "totalInteractions", "newInteractions", "recency", "baseRating", "baseInteractions", "humanizedRecency" ] } } }, "x-apidog-orders": [ "stats" ] } }, "x-apidog-orders": [ "interactionsSitesStats" ] } }, "x-apidog-orders": [ "data" ], "x-apidog-folder": "" }, "StartChatSessionRequest": { "type": "object", "required": [ "socialProfileId" ], "properties": { "socialProfileId": { "type": "string" }, "intent": { "type": "string" }, "mode": { "type": "string" }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" } }, "x-apidog-orders": [ "socialProfileId", "intent", "mode", "subjectType", "subjectId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "StartLocalChatSessionRequest": { "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "description": "Relay-encoded location ID." }, "intent": { "type": "string", "description": "Conversation intent (e.g. idea)." }, "mode": { "type": "string", "description": "Generation mode (e.g. fast)." }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" } }, "x-apidog-orders": [ "locationId", "intent", "mode", "subjectType", "subjectId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SubCategory": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "1234" ] }, "name": { "type": "string", "examples": [ "Restaurants" ] } }, "x-apidog-orders": [ "id", "name" ], "x-apidog-folder": "" }, "SuggestLocalPostsForDateRequest": { "type": "object", "required": [ "locationId", "date" ], "properties": { "locationId": { "type": "string" }, "date": { "type": "string", "description": "Target date (YYYY-MM-DD)." } }, "x-apidog-orders": [ "locationId", "date" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SuggestPostsForDateRequest": { "type": "object", "required": [ "socialProfileId", "date" ], "properties": { "socialProfileId": { "type": "string" }, "date": { "type": "string", "description": "Target date (YYYY-MM-DD)." } }, "x-apidog-orders": [ "socialProfileId", "date" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SwitchChatModeRequest": { "type": "object", "required": [ "sessionId", "mode" ], "properties": { "sessionId": { "type": "string" }, "mode": { "type": "string" } }, "x-apidog-orders": [ "sessionId", "mode" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "SwitchLocalChatModeRequest": { "type": "object", "required": [ "sessionId", "mode" ], "properties": { "sessionId": { "type": "string" }, "mode": { "type": "string" } }, "x-apidog-orders": [ "sessionId", "mode" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "Tag": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the tag" }, "name": { "type": "string", "description": "Display name of the tag" } }, "x-apidog-orders": [ "id", "name" ], "x-apidog-folder": "" }, "TriggerLocalPipelineRequest": { "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string" } }, "x-apidog-orders": [ "locationId" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "TriggerMatchesRequest": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "object", "required": [ "connectedAccountIds" ], "properties": { "connectedAccountIds": { "type": "array", "description": "List of connected account IDs to process", "minItems": 1, "items": { "type": "string", "format": "uuid", "examples": [ "6eb312f7-df32-4d76-ad8a-26bcfeab601e" ] } } }, "x-apidog-orders": [ "connectedAccountIds" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "input" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "TriggerMatchesResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectedAccountsTriggerMatches": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Indicates if all connected accounts were processed successfully.\nReturns false if any account failed to process.\n" }, "failedIds": { "type": "array", "description": "List of connected account IDs that failed to process", "items": { "type": "string", "format": "uuid" }, "examples": [ [ "7eb3q2f7-df34-4dt6-hd88-269cfoal6m1b" ] ] } }, "x-apidog-orders": [ "success", "failedIds" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "connectedAccountsTriggerMatches" ], "x-apidog-ignore-properties": [] } }, "x-apidog-orders": [ "data" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "TriggerPipelineRequest": { "type": "object", "required": [ "socialProfileId", "profileName" ], "properties": { "socialProfileId": { "type": "string" }, "profileName": { "type": "string" }, "siteUrl": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "brandHashtags": { "type": "array", "items": { "type": "string" } }, "businessIntent": { "type": "string" }, "contentPreferredLanguage": { "type": "string" } }, "x-apidog-orders": [ "socialProfileId", "profileName", "siteUrl", "categories", "brandHashtags", "businessIntent", "contentPreferredLanguage" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UpdateExtendedBrandConfigRequest": { "type": "object", "required": [ "socialProfileId" ], "properties": { "socialProfileId": { "type": "string" }, "tone": { "type": "string" }, "targetCustomers": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "string" }, "location": { "type": "string" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "logoLight": { "type": "string" }, "logoDark": { "type": "string" }, "services": { "type": "object", "description": "Free-form JSON describing services.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "products": { "type": "object", "description": "Free-form JSON describing products.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "contentRules": { "type": "object", "description": "Free-form JSON content rules.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "additionalContext": { "type": "string" } }, "x-apidog-orders": [ "socialProfileId", "tone", "targetCustomers", "country", "phone", "address", "location", "primaryColor", "secondaryColor", "logoLight", "logoDark", "services", "products", "contentRules", "additionalContext" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UpdateIdeaRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "status": { "type": "string" }, "ctaText": { "type": "string" }, "ctaUrl": { "type": "string" }, "scheduledDate": { "type": "string" }, "scheduledTime": { "type": "string" }, "bucket": { "type": "string" }, "note": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "x-apidog-orders": [ "ideaId", "title", "content", "status", "ctaText", "ctaUrl", "scheduledDate", "scheduledTime", "bucket", "note", "platforms" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" }, "UpdateLocalIdeaRequest": { "type": "object", "required": [ "ideaId" ], "properties": { "ideaId": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "status": { "type": "string" }, "ctaText": { "type": "string" }, "ctaUrl": { "type": "string" }, "scheduledDate": { "type": "string" }, "scheduledTime": { "type": "string" }, "bucket": { "type": "string" }, "note": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "x-apidog-orders": [ "ideaId", "title", "content", "status", "ctaText", "ctaUrl", "scheduledDate", "scheduledTime", "bucket", "note", "platforms" ], "x--orders": [ "ideaId", "title", "content", "status", "ctaText", "ctaUrl", "scheduledDate", "scheduledTime", "bucket", "note", "platforms" ], "x--ignore-properties": [], "x-apidog-folder": "" }, "UpsertExtendedLocationConfigRequest": { "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string" }, "tone": { "type": "string" }, "targetCustomers": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "string" }, "location": { "type": "string" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "logoLight": { "type": "string" }, "logoDark": { "type": "string" }, "services": { "type": "object", "description": "Free-form JSON describing services.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "products": { "type": "object", "description": "Free-form JSON describing products.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "contentRules": { "type": "object", "description": "Free-form JSON content rules.", "x-apidog-orders": [], "properties": {}, "x-apidog-ignore-properties": [] }, "additionalContext": { "type": "string" } }, "x-apidog-orders": [ "locationId", "tone", "targetCustomers", "country", "phone", "address", "location", "primaryColor", "secondaryColor", "logoLight", "logoDark", "services", "products", "contentRules", "additionalContext" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "" } } }