openapi: 3.0.1
info:
  title: Synup API
  version: '4'
  description: 'REST API v4 for the Synup local marketing platform: business locations, listing syndication
    to 80+ directories, review/interaction aggregation and response, review campaigns, local rank tracking
    and grid-rank heatmaps, local and social posts, AI post ideas, menus, connected accounts, users and
    profile analytics.


    ASSEMBLED BY API EVANGELIST from the per-endpoint OpenAPI documents Synup publishes on its own documentation
    host (developer.synup.com, Apidog project 797384). Every operation, parameter, response, example and
    schema below is verbatim provider content; only the merge into a single document is ours. Source index:
    https://developer.synup.com/llms.txt'
  contact:
    name: Synup Developer Documentation
    url: https://developer.synup.com/
  x-assembled-by: api-evangelist enrichment pipeline (local-v1)
  x-assembled-from: 506 per-endpoint OpenAPI fragments published at https://developer.synup.com/<slug>.md
  x-assembled-date: '2026-08-13'
servers:
- url: https://api.synup.com/api/v4
  description: Base ENV (as published in every Synup doc fragment). Tenant workspace domains (https://<workspace>.synup.com/api/v4)
    also serve the same API.
paths:
  /locations/activate:
    post:
      summary: Activate archived locations
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nUse this API to reactivate one or more previously\
        \ archived locations, allowing them to be updated and managed again.\n    \n\n:::info[]\nImportant\
        \ Notes:\n- <span style=\"font-size: 14px;\">Activating a location restores its functionality,\
        \ enabling updates and modifications.</span>\n- <span style=\"font-size: 14px;\">Only archived\
        \ locations can be activated; active locations do not require this action.</span>\n- <span style=\"\
        font-size: 14px;\">Reactivating a location may resume billing based on your subscription plan.</span>\n\
        :::\n</span>"
      operationId: activateLocations
      tags:
      - Locations
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - locationIds
                  properties:
                    locationIds:
                      type: array
                      description: Array of location Node IDs to activate
                      items:
                        type: string
                  x-apidog-orders:
                  - locationIds
              x-apidog-orders:
              - input
            example:
              input:
                locationIds:
                - TG9jYXRpb246MTE3MTM4OQ==
      responses:
        '200':
          description: Locations activated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      activateLocations:
                        type: object
                        properties:
                          bulkEditTaskId:
                            type: string
                            description: ID of bulk edit task if multiple locations are being activated
                            nullable: true
                          clientMutationId:
                            type: string
                            nullable: true
                          errors:
                            type: array
                            items:
                              type: string
                            nullable: true
                          result:
                            type: array
                            items:
                              type: object
                              properties:
                                errors:
                                  type: array
                                  items:
                                    type: string
                                  nullable: true
                                locationId:
                                  type: string
                                  description: Node ID of the location
                                status:
                                  type: string
                                  enum:
                                  - ACTIVE
                                  description: Final status of the activation operation
                                success:
                                  type: boolean
                                  description: Whether the operation was successful
                              x-apidog-orders:
                              - errors
                              - locationId
                              - status
                              - success
                          success:
                            type: boolean
                            nullable: true
                        x-apidog-orders:
                        - bulkEditTaskId
                        - clientMutationId
                        - errors
                        - result
                        - success
                    x-apidog-orders:
                    - activateLocations
                x-apidog-orders:
                - data
              example:
                data:
                  activateLocations:
                    bulkEditTaskId: null
                    clientMutationId: null
                    errors: null
                    result:
                    - errors: null
                      locationId: TG9jYXRpb246MTE3MTM4OQ==
                      status: ACTIVE
                      success: true
                    success: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Insufficient permissions to activate locations
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13659836-run
  /social-post-ideas/active-chat-session:
    get:
      summary: Active chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the currently active AI post-idea chat session for a brand (social profile), if one exists.
        Set `excludeSeries` to skip sessions that belong to a content series.

        </span>'
      operationId: activeChatSession
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: excludeSeries
        in: query
        description: Exclude sessions that belong to a content series.
        required: false
        example: ''
        schema:
          type: boolean
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      activeChatSession:
                        $ref: '#/components/schemas/ChatSession'
                    x-apidog-orders:
                    - activeChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055529-run
  /menus/{menuId}/items:
    post:
      summary: Add an item to an existing section
      deprecated: false
      description: ''
      tags:
      - Menus
      parameters:
      - name: menuId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    sectionId:
                      type: string
                    offeringsItem:
                      type: object
                      properties:
                        displayName:
                          type: string
                        description:
                          type: string
                        price:
                          type: string
                      required:
                      - displayName
                      - description
                      - price
                  required:
                  - sectionId
                  - offeringsItem
              required:
              - input
            example:
              input:
                sectionId: '{sectionId}'
                offeringsItem:
                  displayName: Caprese
                  description: Tomato, mozzarella, and basil
                  price: '12.00'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Menus
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169805-run
  /locations/review-campaigns/customers:
    post:
      summary: Add customers to a review campaign
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API adds new customers to an existing review campaign, allowing them to receive review requests.


        **Behavior:**

        - Supports batch addition of multiple customers in a single request.

        - Customers will receive review requests via the configured delivery method (email, SMS, or both).

        - Ensures duplicate entries are not added to the same campaign.

        </span>'
      operationId: addCustomersToReviewCampaign
      tags:
      - Review Campaigns
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCustomersRequest'
            example: ''
      responses:
        '200':
          description: Successfully added customers
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Review Campaigns
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-14003757-run
  /locations/reviews/settings/edit:
    get:
      summary: Add / Edit interaction source
      deprecated: false
      description: '<span style="font-size: 14px;">

        Use this endpoint to add a new interaction source URL.

        The body of the request must contain the locationId and a siteUrls array.



        <TipInfo>Interaction sources for connected Google and Facebook accounts cannot be modified/added
        to. These interaction sources are automatically added when you connect your Google and Facebook
        accounts.</TipInfo>




        </span>'
      tags:
      - Reviews/Review Sources
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                locationId:
                  type: string
                siteUrls:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      url:
                        type: string
                    x-apidog-orders:
                    - name
                    - url
              required:
              - locationId
              - siteUrls
              x-apidog-orders:
              - locationId
              - siteUrls
            example:
              locationId: TG9jYXRpb246MTY4MDU=
              siteUrls:
              - name: trulia.com
                url: test.com
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      editInteractionsSetting:
                        type: object
                        properties:
                          errors:
                            type: 'null'
                          interactionSetting:
                            type: object
                            properties:
                              positiveInteractionThreshold:
                                type: integer
                              siteSettings:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    url:
                                      type: string
                                      nullable: true
                                    connected:
                                      type: boolean
                                  required:
                                  - name
                                  - url
                                  - connected
                                  x-apidog-orders:
                                  - name
                                  - url
                                  - connected
                              id:
                                type: string
                            required:
                            - positiveInteractionThreshold
                            - siteSettings
                            - id
                            x-apidog-orders:
                            - positiveInteractionThreshold
                            - siteSettings
                            - id
                        required:
                        - errors
                        - interactionSetting
                        x-apidog-orders:
                        - errors
                        - interactionSetting
                      interactionSiteConfig:
                        type: array
                        items:
                          type: object
                          properties:
                            site:
                              type: string
                            siteUrl:
                              type: string
                          required:
                          - site
                          - siteUrl
                          x-apidog-orders:
                          - site
                          - siteUrl
                      interactionsSetting:
                        type: object
                        properties:
                          siteSettings:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                url:
                                  type: string
                                  nullable: true
                              required:
                              - name
                              - url
                              x-apidog-orders:
                              - name
                              - url
                        required:
                        - siteSettings
                        x-apidog-orders:
                        - siteSettings
                    required:
                    - editInteractionsSetting
                    - interactionSiteConfig
                    - interactionsSetting
                    x-apidog-orders:
                    - editInteractionsSetting
                    - interactionSiteConfig
                    - interactionsSetting
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  editInteractionsSetting:
                    errors: null
                    interactionSetting:
                      positiveInteractionThreshold: 2
                      siteSettings:
                      - name: trulia.com
                        url: test.com
                        connected: false
                      - name: google.com
                        url: test.com
                        connected: false
                      - name: foursquare.com
                        url: test.com
                        connected: false
                      - name: yelp.com
                        url: https://www.yelp.com/biz/yelp-san-francisco?sort_by=date_desc
                        connected: false
                      - name: facebook.com
                        url: https://www.facebook.com/Om-book-shop-613976075648984/
                        connected: true
                      - name: maps.google.com
                        url: https://maps.google.com/maps?cid=11886702604501862703
                        connected: true
                      - name: zillow.com
                        url: null
                        connected: false
                      - name: realtor.com
                        url: null
                        connected: false
                      - name: reach150.com
                        url: null
                        connected: false
                      - name: yelloyello.com
                        url: https://www.yelloyello.com/places/tryvexan-review-new-york
                        connected: false
                      id: 743c8f7e-cc47-42ff-a640-3c4d072dcb86
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Reviews/Review Sources
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19357403-run
  /users/folders/add:
    post:
      summary: Add folders to user
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n    \n    This API associates one or more folders\
        \ with a specified user, granting them access to manage those folders.\n\n**Behavior:**\n- Supports\
        \ assigning multiple folders to a single user.\n- Updates the user's permissions based on assigned\
        \ folders.\n</span>"
      tags:
      - User Management
      - User Management
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - userId
                  - folderIds
                  - defaultFolderId
                  properties:
                    userId:
                      type: string
                      description: Base64 encoded user ID
                    folderIds:
                      type: array
                      items:
                        type: string
                        format: uuid
                      description: Array of folder UUIDs to associate with the user
                    defaultFolderId:
                      type: string
                  x-apidog-orders:
                  - userId
                  - folderIds
                  - defaultFolderId
              x-apidog-orders:
              - input
            example:
              input:
                userId: VXNlcjoxMDAyOA==
                folderIds:
                - c1d92c09-8ddd-469e-af96-0eb64a48d647
                - a5af4f5d-41b6-4a8a-b24f-98741b021b7b
                defaultFolderId: c1d92c09-8ddd-469e-af96-0eb64a48d647
      responses:
        '200':
          description: Successfully added folders to user
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addFoldersForUser:
                        type: object
                        properties:
                          status:
                            type: array
                            items:
                              type: object
                              properties:
                                errors:
                                  type: array
                                  items:
                                    type: string
                                  nullable: true
                                folderId:
                                  type: string
                                  format: uuid
                                success:
                                  type: boolean
                              x-apidog-orders:
                              - errors
                              - folderId
                              - success
                        x-apidog-orders:
                        - status
                    x-apidog-orders:
                    - addFoldersForUser
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13994432-run
  /locations/keywords:
    post:
      summary: Add keywords
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API allows you to add keywords that you want to track, for a specific location.



        </span>


        :::caution[]

        <span style="font-size: 14px;"> **Limitations:** The number of keywords that can be added for
        a location is subject to your subscription plan. Please consult the support team to determine
        the exact number applicable to your account.</span>

        :::'
      tags:
      - Rankings
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication. Must be prefixed with 'API '
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                locationId:
                  type: string
                inputKeywords:
                  type: array
                  items:
                    type: string
              required:
              - locationId
              - inputKeywords
              x-apidog-orders:
              - locationId
              - inputKeywords
            example:
              locationId: TG9jYXRpb246MTM5OTg=
              inputKeywords:
              - road paving
              - road building
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addKeywords:
                        type: object
                        properties:
                          keywords:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                primary:
                                  type: 'null'
                                archived:
                                  type: boolean
                                archiveReasonId:
                                  type: 'null'
                                databaseId:
                                  type: integer
                                name:
                                  type: string
                              required:
                              - id
                              - primary
                              - archived
                              - archiveReasonId
                              - databaseId
                              - name
                              x-apidog-orders:
                              - id
                              - primary
                              - archived
                              - archiveReasonId
                              - databaseId
                              - name
                          errors:
                            type: 'null'
                        required:
                        - keywords
                        - errors
                        x-apidog-orders:
                        - keywords
                        - errors
                    required:
                    - addKeywords
                    x-apidog-orders:
                    - addKeywords
                required:
                - data
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      addKeywords:
                        keywords:
                        - id: S2V5d29yZDoxOTM2Nzk1
                          primary: null
                          archived: false
                          archiveReasonId: null
                          databaseId: 1936795
                          name: road paving
                        - id: S2V5d29yZDoxOTM2Nzk2
                          primary: null
                          archived: false
                          archiveReasonId: null
                          databaseId: 1936796
                          name: road building
                        errors: null
                '2':
                  summary: If keyword already exists
                  value:
                    data:
                      addKeywords:
                        keywords: null
                        errors:
                        - message: Keyword with name road paving already exists
                          contextInfo:
                          - key: keyword
                            value: road paving
                          code: SY20106
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Rankings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13687734-run
  /locations/tags:
    post:
      summary: Add location to a tag
      deprecated: false
      description: '

        <span style="font-size: 14px;">

        This API associates a location with a specified tag. If the tag does not exist, it will be automatically
        created before the association.


        **Behavior:**

        - Can be used to create new tags and assign existing tags to locations.

        - Each location can have a maximum of 10 tags. Exceeding this limit will result in an error.


        </span>





        '
      operationId: addLocationToTag
      tags:
      - Organizing locations
      - Tags
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - locationId
                  - tag
                  properties:
                    locationId:
                      type: string
                      description: Unique identifier of the location
                      examples:
                      - TG9jYXRpb246MTY4NjA=
                    tag:
                      type: string
                      description: Name of the tag to add the location to
                      examples:
                      - New
                  x-apidog-orders:
                  - locationId
                  - tag
              x-apidog-orders:
              - input
            example: ''
      responses:
        '200':
          description: Operation result
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addTag:
                        type: object
                        properties:
                          clientMutationId:
                            type: null
                            description: Optional client-provided mutation identifier
                          errors:
                            type: array
                            description: Array of errors if any occurred
                            items:
                              type: object
                              properties:
                                code:
                                  type: string
                                  description: Error code
                                  examples:
                                  - SY10040
                                message:
                                  type: string
                                  description: Human-readable error message
                                contextInfo:
                                  type: array
                                  description: Additional context about the error
                                  items:
                                    type: string
                              x-apidog-orders:
                              - code
                              - message
                              - contextInfo
                          success:
                            type: boolean
                            description: Indicates if the operation was successful
                          tag:
                            type: object
                            description: Details of the created/existing tag
                            properties:
                              id:
                                type: string
                                format: uuid
                                description: Unique identifier of the tag
                              name:
                                type: string
                                description: Name of the tag
                            x-apidog-orders:
                            - id
                            - name
                            nullable: true
                        x-apidog-orders:
                        - clientMutationId
                        - errors
                        - success
                        - tag
                    x-apidog-orders:
                    - addTag
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: success
                  value:
                    data:
                      addTag:
                        clientMutationId: null
                        errors: []
                        success: true
                        tag:
                          id: 463621f0-df7c-4d5b-8b6b-8b7a23686dcf
                          name: new10
                '2':
                  summary: tagLimitError
                  value:
                    data:
                      addTag:
                        clientMutationId: null
                        errors:
                        - code: SY10040
                          contextInfo: []
                          message: Cannot add more than 10 tags
                        success: false
                        tag: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - Invalid location ID or tag name
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660400-run
  /locations/folders:
    post:
      summary: Add locations to a folder
      deprecated: false
      description: '<span style="font-size: 14px;">


        This API adds specified locations to a folder. If the folder does not exist, it will be created
        automatically.


        Behavior:

        - If `locationIds` are provided, the locations will be added to the folder.

        - If ` locationIds` is omitted or empty, only the folder will be created.


        </span>'
      tags:
      - Organizing locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - name
                  properties:
                    name:
                      type: string
                      description: Name of the folder to add locations to
                      examples:
                      - Acme
                    locationIds:
                      type: array
                      description: Array of location IDs to add to the folder
                      items:
                        type: string
                      examples:
                      - - TG9jYXRpb246MTY4NjE=
                        - TG9jYXRpb246MTY4NjA=
                  x-apidog-orders:
                  - name
                  - locationIds
              x-apidog-orders:
              - input
            example: ''
      responses:
        '200':
          description: Successfully added locations to folder
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addLocationsToFolder:
                        type: object
                        properties:
                          errors:
                            type: null
                            description: Array of errors if any occurred
                          folder:
                            type: object
                            properties:
                              accountId:
                                type: integer
                                examples:
                                - 10072
                              archived:
                                type: boolean
                                examples:
                                - false
                              id:
                                type: string
                                examples:
                                - 0e4cc56e-45f8-4058-a713-ead264fa9318
                              name:
                                type: string
                                examples:
                                - acme
                              root:
                                type: boolean
                                examples:
                                - false
                            x-apidog-orders:
                            - accountId
                            - archived
                            - id
                            - name
                            - root
                        x-apidog-orders:
                        - errors
                        - folder
                    x-apidog-orders:
                    - addLocationsToFolder
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660182-run
  /users/locations/add:
    post:
      summary: Add Locations to User
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API associates specific locations with a user, granting them access to manage those locations.


        **Behavior:**

        - Supports assigning multiple locations to a single user.

        - Updates the user''s permissions and access scope based on assigned locations.

        </span>'
      operationId: addLocationsToUser
      tags:
      - User Management
      - Users
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  $ref: '#/components/schemas/AddLocationsInput'
              x-apidog-orders:
              - input
              x-apidog-ignore-properties: []
            example:
              input:
                userId: VXNlcjoxMjMyMDE=
                locationIds:
                - TG9jYXRpb246MTE3NjE5NQ==
                - TG9jYXRpb246MTE0NzgxNA==
      responses:
        '200':
          description: Locations successfully added to user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddLocationsResponse'
              example:
                data:
                  addLocationsForUser:
                    status:
                    - errors: null
                      locationId: TG9jYXRpb246MTE3NjE5NQ==
                      success: true
                    - errors: null
                      locationId: TG9jYXRpb246MTE0NzgxNA==
                      success: true
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request - Invalid input parameters
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Valid API key required
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Not Found - User or locations not found
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932855-run
  /review_widget/add:
    post:
      summary: Add Review Widget
      deprecated: false
      description: ''
      tags:
      - Reviews
      - Interactions
      parameters:
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API nQWIQkSj_nLpgzeSXtSjNVCxhVU
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                locationId:
                  type: string
                minimumRating:
                  type: integer
                name:
                  type: string
                readOnly:
                  type: boolean
                reviewCount:
                  type: integer
                sites:
                  type: array
                  items:
                    type: string
                widgetHeight:
                  type: string
                widgetType:
                  type: string
                widgetWidth:
                  type: string
              required:
              - locationId
              - minimumRating
              - name
              - readOnly
              - reviewCount
              - sites
              - widgetHeight
              - widgetType
              - widgetWidth
            example:
              locationId: TG9jYXRpb246NzAzNTY1
              minimumRating: 5
              name: 'testing functionality2 '
              readOnly: false
              reviewCount: 10
              sites:
              - maps.google.com
              - facebook.com
              - yelp.com
              widgetHeight: 470px
              widgetType: medium_slider
              widgetWidth: 100%
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addReviewWidget:
                        type: object
                        properties:
                          widget:
                            type: 'null'
                          errors:
                            type: array
                            items:
                              type: object
                              properties:
                                contextInfo:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      key:
                                        type: string
                                      value:
                                        type: string
                                code:
                                  type: string
                                message:
                                  type: string
                        required:
                        - widget
                        - errors
                    required:
                    - addReviewWidget
                required:
                - data
              example:
                data:
                  addReviewWidget:
                    widget: null
                    errors:
                    - contextInfo:
                      - key: name
                        value: 'testing functionality2 '
                      code: SY50101
                      message: Widget name testing functionality2  already used
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-20127692-run
  /users/add_user_and_folder:
    post:
      summary: Add User and folder
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n    \nThis api is a combination of add_user and\
        \ create_folder and assign_folder_to_user APIs. The API will take in all parameters of add_user\
        \ API and create_folder APIs. Operations to be done are create user, create folder and assign\
        \ folder to user.\n\n</span>"
      tags:
      - User Management
      - User Management
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    roleId:
                      type: string
                    firstName:
                      type: string
                    lastName:
                      type: string
                    email:
                      type: string
                    directCustomer:
                      type: boolean
                    locale:
                      type: string
                    locationIds:
                      type: array
                      items:
                        type: string
                    socialProfileIds:
                      type: array
                      items:
                        type: string
                    name:
                      type: string
                    userId:
                      type: string
                      description: Base64 encoded user ID
                    isDefaultFolder:
                      type: boolean
                  required:
                  - roleId
                  - firstName
                  - lastName
                  - email
                  - directCustomer
                  - locale
                  - locationIds
                  - socialProfileIds
                  - name
                  - userId
                  - isDefaultFolder
                  x-apidog-orders:
                  - roleId
                  - firstName
                  - lastName
                  - email
                  - directCustomer
                  - locale
                  - locationIds
                  - socialProfileIds
                  - name
                  - userId
                  - isDefaultFolder
              required:
              - input
              x-apidog-orders:
              - input
            example:
              input:
                roleId: Q3VzdG9tUm9sZToyMDgzMQ==
                firstName: 'testing '
                lastName: user
                email: sandeep.kota+918673997@synup.com
                directCustomer: true
                locale: ENGLISH
                locationIds:
                - TG9jYXRpb246ODcxMjE=
                socialProfileIds: []
                name: sandybroskis19
                isDefaultFolder: true
      responses:
        '200':
          description: Successfully added folders to user
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addUserAndFolder:
                        type: object
                        properties:
                          success:
                            type: boolean
                          assignFolder:
                            type: boolean
                          user:
                            type: object
                            properties:
                              firstName:
                                type: string
                              lastName:
                                type: string
                              email:
                                type: string
                              directCustomer:
                                type: boolean
                              databaseId:
                                type: integer
                            required:
                            - firstName
                            - lastName
                            - email
                            - directCustomer
                            - databaseId
                            x-apidog-orders:
                            - firstName
                            - lastName
                            - email
                            - directCustomer
                            - databaseId
                          folder:
                            type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              locationCount:
                                type: 'null'
                            required:
                            - id
                            - name
                            - locationCount
                            x-apidog-orders:
                            - id
                            - name
                            - locationCount
                          errors:
                            type: array
                            items:
                              type: string
                        required:
                        - success
                        - assignFolder
                        - user
                        - folder
                        - errors
                        x-apidog-orders:
                        - success
                        - assignFolder
                        - user
                        - folder
                        - errors
                      addFoldersForUser:
                        type: object
                        properties:
                          status:
                            type: array
                            items:
                              type: object
                              properties:
                                errors:
                                  type: array
                                  items:
                                    type: string
                                  nullable: true
                                folderId:
                                  type: string
                                  format: uuid
                                success:
                                  type: boolean
                              x-apidog-orders:
                              - errors
                              - folderId
                              - success
                        x-apidog-orders:
                        - status
                    required:
                    - addUserAndFolder
                    x-apidog-orders:
                    - addUserAndFolder
                    - addFoldersForUser
                required:
                - data
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19358677-run
  /local-post-ideas/analyze-reference-image:
    get:
      summary: Analyze reference image
      deprecated: false
      description: '<span style="font-size: 14px;">

        Analyzes a reference image at the given URL and returns a textual description that can be used
        to ground post-idea generation. Optionally pass a `category` hint to focus the analysis.

        </span>'
      operationId: analyzeReferenceImage
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: imageUrl
        in: query
        description: URL of the image to analyze.
        required: true
        example: https://cdn.example.com/photo.jpg
        schema:
          type: string
      - name: category
        in: query
        description: Optional category hint to focus the analysis.
        required: false
        example: ''
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      analyzeReferenceImage:
                        $ref: '#/components/schemas/ReferenceImageAnalysis'
                    x-apidog-orders:
                    - analyzeReferenceImage
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052170-run
  /social-post-ideas/analyze-reference-image:
    get:
      summary: Analyze reference image
      deprecated: false
      description: '<span style="font-size: 14px;">

        Analyzes a reference image at the given URL and returns a textual description that can be used
        to ground social post-idea generation. Optionally pass a `category` hint to focus the analysis.

        </span>'
      operationId: analyzeReferenceImage
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: imageUrl
        in: query
        description: URL of the image to analyze.
        required: true
        example: https://cdn.example.com/photo.jpg
        schema:
          type: string
      - name: category
        in: query
        description: Optional category hint to focus the analysis.
        required: false
        example: ''
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      analyzeReferenceImage:
                        $ref: '#/components/schemas/ReferenceImageAnalysis'
                    x-apidog-orders:
                    - analyzeReferenceImage
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055530-run
  /connected-accounts/apple-confirmed-matches:
    get:
      summary: Apple confirmed matches
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the confirmed matches between Synup locations and Apple Business listings for a connected
        Apple account. These are produced after a location has been connected via the Apple Business Connect
        OAuth flow (see Connect link for Apple). Results are paginated.

        </span>'
      operationId: appleConfirmedMatches
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: accountId
        in: query
        description: Account ID.
        required: true
        example: QWNjb3VudDoxMjM=
        schema:
          type: string
      - name: connectedAccountId
        in: query
        description: ID of the connected Apple account.
        required: true
        example: Q29ubmVjdGVkQWNjb3VudDo0NTY=
        schema:
          type: string
      - name: page
        in: query
        description: Page number (1-based).
        required: true
        example: 1
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      appleConfirmedMatches:
                        $ref: '#/components/schemas/AppleConfirmedMatches'
                    x-apidog-orders:
                    - appleConfirmedMatches
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40050924-run
  /locations/keywords/archive:
    post:
      summary: Archive a keyword
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API removes a keyword from the list of tracked keywords for a specific location by archiving
        it.

        </span>'
      tags:
      - Rankings
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
                  description: Keyword ID to archive
                  examples:
                  - S2V5d29yZDo3NjQzMTE=
              x-apidog-orders:
              - id
              x-apidog-ignore-properties: []
            example: ''
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      archiveKeyword:
                        type: object
                        properties:
                          keyword:
                            type: object
                            properties:
                              id:
                                type: string
                                description: The unique ID attached to the keyword
                                examples:
                                - S2V5d29yZDo3NjQzMTE=
                              archived:
                                type: boolean
                                description: Indicates if the keyword has been archived
                                examples:
                                - true
                              name:
                                type: string
                                description: The text value of the keyword
                                examples:
                                - road building
                            x-apidog-orders:
                            - id
                            - archived
                            - name
                            x-apidog-ignore-properties: []
                        x-apidog-orders:
                        - keyword
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - archiveKeyword
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
          headers: {}
          x-apidog-name: Unauthorized
      security: []
      x-apidog-folder: Rankings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695580-run
  /social-post-ideas/archive-idea:
    post:
      summary: Archive idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Archives a social post idea so it no longer appears in active idea listings.

        </span>'
      operationId: archiveIdea
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArchiveIdeaRequest'
            example:
              ideaId: 91b2...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      archiveIdea:
                        $ref: '#/components/schemas/MutationResponse'
                    x-apidog-orders:
                    - archiveIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055531-run
  /local-post-ideas/archive-idea:
    post:
      summary: Archive local idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Archives a post idea so it no longer appears in active idea listings.

        </span>'
      operationId: archiveLocalIdea
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArchiveLocalIdeaRequest'
            example:
              ideaId: 91b2...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      archiveLocalIdea:
                        $ref: '#/components/schemas/LocalMutationResponse'
                    x-apidog-orders:
                    - archiveLocalIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052176-run
  /local-post-ideas/archive-series:
    post:
      summary: Archive local series
      deprecated: false
      description: '<span style="font-size: 14px;">

        Archives a content series so it no longer appears in active series listings.

        </span>'
      operationId: archiveLocalSeries
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArchiveLocalSeriesRequest'
            example:
              seriesId: 3a1f...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      archiveLocalSeries:
                        $ref: '#/components/schemas/LocalMutationResponse'
                    x-apidog-orders:
                    - archiveLocalSeries
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052177-run
  /locations/archive:
    post:
      summary: Archive multiple locations
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API allows you to archive One or More Business\
        \ Locations. \n\n:::info[]\n- <span style=\"font-size: 14px;\">Archiving a location does not delete\
        \ it from your account.</span>\n- <span style=\"font-size: 14px;\">Archived locations cannot be\
        \ updated until reactivated.</span>\n- <span style=\"font-size: 14px;\">The location will be scheduled\
        \ for archival until the end of the billing cycle.</span>\n- <span style=\"font-size: 14px;\"\
        >Once the invoice for the next month is generated, the location will be archived.</span>\n- <span\
        \ style=\"font-size: 14px;\">Payments for archived locations stop after the current billing cycle\
        \ is completed.</span>\n\n:::\n\n</span>"
      operationId: archiveLocations
      tags:
      - Locations
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - locationIds
                  properties:
                    locationIds:
                      type: array
                      description: Array of location Node IDs to archive
                      items:
                        type: string
                  x-apidog-orders:
                  - locationIds
              x-apidog-orders:
              - input
            example:
              input:
                locationIds:
                - TG9jYXRpb246MTE4MzMzMA==
                - TG9jYXRpb246MTE3MTM4OQ==
      responses:
        '200':
          description: Locations archived successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      archiveLocations:
                        type: object
                        properties:
                          bulkEditTaskId:
                            type: string
                            nullable: true
                          clientMutationId:
                            type: string
                            nullable: true
                          errors:
                            type: array
                            items:
                              type: string
                            nullable: true
                          result:
                            type: array
                            items:
                              type: object
                              properties:
                                errors:
                                  type: array
                                  items:
                                    type: string
                                  nullable: true
                                locationId:
                                  type: string
                                  description: Node ID of the location
                                status:
                                  type: string
                                  enum:
                                  - ARCHIVED
                                  - ARCHIVE_SCHEDULED
                                  description: Final status of the archive operation
                                success:
                                  type: boolean
                                  description: Whether the operation was successful
                              x-apidog-orders:
                              - errors
                              - locationId
                              - status
                              - success
                          success:
                            type: boolean
                            nullable: true
                        x-apidog-orders:
                        - bulkEditTaskId
                        - clientMutationId
                        - errors
                        - result
                        - success
                    x-apidog-orders:
                    - archiveLocations
                x-apidog-orders:
                - data
              example:
                data:
                  archiveLocations:
                    bulkEditTaskId: null
                    clientMutationId: null
                    errors: null
                    result:
                    - errors: null
                      locationId: TG9jYXRpb246MTE3MTM4OQ==
                      status: ARCHIVE_SCHEDULED
                      success: true
                    - errors: null
                      locationId: TG9jYXRpb246MTE4MzMzMA==
                      status: ARCHIVE_SCHEDULED
                      success: true
                    success: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13659698-run
  /locations/reviews/respond/archive:
    post:
      summary: Archive Response for Interaction
      deprecated: false
      description: '<span style="font-size: 14px;">

        Archive any response provided for any existing Interaction

        </span>'
      operationId: respondToInteraction
      tags:
      - Reviews
      - Interactions
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - responseId
              properties:
                responseId:
                  type: string
                  description: "Response ID\t"
                  format: uuid
              x-apidog-orders:
              - responseId
            example:
              responseId: 2090753a-ece6-4837-8336-8494ad308523
      responses:
        '200':
          description: Response successfully posted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      archiveResponse:
                        type: object
                        properties:
                          status:
                            type: boolean
                        x-apidog-orders:
                        - status
                    x-apidog-orders:
                    - archiveResponse
                x-apidog-orders:
                - data
              example: "{\n    \"data\": {\n        \"archiveResponse\": {\n            \"status\": \"\
                true\",\n        }\n    }\n}"
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19357202-run
  /social-post-ideas/archive-series:
    post:
      summary: Archive series
      deprecated: false
      description: '<span style="font-size: 14px;">

        Archives a content series so it no longer appears in active series listings.

        </span>'
      operationId: archiveSeries
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArchiveSeriesRequest'
            example:
              seriesId: 3a1f...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      archiveSeries:
                        $ref: '#/components/schemas/MutationResponse'
                    x-apidog-orders:
                    - archiveSeries
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055564-run
  /menus/{menuId}/assign-location:
    post:
      summary: Assign a menu to a location
      deprecated: false
      description: ''
      tags:
      - Menus
      parameters:
      - name: menuId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    locationIds:
                      type: array
                      items:
                        type: string
                  required:
                  - locationIds
              required:
              - input
            example:
              input:
                locationIds:
                - '{locationId}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Menus
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169811-run
  /social/brands/{brandId}:
    put:
      summary: Assign a user to a single brand
      deprecated: false
      description: ''
      tags:
      - Social
      parameters:
      - name: brandId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    userId:
                      type: string
                  required:
                  - userId
              required:
              - input
            example:
              input:
                userId: '{userId}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Social
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169859-run
  /api/v4/social/brands/{brandId1},{brandId2},{brandId3}:
    put:
      summary: Assign multiple brands
      deprecated: false
      description: ''
      tags:
      - Social
      parameters:
      - name: brandId1
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: brandId2
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: brandId3
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    userId:
                      type: string
                  required:
                  - userId
              required:
              - input
            example:
              input:
                userId: '{userId}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Social
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169860-run
  /locations/advanced-search-filters:
    get:
      summary: Available advanced filter values
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Returns the distinct values available for the advanced location filters across the account''s
        locations: countries, states, cities, postal (zip) codes, and custom attribute names. Use these
        values to populate the advanced filter controls before calling Filter locations.

        </span>'
      operationId: advancedSearchFilters
      tags:
      - Locations
      - Locations
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      advancedSearchFilters:
                        $ref: '#/components/schemas/LocationAdvancedSearchFilterType'
                    x-apidog-orders:
                    - advancedSearchFilters
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051636-run
  /locations/search-filters:
    get:
      summary: Available search filter values
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Returns the distinct values available for the standard location filters across the account''s
        accessible locations: tags, folders, categories, additional categories, and Google Business Profile
        (GBP) categories (primary and additional). Use these values to populate the filter controls before
        calling Filter locations.

        </span>'
      operationId: searchFilters
      tags:
      - Locations
      - Locations
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      searchFilters:
                        $ref: '#/components/schemas/LocationSearchFilterType'
                    x-apidog-orders:
                    - searchFilters
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051651-run
  /social-post-ideas/branch-chat-session:
    post:
      summary: Branch chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Creates a new chat session branched from an existing one (`parentSessionId`), anchored to a subject
        (`subjectType` required, `subjectId` optional). Use this to explore an alternative direction without
        losing the original conversation.

        </span>'
      operationId: branchChatSession
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BranchChatSessionRequest'
            example:
              parentSessionId: 7f3c1a2e-...
              subjectType: idea
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      branchChatSession:
                        $ref: '#/components/schemas/ChatSessionResponse'
                    x-apidog-orders:
                    - branchChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055575-run
  /local-post-ideas/branch-chat-session:
    post:
      summary: Branch local chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Creates a new chat session branched from an existing one (`parentSessionId`), optionally anchored
        to a subject (`subjectType`/`subjectId`). Use this to explore an alternative direction without
        losing the original conversation.

        </span>'
      operationId: branchLocalChatSession
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BranchLocalChatSessionRequest'
            example:
              parentSessionId: 7f3c1a2e-...
              subjectType: idea
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      branchLocalChatSession:
                        $ref: '#/components/schemas/LocalChatSessionResponse'
                    x-apidog-orders:
                    - branchLocalChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052178-run
  /social-post-ideas/brand-info:
    get:
      summary: Brand info
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the basic brand profile for a social profile — name, site URL, categories, and country
        — used to ground social post-idea generation.

        </span>'
      operationId: brandInfo
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      brandInfo:
                        $ref: '#/components/schemas/BrandInfo'
                    x-apidog-orders:
                    - brandInfo
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055576-run
  /connected-accounts/connect-apple/bulk:
    post:
      summary: Bulk connect link for Apple
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates an Apple Business Connect OAuth link that connects **multiple locations** in a single
        authorization flow. Unlike Connect link for Apple, no `locationId` is supplied — the set is account/platform-scoped.
        Redirect the user to the returned `url`; the link is valid for 1 day.


        Use `platform` to target `local` (default) or `social`, and `entityId` to supply the brand ID
        when `platform` is `social`.


        **Apple OAuth link variants:**

        - **Connect link for Apple** — single location (`locationId`).

        - **Bulk connect link for Apple** — multiple locations (this endpoint).

        - **Renew connect link for Apple** — re-authorize an expired/revoked token.

        </span>'
      operationId: bulkConnectLinkForApple
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppleOauthBulkRequest'
            example:
              input:
                successUrl: https://app.synup.com/apple/success
                errorUrl: https://app.synup.com/apple/error
                platform: local
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      bulkConnectLinkForApple:
                        $ref: '#/components/schemas/AppleOauthBulkPayload'
                    x-apidog-orders:
                    - bulkConnectLinkForApple
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-39902193-run
  /social-post-ideas/calendar:
    get:
      summary: Calendar
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the content calendar for a brand (social profile) — each day with its scheduled/suggested
        post ideas.

        </span>'
      operationId: calendar
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      calendar:
                        type: array
                        items:
                          $ref: '#/components/schemas/CalendarDay'
                    x-apidog-orders:
                    - calendar
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055577-run
  /locations/cancel_archive:
    post:
      summary: Cancel scheduled location archival
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nUse this API to cancel the archival of locations\
        \ that are scheduled for archival but have not yet been processed.\n    \n:::info[]\n    \n<span\
        \ style=\"font-size: 14px;\">\n**Important Notes:**\n- <span style=\"font-size: 14px;\">This endpoint\
        \ can only cancel archival for locations that are in **ARCHIVE_SCHEDULED** status</span>\n- <span\
        \ style=\"font-size: 14px;\">Once canceled, the location will return to **ACTIVE** status and\
        \ can be updated as usual.</span>\n- <span style=\"font-size: 14px;\">Billing for the location\
        \ will continue as per the standard cycle.</span>\n </span>\n   \n:::\n    </span>"
      operationId: cancelLocationsArchive
      tags:
      - Locations
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - locationIds
                  properties:
                    locationIds:
                      type: array
                      description: Array of location Node IDs to cancel archival for
                      items:
                        type: string
                  x-apidog-orders:
                  - locationIds
              x-apidog-orders:
              - input
            example:
              input:
                locationIds:
                - TG9jYXRpb246MTE4MzMzMA==
      responses:
        '200':
          description: Location archival cancellation successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      cancelLocationsArchive:
                        type: object
                        properties:
                          bulkEditTaskId:
                            type: string
                            description: ID of bulk edit task if multiple locations are involved
                            nullable: true
                          clientMutationId:
                            type: string
                            nullable: true
                          errors:
                            type: array
                            items:
                              type: string
                            nullable: true
                          result:
                            type: array
                            items:
                              type: object
                              properties:
                                errors:
                                  type: array
                                  items:
                                    type: string
                                  nullable: true
                                locationId:
                                  type: string
                                  description: Node ID of the location
                                status:
                                  type: string
                                  enum:
                                  - ACTIVE
                                  description: Status after cancellation
                                success:
                                  type: boolean
                                  description: Whether the operation was successful
                              x-apidog-orders:
                              - errors
                              - locationId
                              - status
                              - success
                          success:
                            type: boolean
                            nullable: true
                        x-apidog-orders:
                        - bulkEditTaskId
                        - clientMutationId
                        - errors
                        - result
                        - success
                    x-apidog-orders:
                    - cancelLocationsArchive
                x-apidog-orders:
                - data
              example:
                data:
                  cancelLocationsArchive:
                    bulkEditTaskId: null
                    clientMutationId: null
                    errors: null
                    result:
                    - errors: null
                      locationId: TG9jYXRpb246MTE4MzMzMA==
                      status: ACTIVE
                      success: true
                    success: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Location not found or not in ARCHIVE_SCHEDULED status
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13659850-run
  /social-post-ideas/chat-history:
    get:
      summary: Chat history
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the messages for a given AI post-idea chat session, in sequence. Use `limit` to cap the
        number of messages returned.

        </span>'
      operationId: chatHistory
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: sessionId
        in: query
        description: Chat session ID.
        required: true
        example: 7f3c1a2e-...
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of messages to return.
        required: false
        example: 50
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      chatHistory:
                        type: array
                        items:
                          $ref: '#/components/schemas/ChatMessage'
                    x-apidog-orders:
                    - chatHistory
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055578-run
  /social-post-ideas/chat-sessions:
    get:
      summary: Chat sessions
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the AI post-idea chat sessions for a brand (social profile), most recent first. Use `limit`
        to cap the number of sessions returned.

        </span>'
      operationId: chatSessions
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of sessions to return.
        required: false
        example: 20
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      chatSessions:
                        type: array
                        items:
                          $ref: '#/components/schemas/ChatSession'
                    x-apidog-orders:
                    - chatSessions
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055580-run
  /locations/photos/requests/{requestId}:
    get:
      summary: Check Bulk Photo Upload Status
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API monitors the progress of uploading multiple\
        \ photos to a location, which is particularly useful when the upload involves more than 30 photos.\n\
        \    \nRetrieve the current status of a bulk image upload request for a location. Use the requestId\
        \ returned in the Upload Photos API to fetch the status.\n    \nFor more details, refer to [Manage\
        \ photos for your location](https://developer.synup.com/doc-833258.md). \n</span>"
      operationId: checkBulkPhotoUploadStatus
      tags:
      - Locations
      - Locations
      - Photos
      parameters:
      - name: requestId
        in: path
        description: Request ID returned from bulk upload photos API
        required: true
        example: ''
        schema:
          type: string
          format: uuid
          examples:
          - d5673c0a-f9ca-4588-84fa-528ff7feac56
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved upload status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      getLocationPhotosUploadStatus:
                        type: object
                        properties:
                          status:
                            type: string
                            description: 'Current status of the upload process:

                              * PROCESSING - Image Upload in progress. Check again later.

                              * SUCCESS - Image Upload successfully completed.

                              * ERROR - Image upload process failed.

                              '
                            enum:
                            - PROCESSING
                            - SUCCESS
                            - ERROR
                            examples:
                            - PROCESSING
                            - SUCCESS
                            - ERROR
                            x-apidog-enum:
                            - value: PROCESSING
                              name: ''
                              description: ''
                            - value: SUCCESS
                              name: ''
                              description: ''
                            - value: ERROR
                              name: ''
                              description: ''
                          requestId:
                            type: string
                            description: The ID of the bulk upload request
                            format: uuid
                            examples:
                            - e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a
                        x-apidog-orders:
                        - status
                        - requestId
                    x-apidog-orders:
                    - getLocationPhotosUploadStatus
                x-apidog-orders:
                - data
              example:
                data:
                  getLocationPhotosUploadStatus:
                    requestId: e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a
                    status: SUCCESS
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642386-run
  /social-post-ideas/close-chat-session:
    post:
      summary: Close chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Closes an active AI post-idea chat session. Once closed, the session is no longer returned as
        the active session for the brand.

        </span>'
      operationId: closeChatSession
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloseChatSessionRequest'
            example:
              sessionId: 7f3c1a2e-...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      closeChatSession:
                        $ref: '#/components/schemas/MutationResponse'
                    x-apidog-orders:
                    - closeChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055581-run
  /local-post-ideas/close-chat-session:
    post:
      summary: Close local chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Closes an active AI post-idea chat session. Once closed, the session is no longer returned as
        the active session for the location.

        </span>'
      operationId: closeLocalChatSession
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloseLocalChatSessionRequest'
            example:
              sessionId: 7f3c1a2e-...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      closeLocalChatSession:
                        $ref: '#/components/schemas/LocalMutationResponse'
                    x-apidog-orders:
                    - closeLocalChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052180-run
  /connected-accounts/confirm-matches:
    post:
      summary: Confirm Connected Account Matches
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API confirms suggested matches between locations in your account and profiles from Google
        My Business or Facebook Pages that were previously recommended.


        **Behavior:**

        - Requires base64-encoded match record IDs in a specific format, depending on the account type.

        - Once confirmed, the system links the location with the external listing for ongoing management.

        </span>'
      tags:
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmMatchesRequest'
            example:
              input:
                matchRecordIds:
                - R21iTG9jYXRpb25NYXRjaGVkRGF0YTplNGZhNTFkYi04NWEwLTRjYzItYjdmMS01OWNhMzQ1NjlhZWM=
                - R21iTG9jYXRpb25NYXRjaGVkRGF0YSI6MWFjMDdiN2ItMjUyYi00NTdkLTlhM2ItMTk4NzEzYzNkZjQz
      responses:
        '200':
          description: Match confirmation process completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmMatchesResponse'
              examples:
                '1':
                  summary: All matches confirmed successfully
                  value:
                    data:
                      confirmConnectMatches:
                        success: true
                '2':
                  summary: Some matches failed to confirm
                  value:
                    data:
                      confirmConnectMatches:
                        success: false
                        failedIds:
                        - e4fa51db-85a0-4cc2-b7f1-59ca34569aec
          headers: {}
          x-apidog-name: OK
        '400':
          description: Invalid request - Malformed base64 strings or invalid format
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13680753-run
  /connected-accounts/connect-listing:
    post:
      summary: Connect a location with a listing of a connected account
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API links a location in your account with\
        \ a listing from a connected Google My Business or Facebook Page account.\n\n**Required Fields:**\n\
        - locationId – Base64-encoded unique identifier of the location.\n- connectedAccountListingId\
        \ – The ID of the listing, retrieved from the Fetch Listings API.\n- connectedAccountId – The\
        \ ID of the connected account managing the listing.\n    \n**Behavior:**\n- Establishes a direct\
        \ connection between the location and the listing.\n- Enables the system to sync and manage the\
        \ listing’s data.\n</span>"
      tags:
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectListingRequest'
            example:
              input:
                locationId: TG9jYXRpb246NzM5MzM=
                connectedAccountId: 3db66afa-151d-4212-a8b7-949f9fe9aaf9
                connectedAccountListingId: R21iQnVsa0RhdGFMYWtlOmMyMWRiOWY5LTZmYTctNDE0My1hNDU2LTQzMjZkMmZiN2UwZg==
      responses:
        '200':
          description: Connection process completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectListingResponse'
              examples:
                '1':
                  summary: Successful connection
                  value:
                    data:
                      connectListing:
                        message: null
                        success: true
                '2':
                  summary: Failed connection - Internal System Error
                  value:
                    data:
                      connectListing:
                        message: Internal System Error
                        success: false
                '3':
                  summary: Failed Connection
                  value:
                    data:
                      confirmConnectMatches:
                        failedIds:
                        - 76151840-2c2e-46f7-8ea1-408ee19d37a2
                        success: false
          headers: {}
          x-apidog-name: OK
        '400':
          description: Invalid request - Malformed base64 string or invalid IDs
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Not Found - Location or listing not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13680763-run
  /connected-accounts/connect-facebook:
    post:
      summary: Connect Facebook Page to Account
      deprecated: false
      description: "\n<span style=\"font-size: 14px;\">\n\nThis API initiates the process of connecting\
        \ a new Facebook Page account to the system. The response provides a URL for the user to complete\
        \ Facebook’s OAuth authentication flow.\n\n**Important Notes:**\n- The response includes a URL\
        \ that the user must visit to authenticate and connect their Facebook Page account.\n- The provided\
        \ URL is valid for 24 hours.\n- When the user accesses the URL, they are redirected to Facebook’s\
        \ OAuth authentication flow.\n- During OAuth, the user must:\n    - Review and accept Facebook’s\
        \ terms and conditions.\n    - Grant necessary permissions for integration.\n- After OAuth authentication:\n\
        \    - If successful, the user is redirected to the successUrl specified in the request.\n   \
        \ - If permissions are declined or the process fails, the user is redirected to the errorUrl.\n\
        </span>"
      operationId: connectFacebookAccount
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - errorUrl
                  - successUrl
                  properties:
                    errorUrl:
                      type: string
                      description: Redirect URL in case of Error
                      examples:
                      - http://www.errorurl.com
                    successUrl:
                      type: string
                      description: Redirect URL in case of Success
                      examples:
                      - http://www.successurl.com
                  x-apidog-orders:
                  - errorUrl
                  - successUrl
              x-apidog-orders:
              - input
            example:
              input:
                errorUrl: http://www.errorurl.com
                successUrl: http://www.successurl.com
      responses:
        '200':
          description: Successfully generated connection URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      bulkConnectLinkForFacebook:
                        type: object
                        properties:
                          errors:
                            type: array
                            items:
                              type: string
                            description: Array of error messages if any
                            nullable: true
                          success:
                            type: boolean
                            description: True if the request was successful, otherwise False
                          url:
                            type: string
                            description: The URL which needs to be visited to initiate the connect process
                            examples:
                            - http://synup.com/locations/redirect_oauth_bulk/facebook?token=9009dc92-2b18-421f-b856-d157f3f06d6b
                        x-apidog-orders:
                        - errors
                        - success
                        - url
                    x-apidog-orders:
                    - bulkConnectLinkForFacebook
                x-apidog-orders:
                - data
              example:
                data:
                  bulkConnectLinkForFacebook:
                    errors: null
                    success: true
                    url: https://claim.verifymybiz.com/locations/redirect_oauth_bulk/facebook?onboarding=false&platform=local&token=bfac8e06-8d72-4810-9c50-ae7ee12a7b52
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13675265-run
  /connected-accounts/connect-google:
    post:
      summary: Connect Google Profile to Account
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API initiates the process of connecting\
        \ a new Google My Business (GMB) account to the system. The response provides a URL for the user\
        \ to complete Google's OAuth authentication flow.\n\n**Important Notes:**\n- The response includes\
        \ a URL that the user must visit to authenticate and connect their GMB account.\n- The provided\
        \ URL is valid for 24 hours.\n- When the user accesses the URL, they are redirected to Google’s\
        \ OAuth authentication flow.\n- During OAuth, the user must:\n    - Review and accept Google’s\
        \ terms and conditions.\n    - Grant necessary permissions for integration.\n- After OAuth authentication:\n\
        \    - If successful, the user is redirected to the successUrl provided in the request.\n    -\
        \ If permissions are declined or the process fails, the user is redirected to the errorUrl.\n\
        </span>"
      operationId: connectGoogleAccount
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - errorUrl
                  - successUrl
                  properties:
                    errorUrl:
                      type: string
                      description: Redirect URL in case of Error
                      examples:
                      - http://www.errorurl.com
                    successUrl:
                      type: string
                      description: Redirect URL in case of Success
                      examples:
                      - http://www.successurl.com
                  x-apidog-orders:
                  - errorUrl
                  - successUrl
              x-apidog-orders:
              - input
            example:
              input:
                errorUrl: http://www.errorurl.com
                successUrl: http://www.successurl.com
      responses:
        '200':
          description: Successfully generated connection URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      bulkConnectLinkForGoogle:
                        type: object
                        properties:
                          errors:
                            type: array
                            items:
                              type: string
                            description: Array of error messages if any
                            nullable: true
                          success:
                            type: boolean
                            description: True if the request was successful, otherwise False
                          url:
                            type: string
                            description: The URL which needs to be visited to initiate the connect process
                            examples:
                            - http://synup.com/locations/redirect_oauth_bulk/google?token=9009dc92-2b18-421f-b856-d157f3f06d6b
                        x-apidog-orders:
                        - success
                        - url
                        - errors
                    x-apidog-orders:
                    - bulkConnectLinkForGoogle
                x-apidog-orders:
                - data
              example:
                data:
                  bulkConnectLinkForGoogle:
                    clientMutationId: null
                    errors: null
                    success: true
                    url: https://claim.verifymybiz.com/locations/redirect_oauth_bulk/google_oauth2?onboarding=false&platform=local&token=47cc832a-31ce-4de5-8768-c541a8331800
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13675039-run
  /connected-accounts/connect-apple:
    post:
      summary: Connect link for Apple
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates an Apple Business Connect OAuth link for a **single location**. Redirect the user to
        the returned `url` to authorize the connection; on completion Apple redirects back to your `successUrl`
        (or `errorUrl` on failure). The link is valid for 1 day.


        **Apple OAuth link variants:**

        - **Connect link for Apple** — connects a single location (this endpoint; takes a `locationId`).

        - **Bulk connect link for Apple** — connects multiple locations in one flow (account/platform-scoped;
        no `locationId`).

        - **Renew connect link for Apple** — re-authorizes an expired or revoked token for an existing
        connection.

        </span>'
      operationId: connectLinkForApple
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppleOauthRequest'
            example:
              input:
                locationId: TG9jYXRpb246MQ==
                successUrl: https://app.synup.com/apple/success
                errorUrl: https://app.synup.com/apple/error
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      connectLinkForApple:
                        $ref: '#/components/schemas/AppleOauthPayload'
                    x-apidog-orders:
                    - connectLinkForApple
                    x--orders:
                    - connectLinkForApple
                    x--ignore-properties: []
                x-apidog-orders:
                - data
                x--orders:
                - data
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051582-run
  /social-post-ideas/content-series-detail:
    get:
      summary: Content series detail
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns a single content series by ID, including its posts, theme, status, and post counts.

        </span>'
      operationId: contentSeriesDetail
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: seriesId
        in: query
        description: ID of the content series.
        required: true
        example: 3a1f...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      contentSeriesDetail:
                        $ref: '#/components/schemas/ContentSeries'
                    x-apidog-orders:
                    - contentSeriesDetail
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055584-run
  /social-post-ideas/content-series-list:
    get:
      summary: Content series list
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the content series for a brand (social profile) — multi-post campaigns with a shared theme,
        including post counts and status.

        </span>'
      operationId: contentSeriesList
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      contentSeriesList:
                        type: array
                        items:
                          $ref: '#/components/schemas/ContentSeries'
                    x-apidog-orders:
                    - contentSeriesList
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055587-run
  /social/brands:
    post:
      summary: Create a brand
      deprecated: false
      description: ''
      tags:
      - Social
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    name:
                      type: string
                    businessIntent:
                      type: string
                    categories:
                      type: array
                      items:
                        type: string
                    website:
                      type: string
                    phone:
                      type: string
                    description:
                      type: string
                  required:
                  - name
                  - businessIntent
                  - categories
                  - website
                  - phone
                  - description
              required:
              - input
            example:
              input:
                name: Acme Coffee Co.
                businessIntent: LOCAL_BUSINESS
                categories:
                - FOOD_AND_BEVERAGE
                - CAFE
                website: https://acmecoffee.com
                phone: +1-555-000-1234
                description: Specialty coffee roasters since 2010
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Social
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169855-run
  /bulk-posts:
    post:
      summary: Create a bulk post
      deprecated: false
      description: ''
      tags:
      - Posts
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    postName:
                      type: string
                    locationIds:
                      type: array
                      items:
                        type: string
                    postType:
                      type: string
                    postSites:
                      type: array
                      items:
                        type: string
                    postMessage:
                      type: array
                      items:
                        type: object
                        properties:
                          site:
                            type: string
                          message:
                            type: string
                  required:
                  - postName
                  - locationIds
                  - postType
                  - postSites
                  - postMessage
              required:
              - input
            example:
              input:
                postName: Bulk Announcement
                locationIds:
                - '{locationId1}'
                - '{locationId2}'
                postType: ANNOUNCEMENT
                postSites:
                - GOOGLE
                postMessage:
                - site: GOOGLE
                  message: Message for all locations
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Posts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169612-run
  /menus:
    post:
      summary: Create a menu
      deprecated: false
      description: ''
      tags:
      - Menus
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    displayName:
                      type: string
                    currencyCode:
                      type: string
                    description:
                      type: string
                    locationId:
                      type: string
                    offeringsSection:
                      type: object
                      properties:
                        displayName:
                          type: string
                        description:
                          type: string
                        offeringsItem:
                          type: object
                          properties:
                            displayName:
                              type: string
                            description:
                              type: string
                            price:
                              type: string
                          required:
                          - displayName
                          - description
                          - price
                      required:
                      - displayName
                      - description
                      - offeringsItem
                  required:
                  - displayName
                  - currencyCode
                  - description
                  - locationId
                  - offeringsSection
              required:
              - input
            example:
              input:
                displayName: Dinner Menu
                currencyCode: us_usd
                description: Our full dinner menu
                locationId: '{locationId}'
                offeringsSection:
                  displayName: Starters
                  description: Appetizers and small plates
                  offeringsItem:
                    displayName: Bruschetta
                    description: Grilled bread with tomato
                    price: '8.00'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Menus
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169800-run
  /locations:
    post:
      summary: Create a new business location
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nA **Location** represents a physical business entity\
        \ within your account and serves as the foundation for managing and interacting with the API’s\
        \ features. Each Location acts as a centralized hub for managing and accessing data related to\
        \ that specific business, including:\n    \n- **Listings Management**: Maintain accurate and consistent\
        \ business details across multiple publishers.\n- **Review Monitoring**: Track and respond to\
        \ customer feedback associated with the location.\n- **Performance Insights**: Analyze key metrics\
        \ related to visibility, engagement, and growth.\n- **SEO Optimization**: Enhance local search\
        \ presence and improve rankings.\n\n<br>\n    \n\n**_See the Request Section for a detailed data\
        \ schema of Supported Fields. Here’s a key detail to keep in mind:_**\n</span>\n\n\n:::info []\n\
        <span style=\"font-size: 14px;\">\n**Processing Time for Location Updates**\nUpdates to any location\
        \ attributes, including `enabledSiteIds` or `submissionDisabledSiteIds`, are processed asynchronously\
        \ before they are accurately reflected across all publishers and within the system.\n\n<span style=\"\
        font-size: 14px;\"> For example, If the business hours for a location are updated in the system,\
        \ the changes are processed asynchronously before being reflected across all publishers. </span>\n\
        \    \n</span>\n:::\n"
      operationId: createLocation
      tags:
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: 'API key for authentication '
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the business
                    storeId:
                      type: string
                      description: Unique store identifier. Must be unique across all locations.
                      nullable: true
                    street:
                      type: string
                      description: Street address of the business
                    street1:
                      type: string
                      description: Additional street address information
                    city:
                      type: string
                      description: City where the business is located
                    postalCode:
                      type: string
                      description: Postal code of the business location
                    phone:
                      type: string
                      title: ''
                      description: "- Must follow the international **E.164 format**. [Ref here.](https://www.twilio.com/docs/glossary/what-e164)\n\
                        - Do not include the `+` sign or country code.\n- Remove parentheses and special\
                        \ characters.\n- Example:\n  - **Incorrect**: `(123)-456-7890`, `+1-123-456-7890`\n\
                        \  - **Correct**: `1234567890`"
                      examples:
                      - '1234567890'
                    stateIso:
                      type: string
                      description: State ISO code. Refer to the Places API for valid ISOs.
                    countryIso:
                      type: string
                      description: Country ISO code. Refer to the Places API for valid ISOs.
                    ownerEmail:
                      type: string
                      description: Email of the business owner
                    ownerName:
                      type: string
                      description: Name of the business owner
                    subCategoryId:
                      type: integer
                      description: 'ID of the subcategory the business belongs to '
                    description:
                      type: string
                      description: Detailed description of the business
                    bizUrl:
                      type: string
                      description: URL of the business website
                    facebookUrl:
                      type: string
                      description: URL of the business's Facebook page
                    twitterUrl:
                      type: string
                      description: URL of the business's Twitter page
                    linkedinUrl:
                      type: string
                      description: URL of the business's LinkedIn page
                    instagramUrl:
                      type: string
                      description: URL of the business's Instagram page
                    youtubeUrl:
                      type: string
                      description: URL of the business's YouTube page
                    tiktokUrl:
                      type: string
                      description: URL of the business's TikTok page
                    pinterestUrl:
                      type: string
                      description: URL of the business's Pinterest page
                    tagline:
                      type: string
                      description: Tagline of the business
                    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" )
                    yearOfIncorporation:
                      type: integer
                      description: Year the business was established
                    hideAddress:
                      type: boolean
                      description: Set to true if location is a Service Area Business
                    businessHours:
                      type: array
                      description: Business hours for each day of the week
                      items:
                        type: object
                        properties:
                          day:
                            type: string
                            description: Day of the week
                            enum:
                            - MONDAY
                            - TUESDAY
                            - WEDNESDAY
                            - THURSDAY
                            - FRIDAY
                            - SATURDAY
                            - SUNDAY
                            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: ''
                          slots:
                            type: array
                            items:
                              type: object
                              properties:
                                start:
                                  type: string
                                  description: 'Opening time. Valid formats: `<HH>:<MM>am` OR `<HH>:<MM>pm` '
                                end:
                                  type: string
                                  description: 'Closing time. Valid formats: `<HH>:<MM>am` OR `<HH>:<MM>pm` '
                              x-apidog-orders:
                              - start
                              - end
                              title: ''
                              x--orders:
                              - start
                              - end
                              x--ignore-properties: []
                            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: ''
                        x-apidog-orders:
                        - day
                        - slots
                        - type
                        required:
                        - day
                        - slots
                        - type
                        x--orders:
                        - day
                        - slots
                        - type
                        x--ignore-properties: []
                    additionalCategoryIds:
                      type: array
                      description: Additional category IDs for the business
                      items:
                        type: integer
                    videos:
                      type: array
                      description: List of valid video URLs
                      items:
                        type: string
                    tenure:
                      type: string
                      description: 'Required when an account has multiple subscriptions. Specifies the
                        tenure (e.g., Monthly).


                        For accounts with multiple subscriptions, specify the tenure of the corresponding
                        subscription. Refer to [Subscriptions](https://developer.synup.com/list-active-subscriptions-api-13639877.md)
                        for details.'
                      writeOnly: true
                      examples:
                      - Monthly
                      - Yearly
                    enabledSiteIds:
                      type: array
                      description: List of site IDs where the business details should be published
                      items:
                        type: integer
                    submissionDisabledSiteIds:
                      type: array
                      description: List of site IDs where the business details should not be published
                      items:
                        type: integer
                    temporarilyClosed:
                      type: boolean
                      description: Set to true if the location's business hours should be marked as closed
                    additionalPhones:
                      type: array
                      description: Additional contact phone numbers
                      items:
                        type: string
                    googleAdsPhone:
                      type: string
                      description: Google Ads-specific phone number
                    bookingUrl:
                      type: string
                      description: URL for booking appointments. Applicable only for Food industry businesses
                      nullable: true
                    offeringsUrl:
                      type: string
                      description: URL for listing business offerings. Applicable only for food industry
                        businesses
                      nullable: true
                    reservationUrl:
                      type: string
                      description: URL for making reservations. Applicable only for restaurant only businesses.
                      nullable: true
                    placeActionLinks:
                      type: array
                      items:
                        type: object
                        properties:
                          placeActionType:
                            type: string
                            description: One of the valid types.
                            enum:
                            - APPOINTMENT
                            - ONLINE_APPOINTMENT
                            - DINING_RESERVATION
                            - FOOD_ORDERING
                            - FOOD_DELIVERY
                            - FOOD_TAKEOUT
                            - SHOP_ONLINE
                            x-apidog-enum:
                            - value: APPOINTMENT
                              name: ''
                              description: ''
                            - value: ONLINE_APPOINTMENT
                              name: ''
                              description: ''
                            - value: DINING_RESERVATION
                              name: ''
                              description: ''
                            - value: FOOD_ORDERING
                              name: ''
                              description: ''
                            - value: FOOD_DELIVERY
                              name: ''
                              description: ''
                            - value: FOOD_TAKEOUT
                              name: ''
                              description: ''
                            - value: SHOP_ONLINE
                              name: ''
                              description: ''
                          uri:
                            type: string
                            description: Destination URL.
                          isPreferred:
                            type: boolean
                            description: Marks this link preferred for its type. At most one preferred
                              per type.
                        x-apidog-orders:
                        - placeActionType
                        - isPreferred
                        - uri
                        required:
                        - placeActionType
                        - uri
                        x--orders:
                        - placeActionType
                        - uri
                        - isPreferred
                        x--ignore-properties: []
                      description: 'Manage a location''s Place Action Links '
                  x-apidog-orders:
                  - tenure
                  - storeId
                  - subCategoryId
                  - name
                  - street
                  - street1
                  - city
                  - postalCode
                  - phone
                  - stateIso
                  - countryIso
                  - description
                  - ownerEmail
                  - ownerName
                  - bizUrl
                  - facebookUrl
                  - twitterUrl
                  - linkedinUrl
                  - instagramUrl
                  - youtubeUrl
                  - tiktokUrl
                  - pinterestUrl
                  - tagline
                  - paymentMethods
                  - yearOfIncorporation
                  - hideAddress
                  - businessHours
                  - additionalCategoryIds
                  - videos
                  - enabledSiteIds
                  - submissionDisabledSiteIds
                  - temporarilyClosed
                  - additionalPhones
                  - googleAdsPhone
                  - bookingUrl
                  - offeringsUrl
                  - reservationUrl
                  - placeActionLinks
                  required:
                  - name
                  - street
                  - city
                  - postalCode
                  - phone
                  - stateIso
                  - countryIso
                  - subCategoryId
                  - description
                  x--orders:
                  - name
                  - storeId
                  - street
                  - street1
                  - city
                  - postalCode
                  - phone
                  - stateIso
                  - countryIso
                  - ownerEmail
                  - ownerName
                  - subCategoryId
                  - description
                  - bizUrl
                  - facebookUrl
                  - twitterUrl
                  - linkedinUrl
                  - instagramUrl
                  - youtubeUrl
                  - tiktokUrl
                  - pinterestUrl
                  - tagline
                  - paymentMethods
                  - yearOfIncorporation
                  - hideAddress
                  - businessHours
                  - additionalCategoryIds
                  - videos
                  - tenure
                  - enabledSiteIds
                  - submissionDisabledSiteIds
                  - temporarilyClosed
                  - additionalPhones
                  - googleAdsPhone
                  - bookingUrl
                  - offeringsUrl
                  - reservationUrl
                  - placeActionLinks
                  x--ignore-properties: []
              x-apidog-orders:
              - input
              x--orders:
              - input
              x--ignore-properties: []
            example:
              input:
                tenure: Monthly
                name: Whisk & Bloom Bakery
                street: 123 Maple Avenue
                street1: Suite 202
                city: San Francisco
                postalCode: '94107'
                phone: (415) 555-1239
                stateIso: CA
                countryIso: US
                ownerEmail: lana@whiskbloom.com
                ownerName: Lana Thompson
                subCategoryId: 10
                description: Whisk & Bloom Bakery offers a delightful selection of organic and gluten-free
                  baked goods. Our mission is to provide fresh, handmade pastries and cakes crafted with
                  love and the finest ingredients. Visit us for a cozy experience and enjoy our special
                  seasonal treats!
                bizUrl: https://www.whisknbloombakery.com/
                facebookUrl: https://www.facebook.com/whisknbloomBakery/
                linkedinUrl: https://www.linkedin.com/company/whisknbloombakery
                twitterUrl: https://twitter.com/whisknbloomBakery
                instagramUrl: https://www.instagram.com/whisknbloombakery/
                youtubeUrl: null
                tiktokUrl: null
                pinterestUrl: https://www.pinterest.com/whisknbloombakery/
                tagline: Fresh. Organic. Delicious.
                paymentMethods:
                - VISA
                - CASH
                yearOfIncorporation: 2015
                hideAddress: false
                businessHours:
                - day: MONDAY
                  slots:
                  - start: 08:00am
                    end: 12:00pm
                  - start: 01:00pm
                    end: 06:00pm
                  type: OPEN
                - day: TUESDAY
                  slots:
                  - start: 08:00am
                    end: 06:00pm
                  type: OPEN
                - day: WEDNESDAY
                  slots:
                  - start: 08:00am
                    end: 06:00pm
                  type: OPEN
                - day: THURSDAY
                  slots:
                  - start: 08:00am
                    end: 06:00pm
                  type: OPEN
                - day: FRIDAY
                  slots:
                  - start: 08:00am
                    end: 06:00pm
                  type: OPEN
                - day: SATURDAY
                  slots:
                  - start: 08:00am
                    end: 04:00pm
                  type: OPEN
                - day: SUNDAY
                  slots: []
                  type: CLOSED
                additionalCategoryIds: []
                videos: []
                enabledSiteIds: []
                submissionDisabledSiteIds: []
                temporarilyClosed: false
                additionalPhones:
                - (415) 555-5678
                - (415) 555-9012
                googleAdsPhone: (415) 555-3456
                bookingUrl: https://www.whisknbloombakery.com/reservations
                offeringsUrl: https://www.whisknbloombakery.com/menu
                reservationUrl: https://www.whisknbloombakery.com/book
                storeId: null
                placeActionLinks:
                - placeActionType: FOOD_ORDERING
                  uri: https://order.example.com
                  isPreferred: true
                - placeActionType: FOOD_DELIVERY
                  uri: https://deliver.example.com
      responses:
        '200':
          description: Location created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: Contains the response data for the create location request.
                    properties:
                      createLocation:
                        type: object
                        description: Encapsulates details about the created location.
                        properties:
                          errors:
                            type: 'null'
                            description: Errors encountered during the location creation process, if any.
                              Null if no errors.
                          location:
                            description: Details of the created location.
                            type: object
                            x-apidog-refs:
                              01JW6KY3NPVTMY6C967CGDPRQ7:
                                $ref: '#/components/schemas/LocationResponseSchema'
                                x-apidog-overrides:
                                  errors: null
                            x-apidog-orders:
                            - 01JW6KY3NPVTMY6C967CGDPRQ7
                            properties: {}
                            x--orders: []
                            x--ignore-properties: []
                          success:
                            type: boolean
                            description: Indicates whether the location creation was successful.
                          warnings:
                            type: array
                            description: List of warnings generated during the request processing, if
                              any.
                            items:
                              type: string
                        x-apidog-orders:
                        - errors
                        - location
                        - success
                        - warnings
                        x--orders:
                        - errors
                        - location
                        - success
                        - warnings
                        x--ignore-properties: []
                    x-apidog-orders:
                    - createLocation
                    x--orders:
                    - createLocation
                    x--ignore-properties: []
                  message:
                    type: string
                    description: Response message indicating the result of the operation.
                    examples:
                    - Location created successfully
                x-apidog-orders:
                - data
                - message
                x--orders:
                - data
                - message
                x--ignore-properties: []
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      createLocation:
                        clientMutationId: null
                        errors: null
                        location:
                          accountId: 16154
                          additionalCategoryIds: []
                          additionalInfo: null
                          additionalPhones:
                          - '4155555678'
                          - '4155559012'
                          archived: false
                          archivedAt: null
                          billingPeriod: null
                          bizUrl: https://www.greenleafbakery.com/
                          bookingUrl: https://www.greenleafbakery.com/reservations
                          businessHours:
                          - day: SUNDAY
                            slots: null
                            specialDate: null
                            type: CLOSED
                          - day: MONDAY
                            slots:
                            - end: 12:00pm
                              start: 08:00am
                            - end: 06:00pm
                              start: 01:00pm
                            specialDate: null
                            type: OPEN
                          - day: TUESDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: WEDNESDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: THURSDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: FRIDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: SATURDAY
                            slots:
                            - end: 04:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          categoryId: 15
                          city: San Francisco
                          countryIso: US
                          customAttributes:
                          - archived: false
                            enumValues: []
                            name: bollean01
                            slug: bollean01
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: KAM
                            slug: kam
                            type: STRING
                            value:
                            - ''
                          - archived: false
                            enumValues: []
                            name: P_Test01
                            slug: p_test01
                            type: STRING
                            value:
                            - one12
                          - archived: false
                            enumValues: []
                            name: ABC
                            slug: abc
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: NJL
                            slug: njl
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: ZZZ
                            slug: zzz
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: ALL
                            slug: all
                            type: STRING
                            value:
                            - ss
                          - archived: false
                            enumValues:
                            - gulab jamun
                            - rasgulla
                            - ras malai
                            - jalebi
                            name: Dessets
                            slug: dessets
                            type: ENUM
                            value:
                            - gulab jamun
                          - archived: false
                            enumValues: []
                            name: Attrs
                            slug: attrs
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Attrs2
                            slug: attrs2
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Toll-free Number
                            slug: toll-free_number
                            type: INTEGER
                            value:
                            - '80044637'
                          - archived: false
                            enumValues: []
                            name: amenities
                            slug: amenities
                            type: ARRAY
                            value:
                            - wifi
                            - wheelchair
                            - welcoming ceremony
                          - archived: false
                            enumValues: []
                            name: amenities02
                            slug: amenities02
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: Amenities-check
                            slug: amenities-check
                            type: BOOLEAN
                            value:
                            - 'false'
                          - archived: false
                            enumValues:
                            - Atr1
                            - atr2
                            - atr3
                            name: Prod_Attribute
                            slug: prod_attribute
                            type: ENUM
                            value:
                            - Atr1
                          - archived: false
                            enumValues: []
                            name: wifi available
                            slug: wifi_available
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: QQQQQQQ
                            slug: qqqqqqq
                            type: INTEGER
                            value:
                            - '123'
                          - archived: false
                            enumValues: []
                            name: int02
                            slug: int02
                            type: INTEGER
                            value: []
                          - archived: false
                            enumValues: []
                            name: Tasty
                            slug: tasty
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: dhdop
                            slug: dhdop
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Abstract
                            slug: abstract
                            type: ARRAY
                            value:
                            - abs1
                            - abs2
                            - abs3
                          - archived: false
                            enumValues: []
                            name: Senior Hours Required?
                            slug: senior_hours_required?
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: kafka_check_attribute
                            slug: kafka_check_attribute
                            type: ARRAY
                            value:
                            - one
                            - two
                            - three
                          - archived: false
                            enumValues: []
                            name: Parking
                            slug: parking
                            type: BOOLEAN
                            value:
                            - 'false'
                          - archived: false
                            enumValues: []
                            name: googlePlaceId
                            slug: googleplaceid
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: hoursComments
                            slug: hourscomments
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: isOpen
                            slug: isopen
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues: []
                            name: has_bicycle_rack?
                            slug: has_bicycle_rack?
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues:
                            - one
                            - two
                            name: quick
                            slug: quick
                            type: ENUM
                            value:
                            - one
                          - archived: false
                            enumValues: []
                            name: instagramUrl
                            slug: instagramurl
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: analyticsTrackingFireEvent
                            slug: analyticstrackingfireevent
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: placeholderText
                            slug: placeholdertext
                            type: STRING
                            value: []
                          - archived: false
                            enumValues:
                            - FRND
                            - MENMENMEN
                            - BARNEY
                            name: TV
                            slug: tv
                            type: ENUM
                            value:
                            - FRND
                          - archived: false
                            enumValues: []
                            name: notificationEmails
                            slug: notificationemails
                            type: ARRAY
                            value: []
                          - archived: false
                            enumValues: []
                            name: joinUrl
                            slug: joinurl
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: account_att
                            slug: account_att
                            type: ARRAY
                            value:
                            - '1'
                            - '2'
                            - '4'
                            - '3'
                          - archived: false
                            enumValues: []
                            name: Post v2
                            slug: post_v2
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: testingthetest
                            slug: testingthetest
                            type: INTEGER
                            value:
                            - '0'
                          - archived: false
                            enumValues: []
                            name: int0
                            slug: int0
                            type: INTEGER
                            value:
                            - '0'
                          - archived: false
                            enumValues: []
                            name: url_appointment
                            slug: url_appointment
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Slug
                            slug: slug
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: New Name
                            slug: new_name
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: test200
                            slug: test200
                            type: STRING
                            value:
                            - test test
                          - archived: false
                            enumValues: []
                            name: Name
                            slug: name
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: 'Test Department '
                            slug: test_department_
                            type: ARRAY
                            value: []
                          - archived: false
                            enumValues: []
                            name: 'Fresh Fish Section '
                            slug: fresh_fish_section_
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Test 28 11 22
                            slug: test_28_11_22
                            type: STRING
                            value:
                            - Test 28
                          - archived: false
                            enumValues: []
                            name: accepts reservation
                            slug: accepts_reservation
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues: []
                            name: blablacar
                            slug: blablacar
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: requires temperature check customers
                            slug: requires_temperature_check_customers
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: Custom Tee Point
                            slug: custom_tee_point
                            type: STRING
                            value:
                            - tess
                          - archived: false
                            enumValues: []
                            name: appointment_required
                            slug: appointment_required
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: requires masks customers
                            slug: requires_masks_customers
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues: []
                            name: is black owned
                            slug: is_black_owned
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues: []
                            name: BewAttribute
                            slug: bewattribute
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: 'Pets 2 '
                            slug: pets_2_
                            type: ARRAY
                            value: []
                          - archived: false
                            enumValues: []
                            name: test214122
                            slug: test214122
                            type: STRING
                            value:
                            - test2
                          - archived: false
                            enumValues: []
                            name: Test123
                            slug: test123
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: ohiiiignore
                            slug: ohiiiignore
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: yesnotest
                            slug: yesnotest
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: account_leve_test_for_ext
                            slug: account_leve_test_for_ext
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Custom location ID
                            slug: custom_location_id
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Account Attr
                            slug: account_attr
                            type: ARRAY
                            value:
                            - one
                            - two
                            - three
                          - archived: false
                            enumValues:
                            - b
                            - a
                            - c
                            name: enum01
                            slug: enum01
                            type: ENUM
                            value:
                            - a
                          - archived: false
                            enumValues: []
                            name: Paneer Speciality
                            slug: paneer_speciality
                            type: STRING
                            value:
                            - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg
                          - archived: false
                            enumValues: []
                            name: welcomes_lgbtq
                            slug: welcomes_lgbtq
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: Lgbtq+ friendly
                            slug: lgbtq+_friendly
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: analyticsTrackingScript
                            slug: analyticstrackingscript
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: url_menu
                            slug: url_menu
                            type: STRING
                            value: []
                          databaseId: 1181652
                          description: Greenleaf Bakery offers a delightful selection of organic and gluten-free
                            baked goods. Our mission is to provide fresh, handmade pastries and cakes
                            crafted with love and the finest ingredients. Visit us for a cozy experience
                            and enjoy our special seasonal treats!
                          facebookUrl: https://www.facebook.com/GreenleafBakery/
                          folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9
                          folderName: root
                          googleAdsPhone: '4155553456'
                          googleplusUrl: null
                          hideAddress: false
                          id: TG9jYXRpb246MTE4MTY1Mg==
                          instagramUrl: https://www.instagram.com/greenleafbakery/
                          isRestaurant: true
                          latitude: 37.7618242
                          linkedinUrl: https://www.linkedin.com/company/greenleafbakery
                          locationPhotos: []
                          longitude: -122.3985871
                          moreHours: []
                          name: 𝗚𝗿𝗲𝗲𝗻𝗹𝗲𝗮𝗳 𝗕𝗮𝗸𝗲𝗿𝘆 & 𝗖𝗮𝗸𝗲
                          offeringsUrl: https://www.greenleafbakery.com/menu
                          ownerEmail: info@greenleafbakery.com
                          ownerName: Emma Thompson
                          package: PREMIUM
                          paymentMethods:
                          - VISA
                          - CASH
                          phone: '4155551239'
                          pinterestUrl: https://www.pinterest.com/greenleafbakery/
                          planId: 86
                          planName: V2 Premium Slow + Fast Sites
                          postalCode: '94107'
                          publisherAttributes: []
                          reservationUrl: https://www.greenleafbakery.com/book
                          serviceItems: []
                          stateIso: CA
                          storeId: null
                          street: 123 Maple Avenue
                          street1: 'Suite #202'
                          subCategory:
                            databaseId: 1432
                            id: U3ViQ2F0ZWdvcnk6MTQzMg==
                            name: Restaurants
                            primary: true
                          subCategoryId: 1432
                          subCategoryName: Restaurants
                          tagline: Fresh. Organic. Delicious.
                          tags:
                          - all
                          temporarilyClosed: false
                          tiktokUrl: null
                          toplineMessage: null
                          toplineMessageText: null
                          twitterUrl: https://twitter.com/GreenleafBakery
                          videos: []
                          yearOfIncorporation: 2015
                          youtubeUrl: null
                          placeActionLinks:
                          - placeActionType: FOOD_ORDERING
                            uri: https://order.example.com
                            isPreferred: true
                            name: null
                            submissionStatus: null
                          - placeActionType: FOOD_DELIVERY
                            uri: https://deliver.example.com
                            isPreferred: false
                            name: null
                            submissionStatus: null
                        success: true
                        warnings: []
                '2':
                  summary: 'Validation Errors: Missing or Invalid Fields'
                  value:
                    data:
                      createLocation:
                        clientMutationId: null
                        errors:
                        - code: SY10011
                          contextInfo:
                          - key: street
                            value: ''
                          message: Street can't be blank
                        - code: SY10015
                          contextInfo:
                          - key: phone
                            value: ''
                          message: Phone Number is invalid
                        - code: SY10005
                          contextInfo:
                          - key: description
                            value: Greenleaf Bakery offers a delightful selection
                          message: Description is too short (minimum is 200 characters)
                        location: null
                        success: false
                        warnings: null
                '3':
                  summary: Missing Tenure in Multi-Subscription
                  value:
                    data:
                      createLocation:
                        clientMutationId: null
                        errors:
                        - code: SY10087
                          contextInfo:
                          - key: tenure
                            value: null
                          message: Tenure is required
                        location: null
                        success: false
                        warnings: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request, invalid input
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13603961-run
    get:
      summary: List all locations
      deprecated: false
      description: "<br>\n<span style=\"font-size: 14px;\">\n\nThis API retrieves a paginated list of\
        \ locations within the account, allowing for efficient data retrieval when managing multiple locations.\n\
        \    \n</span>"
      operationId: listLocations
      tags:
      - Locations
      parameters:
      - name: first
        in: query
        description: Number of records to fetch from the most recent ones (i.e., from the end). Defaults
          to 50 if not provided.
        required: false
        example: 2
        schema:
          type: integer
          minimum: 1
          examples:
          - 2
      - name: last
        in: query
        description: Number of records to fetch from the earliest ones (i.e., from the beginning).
        required: false
        example: 1
        schema:
          type: integer
          minimum: 1
      - name: after
        in: query
        description: Cursor to fetch records after
        required: false
        example: TG9jYXRpb246MTAw
        schema:
          type: string
      - name: before
        in: query
        description: Cursor to fetch records before
        required: false
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      allLocations:
                        type: object
                        properties:
                          edges:
                            type: array
                            items:
                              type: object
                              x-apidog-refs: {}
                              x-apidog-orders:
                              - cursor
                              - node
                              properties:
                                cursor:
                                  type: string
                                node:
                                  $ref: '#/components/schemas/LocationResponseSchema'
                              x-apidog-ignore-properties: []
                          pageInfo:
                            $ref: '#/components/schemas/PageInfo'
                        x-apidog-orders:
                        - edges
                        - pageInfo
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - allLocations
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
              example:
                data:
                  allLocations:
                    edges:
                    - cursor: TG9jYXRpb246MTE5NTI1OA==
                      node:
                        accountId: 16154
                        addOns: []
                        additionalCategoryIds:
                        - 43
                        additionalCategoryNames:
                        - Playgrounds
                        additionalInfo: null
                        additionalPhones: []
                        approved: APPROVED
                        archivalScheduledAt: null
                        archived: false
                        archivedAt: null
                        bizUrl: https://headsupcatchme.com/
                        bizUrlUtm: false
                        bookingUrl: null
                        businessHours:
                        - day: SUNDAY
                          slots: null
                          specialDate: null
                          type: CLOSED
                        - day: MONDAY
                          slots:
                          - end: 05:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: TUESDAY
                          slots:
                          - end: 09:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: WEDNESDAY
                          slots:
                          - end: 11:30am
                            start: 09:00am
                          - end: 05:00pm
                            start: 01:00pm
                          - end: 09:30pm
                            start: 06:00pm
                          specialDate: null
                          type: OPEN
                        - day: THURSDAY
                          slots: null
                          specialDate: null
                          type: OPEN_24x7
                        - day: FRIDAY
                          slots: null
                          specialDate: null
                          type: CLOSED
                        - day: SATURDAY
                          slots: null
                          specialDate: null
                          type: CLOSED
                        cancellationScheduledAt: null
                        categoryId: 59
                        city: Setauket- East Setauket
                        countryIso: US
                        createErrors:
                        - fieldName: base
                          messages:
                          - A Location with same name, phone number and zip code has already been added.
                        - fieldName: storeId
                          messages:
                          - Store has already been taken
                        createdDate: February 19, 2025
                        customAttributes:
                        - archived: false
                          enumValues: []
                          name: bollean01
                          slug: bollean01
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: KAM
                          slug: kam
                          type: STRING
                          value:
                          - ''
                        - archived: false
                          enumValues: []
                          name: P_Test01
                          slug: p_test01
                          type: STRING
                          value:
                          - one12
                        - archived: false
                          enumValues: []
                          name: ABC
                          slug: abc
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: NJL
                          slug: njl
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: ZZZ
                          slug: zzz
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ALL
                          slug: all
                          type: STRING
                          value:
                          - ss
                        - archived: false
                          enumValues:
                          - gulab jamun
                          - rasgulla
                          - ras malai
                          - jalebi
                          name: Dessets
                          slug: dessets
                          type: ENUM
                          value:
                          - gulab jamun
                        - archived: false
                          enumValues: []
                          name: Attrs
                          slug: attrs
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Attrs2
                          slug: attrs2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Toll-free Number
                          slug: toll-free_number
                          type: INTEGER
                          value:
                          - '80044637'
                        - archived: false
                          enumValues: []
                          name: amenities
                          slug: amenities
                          type: ARRAY
                          value:
                          - wifi
                          - wheelchair
                          - welcoming ceremony
                        - archived: false
                          enumValues: []
                          name: amenities02
                          slug: amenities02
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Amenities-check
                          slug: amenities-check
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: is owned by veterans
                          slug: is_owned_by_veterans
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues:
                          - Atr1
                          - atr2
                          - atr3
                          name: Prod_Attribute
                          slug: prod_attribute
                          type: ENUM
                          value:
                          - Atr1
                        - archived: false
                          enumValues: []
                          name: wifi available
                          slug: wifi_available
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: QQQQQQQ
                          slug: qqqqqqq
                          type: INTEGER
                          value:
                          - '123'
                        - archived: false
                          enumValues: []
                          name: int02
                          slug: int02
                          type: INTEGER
                          value: []
                        - archived: false
                          enumValues: []
                          name: Tasty
                          slug: tasty
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: dhdop
                          slug: dhdop
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Abstract
                          slug: abstract
                          type: ARRAY
                          value:
                          - abs1
                          - abs2
                          - abs3
                        - archived: false
                          enumValues: []
                          name: Senior Hours Required?
                          slug: senior_hours_required?
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: kafka_check_attribute
                          slug: kafka_check_attribute
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues: []
                          name: Parking
                          slug: parking
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: googlePlaceId
                          slug: googleplaceid
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: hoursComments
                          slug: hourscomments
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: isOpen
                          slug: isopen
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: has_bicycle_rack?
                          slug: has_bicycle_rack?
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues:
                          - one
                          - two
                          name: quick
                          slug: quick
                          type: ENUM
                          value:
                          - one
                        - archived: false
                          enumValues: []
                          name: instagramUrl
                          slug: instagramurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingFireEvent
                          slug: analyticstrackingfireevent
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: placeholderText
                          slug: placeholdertext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues:
                          - FRND
                          - MENMENMEN
                          - BARNEY
                          name: TV
                          slug: tv
                          type: ENUM
                          value:
                          - FRND
                        - archived: false
                          enumValues: []
                          name: notificationEmails
                          slug: notificationemails
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: joinUrl
                          slug: joinurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: account_att
                          slug: account_att
                          type: ARRAY
                          value:
                          - '1'
                          - '2'
                          - '4'
                          - '3'
                        - archived: false
                          enumValues: []
                          name: Post v2
                          slug: post_v2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: testingthetest
                          slug: testingthetest
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: int0
                          slug: int0
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: url_appointment
                          slug: url_appointment
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Slug
                          slug: slug
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: New Name
                          slug: new_name
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: test200
                          slug: test200
                          type: STRING
                          value:
                          - test test
                        - archived: false
                          enumValues: []
                          name: Name
                          slug: name
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Test Department '
                          slug: test_department_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Fresh Fish Section '
                          slug: fresh_fish_section_
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Test 28 11 22
                          slug: test_28_11_22
                          type: STRING
                          value:
                          - Test 28
                        - archived: false
                          enumValues: []
                          name: blablacar
                          slug: blablacar
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: requires temperature check customers
                          slug: requires_temperature_check_customers
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Custom Tee Point
                          slug: custom_tee_point
                          type: STRING
                          value:
                          - tess
                        - archived: false
                          enumValues: []
                          name: appointment_required
                          slug: appointment_required
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: requires masks customers
                          slug: requires_masks_customers
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: is black owned
                          slug: is_black_owned
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: BewAttribute
                          slug: bewattribute
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Pets 2 '
                          slug: pets_2_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: test214122
                          slug: test214122
                          type: STRING
                          value:
                          - test2
                        - archived: false
                          enumValues: []
                          name: Test123
                          slug: test123
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ohiiiignore
                          slug: ohiiiignore
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: yesnotest
                          slug: yesnotest
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: account_leve_test_for_ext
                          slug: account_leve_test_for_ext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Custom location ID
                          slug: custom_location_id
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Account Attr
                          slug: account_attr
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues:
                          - b
                          - a
                          - c
                          name: enum01
                          slug: enum01
                          type: ENUM
                          value:
                          - a
                        - archived: false
                          enumValues: []
                          name: Paneer Speciality
                          slug: paneer_speciality
                          type: STRING
                          value:
                          - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg
                        - archived: false
                          enumValues: []
                          name: welcomes_lgbtq
                          slug: welcomes_lgbtq
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Lgbtq+ friendly
                          slug: lgbtq+_friendly
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingScript
                          slug: analyticstrackingscript
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: is owned by women
                          slug: is_owned_by_women
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: has wheelchair accessible seating
                          slug: has_wheelchair_accessible_seating
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: has restroom
                          slug: has_restroom
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: has_wheelchair_accessible_restroom
                          slug: has_wheelchair_accessible_restroom
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: has restroom unisex
                          slug: has_restroom_unisex
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: is transgender safespace
                          slug: is_transgender_safespace
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: welcomes_lgbtq
                          slug: welcomes_lgbtq
                          type: BOOLEAN
                          value:
                          - 'true'
                        databaseId: 1195258
                        description: About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business
                        enabledSiteIds: []
                        facebookUrl: null
                        folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9
                        folderName: root
                        franchise: false
                        googleAdsPhone: '6314848881'
                        googleVerificationStatus:
                          message: null
                          status: null
                        googleplusUrl: null
                        hideAddress: false
                        id: TG9jYXRpb246MTE5NTI1OA==
                        instagramUrl: null
                        isRestaurant: false
                        lastUpdatedDate: February 19, 2025
                        latitude: '40.9366839'
                        linkedinUrl: https://www.linkedin.com/in/ac-slater-hey/
                        locationPhotos:
                        - databaseId: 6020661
                          fileSize: 44693
                          id: TWVkaWFGaWxlOjYwMjA2NjE=
                          name: 43700ee9-5291-4e5e-bf8a-165f724f55b4.jpg
                          starred: false
                          thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4a64cfad-a6b3-4de9-9238-ffbd89aaa7b2.jpg
                          type: LOGO
                          url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4a64cfad-a6b3-4de9-9238-ffbd89aaa7b2.jpg
                        - databaseId: 6020659
                          fileSize: 138594
                          id: TWVkaWFGaWxlOjYwMjA2NTk=
                          name: 7ead4509-01c0-4c59-85ac-9c710fed53f2.jpg
                          starred: false
                          thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/cf49f33f-1220-429e-9f86-4f64ade0a7be.jpg
                          type: COVER
                          url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/cf49f33f-1220-429e-9f86-4f64ade0a7be.jpg
                        longitude: '-73.1081977'
                        managedServiceSiteBuckets: []
                        managedServiceSites: []
                        moreHours: []
                        name: Benjamin Auditor House
                        offeringsUrl: null
                        ownerEmail: null
                        ownerName: null
                        package: PREMIUM
                        paymentMethods: []
                        phone: '6314848880'
                        pinterestUrl: null
                        planId: 86
                        planName: V2 Premium Slow + Fast Sites
                        postalCode: '11733'
                        publisherAttributes: []
                        reservationUrl: null
                        serviceItems:
                        - categoryId: '3996'
                          currencyCode: USD
                          description: simple menu
                          id: 01c522d6-9e9b-4234-9978-61c10f35e4ef
                          languageCode: null
                          name: Buffet
                          price: 100
                        - categoryId: '3996'
                          currencyCode: null
                          description: null
                          id: 4360744c-26fa-46f8-9aea-b3a104e1f0b3
                          languageCode: null
                          name: Swing
                          price: null
                        - categoryId: '3996'
                          currencyCode: null
                          description: null
                          id: 13675b09-88a7-48c1-901f-f455e7be1994
                          languageCode: null
                          name: Drive Through
                          price: null
                        - categoryId: '3996'
                          currencyCode: null
                          description: Fine dining or whatever just have food and go home!!!
                          id: 4ccff7cd-a292-429a-a7d0-49101b91db1d
                          languageCode: null
                          name: Fine Dining
                          price: null
                        - categoryId: '3996'
                          currencyCode: USD
                          description: A happy-sounding, but soul-stirring music that will have you hum
                            it for hours after you have got off the carousel!
                          id: cf786095-edba-4ef2-820f-4fe198834742
                          languageCode: null
                          name: Merry-go-round
                          price: 10
                        stateIso: NY
                        stateName: New York
                        storeId: shop_code_benji
                        street: '1368 Route 25A, United States, 100 NY-25A, #22'
                        street1: null
                        subCategoryId: 3996
                        subCategoryName: International airport
                        tagline: null
                        tags:
                        - all
                        - label_in_google
                        temporarilyClosed: false
                        tiktokUrl: null
                        toplineMessage: null
                        toplineMessageText: null
                        twitterUrl: https://twitter.com/journeymus
                        uid: 716d9b63-0158-4463-83a2-ee1014a13cec
                        updatedAt: '2025-02-19T07:24:51.689Z'
                        videos: []
                        voiceStatus: 1
                        yearOfIncorporation: null
                        youtubeUrl: https://www.youtube.com/@JayGuldekar2.0
                    - cursor: TG9jYXRpb246MTE5NTI1Mg==
                      node:
                        accountId: 16154
                        addOns: []
                        additionalCategoryIds: []
                        additionalCategoryNames: []
                        additionalInfo: null
                        additionalPhones: []
                        approved: APPROVED
                        archivalScheduledAt: null
                        archived: false
                        archivedAt: null
                        bizUrl: http://valencarestaurantnj.com/
                        bizUrlUtm: false
                        bookingUrl: null
                        businessHours: []
                        cancellationScheduledAt: null
                        categoryId: 15
                        city: Elizabeth
                        countryIso: US
                        createErrors: []
                        createdDate: February 19, 2025
                        customAttributes:
                        - archived: false
                          enumValues: []
                          name: bollean01
                          slug: bollean01
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: KAM
                          slug: kam
                          type: STRING
                          value:
                          - ''
                        - archived: false
                          enumValues: []
                          name: P_Test01
                          slug: p_test01
                          type: STRING
                          value:
                          - one12
                        - archived: false
                          enumValues: []
                          name: ABC
                          slug: abc
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: NJL
                          slug: njl
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: ZZZ
                          slug: zzz
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ALL
                          slug: all
                          type: STRING
                          value:
                          - ss
                        - archived: false
                          enumValues:
                          - gulab jamun
                          - rasgulla
                          - ras malai
                          - jalebi
                          name: Dessets
                          slug: dessets
                          type: ENUM
                          value:
                          - gulab jamun
                        - archived: false
                          enumValues: []
                          name: Attrs
                          slug: attrs
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Attrs2
                          slug: attrs2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Toll-free Number
                          slug: toll-free_number
                          type: INTEGER
                          value:
                          - '80044637'
                        - archived: false
                          enumValues: []
                          name: amenities
                          slug: amenities
                          type: ARRAY
                          value:
                          - wifi
                          - wheelchair
                          - welcoming ceremony
                        - archived: false
                          enumValues: []
                          name: amenities02
                          slug: amenities02
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Amenities-check
                          slug: amenities-check
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues:
                          - Atr1
                          - atr2
                          - atr3
                          name: Prod_Attribute
                          slug: prod_attribute
                          type: ENUM
                          value:
                          - Atr1
                        - archived: false
                          enumValues: []
                          name: wifi available
                          slug: wifi_available
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: QQQQQQQ
                          slug: qqqqqqq
                          type: INTEGER
                          value:
                          - '123'
                        - archived: false
                          enumValues: []
                          name: int02
                          slug: int02
                          type: INTEGER
                          value: []
                        - archived: false
                          enumValues: []
                          name: Tasty
                          slug: tasty
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: dhdop
                          slug: dhdop
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Abstract
                          slug: abstract
                          type: ARRAY
                          value:
                          - abs1
                          - abs2
                          - abs3
                        - archived: false
                          enumValues: []
                          name: Senior Hours Required?
                          slug: senior_hours_required?
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: kafka_check_attribute
                          slug: kafka_check_attribute
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues: []
                          name: Parking
                          slug: parking
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: googlePlaceId
                          slug: googleplaceid
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: hoursComments
                          slug: hourscomments
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: isOpen
                          slug: isopen
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: has_bicycle_rack?
                          slug: has_bicycle_rack?
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues:
                          - one
                          - two
                          name: quick
                          slug: quick
                          type: ENUM
                          value:
                          - one
                        - archived: false
                          enumValues: []
                          name: instagramUrl
                          slug: instagramurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingFireEvent
                          slug: analyticstrackingfireevent
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: placeholderText
                          slug: placeholdertext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues:
                          - FRND
                          - MENMENMEN
                          - BARNEY
                          name: TV
                          slug: tv
                          type: ENUM
                          value:
                          - FRND
                        - archived: false
                          enumValues: []
                          name: notificationEmails
                          slug: notificationemails
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: joinUrl
                          slug: joinurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: account_att
                          slug: account_att
                          type: ARRAY
                          value:
                          - '1'
                          - '2'
                          - '4'
                          - '3'
                        - archived: false
                          enumValues: []
                          name: Post v2
                          slug: post_v2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: testingthetest
                          slug: testingthetest
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: int0
                          slug: int0
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: url_appointment
                          slug: url_appointment
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Slug
                          slug: slug
                          type: STRING
                          value:
                          - /new-york/elizabeth/665-monroe-ave
                        - archived: false
                          enumValues: []
                          name: New Name
                          slug: new_name
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: test200
                          slug: test200
                          type: STRING
                          value:
                          - test test
                        - archived: false
                          enumValues: []
                          name: Name
                          slug: name
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Test Department '
                          slug: test_department_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Fresh Fish Section '
                          slug: fresh_fish_section_
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Test 28 11 22
                          slug: test_28_11_22
                          type: STRING
                          value:
                          - Test 28
                        - archived: false
                          enumValues: []
                          name: accepts reservation
                          slug: accepts_reservation
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: blablacar
                          slug: blablacar
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: requires temperature check customers
                          slug: requires_temperature_check_customers
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Custom Tee Point
                          slug: custom_tee_point
                          type: STRING
                          value:
                          - tess
                        - archived: false
                          enumValues: []
                          name: appointment_required
                          slug: appointment_required
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: requires masks customers
                          slug: requires_masks_customers
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: is black owned
                          slug: is_black_owned
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: BewAttribute
                          slug: bewattribute
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Pets 2 '
                          slug: pets_2_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: test214122
                          slug: test214122
                          type: STRING
                          value:
                          - test2
                        - archived: false
                          enumValues: []
                          name: Test123
                          slug: test123
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ohiiiignore
                          slug: ohiiiignore
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: yesnotest
                          slug: yesnotest
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: account_leve_test_for_ext
                          slug: account_leve_test_for_ext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Custom location ID
                          slug: custom_location_id
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Account Attr
                          slug: account_attr
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues:
                          - b
                          - a
                          - c
                          name: enum01
                          slug: enum01
                          type: ENUM
                          value:
                          - a
                        - archived: false
                          enumValues: []
                          name: Paneer Speciality
                          slug: paneer_speciality
                          type: STRING
                          value:
                          - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg
                        - archived: false
                          enumValues: []
                          name: welcomes_lgbtq
                          slug: welcomes_lgbtq
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Lgbtq+ friendly
                          slug: lgbtq+_friendly
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingScript
                          slug: analyticstrackingscript
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: url_menu
                          slug: url_menu
                          type: STRING
                          value: []
                        databaseId: 1195252
                        description: ''
                        enabledSiteIds: []
                        facebookUrl: null
                        folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9
                        folderName: root
                        franchise: false
                        googleAdsPhone: null
                        googleVerificationStatus:
                          message: null
                          status: NOT_CONNECTED
                        googleplusUrl: null
                        hideAddress: false
                        id: TG9jYXRpb246MTE5NTI1Mg==
                        instagramUrl: null
                        isRestaurant: true
                        lastUpdatedDate: February 19, 2025
                        latitude: '40.6770873'
                        linkedinUrl: null
                        locationPhotos: []
                        longitude: '-74.2031927'
                        managedServiceSiteBuckets: []
                        managedServiceSites: []
                        moreHours: []
                        name: Valenca Restaurant
                        offeringsUrl: null
                        ownerEmail: null
                        ownerName: null
                        package: PREMIUM
                        paymentMethods: []
                        phone: '9083544024'
                        pinterestUrl: null
                        planId: 86
                        planName: V2 Premium Slow + Fast Sites
                        postalCode: '07201'
                        publisherAttributes: []
                        reservationUrl: null
                        serviceItems: []
                        stateIso: NY
                        stateName: New York
                        storeId: null
                        street: 665 Monroe Ave
                        street1: null
                        subCategoryId: 1432
                        subCategoryName: Restaurants
                        tagline: null
                        tags:
                        - all
                        temporarilyClosed: false
                        tiktokUrl: null
                        toplineMessage: null
                        toplineMessageText: null
                        twitterUrl: null
                        uid: b49e138a-430d-4b88-9b0b-e24de2708c69
                        updatedAt: '2025-02-19T06:01:46.686Z'
                        videos: []
                        voiceStatus: 3
                        yearOfIncorporation: null
                        youtubeUrl: null
                        placeActionLinks:
                        - placeActionType: FOOD_ORDERING
                          uri: https://order.example.com
                          isPreferred: true
                          name: locations/1944.../placeActionLinks/54ada85bc246058a
                          submissionStatus: success
                          submissionMessage: Already up to date on Google.
                          lastSubmittedAt: '2026-07-08T12:14:36Z'
                        discoveredPlaceActionLinks:
                        - placeActionType: APPOINTMENT
                          uri: https://book.example.com
                          isPreferred: false
                          name: locations/1944.../placeActionLinks/abc123
                          providerType: MERCHANT
                          isEditable: true
                    pageInfo:
                      endCursor: TG9jYXRpb246MTE5NTI1Mg==
                      hasNextPage: true
                      hasPreviousPage: false
                      total: 4989
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad location ID or invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13651646-run
  /folders/create:
    post:
      summary: Create a new folder
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API **creates a new folder** to help organize\
        \ locations within an account. The folder name must be unique across the account.\n    \nIf a\
        \ parent folder ID `(parentFolder)` or parent folder name `(parentFolderName)` is not provided,\
        \ the folder will be created under the root folder.\n    \nFolders support a hierarchical structure,\
        \ allowing subfolders to be organized within parent folders.\n</span>"
      operationId: createFolder
      tags:
      - Organizing locations
      - Folders
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFolderRequest'
            example:
              input:
                name: franchise
                parentFolderName: all_franchise
      responses:
        '200':
          description: Folder created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFolderResponse'
              examples:
                '1':
                  summary: Successful creation
                  value:
                    data:
                      createFolder:
                        clientMutationId: null
                        errors: null
                        folder:
                          accountId: 11073
                          archived: false
                          createdAt: 2024-04-03 10:29:49 UTC
                          id: d6cc61b3-6da7-4b64-a7c0-340c0df25f4c
                          locationCount: null
                          name: franchise
                          root: false
                        success: true
                '2':
                  summary: Name already taken
                  value:
                    data:
                      createFolder:
                        clientMutationId: null
                        errors:
                        - code: SY10103
                          contextInfo:
                          - key: name
                            value: 2feb2025855pm_2
                          message: Name has already been taken
                        folder: null
                        success: false
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13659982-run
  /locations/review-campaigns:
    post:
      summary: Create a review campaign
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API creates a review campaign to request customer reviews for a specific location.


        **Behavior:**

        - Sends review requests to customers via supported channels (e.g., email, SMS).

        - Allows customization of campaign message and branding.

        - Supports targeting options, such as specific customer segments.



        </span>'
      operationId: createReviewCampaign
      tags:
      - Review Campaigns
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReviewCampaignRequest'
            example:
              input:
                locationId: TG9jYXRpb246MTQwMjQ=
                name: Christmas Sale Feedback
                locationCustomers:
                - name: John
                  email: xyz@gmail.com
                  phone: '3863443131'
                screening: true
                landingPageTemplate:
                  content: Please take a moment to review your experience with us on one of these review
                    sites.
                  heading: Thank you. We are glad to hear that you had a great experience with us.
                  reviewSiteHash:
                  - name: Google
                    url: maps.google.com
                  - name: Yelp
                    url: www.yelp.com/biz
                openingEmailTemplate:
                  replyTo: user@domain.com
                  subject: Tell us how we did
                  heading: ASD is committed to providing the best experience and service possible!
                  content: Please take 5 minutes to share some feedback on your experience!
                smsTemplate:
                  content: Hi, Thank you for visiting ASD. Can you take a few seconds to review your experience
                    with us? {{short_url}}
      responses:
        '200':
          description: Successfully created review campaign
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '403':
          description: Insufficient permissions to create campaigns
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Review Campaigns
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-14003756-run
  /posts:
    post:
      summary: Create an Announcement post
      deprecated: false
      description: ''
      tags:
      - Posts
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API Tsdfccsdfxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    postName:
                      type: string
                    locationIds:
                      type: array
                      items:
                        type: string
                    postType:
                      type: string
                    postSites:
                      type: array
                      items:
                        type: string
                    postMessage:
                      type: array
                      items:
                        type: object
                        properties:
                          site:
                            type: string
                          message:
                            type: string
                  required:
                  - postName
                  - locationIds
                  - postType
                  - postSites
                  - postMessage
              required:
              - input
            example:
              input:
                postName: Grand Opening Announcement
                locationIds:
                - '{locationId}'
                postType: ANNOUNCEMENT
                postSites:
                - GOOGLE
                postMessage:
                - site: GOOGLE
                  message: We are now open!
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Posts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169275-run
  /social-post-ideas/create-content-series:
    post:
      summary: Create content series
      deprecated: false
      description: '<span style="font-size: 14px;">

        Creates a new content series for a brand (social profile) with a name and optional theme, optionally
        seeded from existing post ideas (`postIdeaIds`). Returns the chat session that drives the series.

        </span>'
      operationId: createContentSeries
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContentSeriesRequest'
            example:
              socialProfileId: 6f1c2a90-...
              name: Summer Series
              theme: seasonal
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      createContentSeries:
                        $ref: '#/components/schemas/ChatSessionResponse'
                    x-apidog-orders:
                    - createContentSeries
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055588-run
  /locations/create/gmb-listing:
    post:
      summary: Create GMB Listing
      deprecated: false
      description: '<span style="font-size: 14px;">

        Create a GMB listing for the location with ID TG9jYXRpb246MTQwNTU= and connect it to a Google
        account

        </span>

        '
      tags:
      - Connected Accounts
      parameters:
      - name: locationId
        in: query
        description: The ID of the location for which GMB listing will be created. Encoded format
        required: true
        example: TG9jYXRpb246MTQwNTU=
        schema:
          type: string
      - name: connectedAccountId
        in: query
        description: "The ID of the connected Google account to associate with the listing\t"
        required: true
        example: bc818dc7-1576-4e50-a69d-c69d12221234
        schema:
          type: string
      - name: folderId
        in: query
        description: "The Google My Business folder ID where the listing should be created. You can get\
          \ this ID from the List folders endpoint. If not provided, it will create under Ungrouped (Primary\
          \ Group)\t"
        required: false
        example: accounts/1154433325552997863009
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: false
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      createGmbListingForLocation:
                        type: object
                        properties:
                          success:
                            type: boolean
                          errors:
                            type: 'null'
                        required:
                        - success
                        - errors
                        x-apidog-orders:
                        - success
                        - errors
                    required:
                    - createGmbListingForLocation
                    x-apidog-orders:
                    - createGmbListingForLocation
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  createGmbListingForLocation:
                    success: true
                    errors: null
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19189800-run
  /connected-accounts/create-location-from-listing:
    post:
      summary: create location from connected account listing
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API creates a new location in the system from an existing connected account listing (Google
        My Business or Facebook page) that has been previously fetched and stored in the bulk data lake.

        What This API Does:

        Takes a listing from your connected account''s bulk data (Google or Facebook)

        Fetches the latest information from the platform (Google/Facebook API)

        Creates a new location in Synup with all the business details

        Automatically links the location to the connected account

        Important Prerequisites:

        You must already have a connected account (Google or Facebook) with valid credentials

        The account must have completed the bulk listing fetch process

        The listing must be available in the bulk data lake (not yet connected to a location)

        The listing must belong to the specified connected account

        Request Parameters:

        connectedAccountId (required): UUID of your connected Google/Facebook account

        connectedAccountListingId (required): Encoded ID of the listing from bulk data (format: GmbBulkDataLake:xxx
        or FbBulkDataLake:xxx)

        tenure (optional): Billing tenure for the location (e.g., "Monthly", "Yearly")

        API Behavior:

        For Google My Business: Fetches latest location data including name, address, hours, categories,
        phone, photos, and attributes

        For Facebook: Fetches latest page data including name, location, hours, categories, description,
        and contact info

        Validates that credentials are still valid before proceeding

        Checks if the listing is already connected to prevent duplicates

        Creates location with proper state mapping (uses reverse geocoding for Facebook if needed)

        Response:

        On success: Returns success: true with the new location_id (database ID)

        On failure: Returns success: false with error code and message

        Common Error Codes:

        SY81019: User not found (authentication issue)

        SY81066: Connected account not found or archived

        SY81067: Invalid listing ID format

        SY81068: Listing already connected to another location

        SY81069: Connected account credentials are invalid (need to reconnect)

        SY81070: Listing doesn''t belong to the specified connected account

        SY81071: Unexpected error during location creation

        Post-Creation:

        Location is automatically linked to the connected account

        Background worker processes additional tasks (connection records, etc.)

        Location becomes available for management and submission

        </span>'
      operationId: connectGoogleAccount
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - errorUrl
                  - successUrl
                  properties:
                    errorUrl:
                      type: string
                      description: Redirect URL in case of Error
                      examples:
                      - http://www.errorurl.com
                    successUrl:
                      type: string
                      description: Redirect URL in case of Success
                      examples:
                      - http://www.successurl.com
                  x-apidog-orders:
                  - errorUrl
                  - successUrl
              x-apidog-orders:
              - input
            example:
              input:
                connectedAccountId: e9c587ea-ae1c-416f-8824-ef4185cd2c99
                connectedAccountListingId: R21iQnVsa0RhdGFMYWtlOjU3NzU5MzRiLTUwOTgtNGQwYS04YjQ0LTNjY2ZlZmZkZmUzNw==
                tenure: Monthly
      responses:
        '200':
          description: Successfully generated connection URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      createLocationFromConnectedAccountListing:
                        type: object
                        properties:
                          errors:
                            type: array
                            items:
                              type: string
                            description: Array of error messages if any
                            nullable: true
                          success:
                            type: boolean
                            description: True if the request was successful, otherwise False
                          locationId:
                            type: integer
                            description: The URL which needs to be visited to initiate the connect process
                        x-apidog-orders:
                        - success
                        - locationId
                        - errors
                    x-apidog-orders:
                    - createLocationFromConnectedAccountListing
                x-apidog-orders:
                - data
              example:
                data:
                  createLocationFromConnectedAccountListing:
                    success: true
                    locationId: 88277
                    errors: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-25157498-run
  /create-grid-report:
    post:
      summary: Create Rank Grid Report
      deprecated: false
      description: "\n\n<span style=\"font-size: 14px;\">\nThis API generates a new rank grid report to\
        \ analyze business rankings across specified keywords.\n\n**Behavior:**\n- Evaluates business\
        \ rankings in a defined geographic grid.\n- Supports multiple keywords for ranking analysis.\n\
        - The response includes report IDs, which can be used to fetch report details.\n   \n    \n</span>\n"
      operationId: createGridReport
      tags:
      - Grid Rank
      - Grid Rank
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGridReportInput'
            example:
              locationId: TG9jYXRpb246OTI2MDMw
              keywords:
              - grill
              gridSize: 3
              distanceUnit: mi
              latitude: '33.8937913'
              longitude: '35.5017767'
              distance: 2.5
              businessName: The Grill
              businessStreet: 1418 Professor Wafic Sinno Avenue, Beirut, LB
              businessCity: Beirut
              businessState: ''
              businessCountry: Lebanon
      responses:
        '200':
          description: Grid rank report created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGridReportResponse'
              example:
                data:
                  createGridrankReport:
                    data:
                      reportIds:
                      - 79a2773e-17ab-4209-b8d2-8261478f655f
                    errors: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request - Invalid input parameters
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Valid API key required
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Grid Rank
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932561-run
  /users/create:
    post:
      summary: Create User with Role
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API creates a new user with the specified role and attributes.


        **Behavior:**

        - Assigns the user a specific role based on permissions.

        - Configures user attributes such as name, email, and access level.

        </span>'
      operationId: createUser
      tags:
      - User Management
      - Users
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  $ref: '#/components/schemas/CreateUserInput'
              x-apidog-orders:
              - input
              x-apidog-ignore-properties: []
            example:
              input:
                email: user@example.com
                roleId: Q3VzdG9tUm9sZToyMDgzMQ==
                firstName: John
                directCustomer: true
      responses:
        '200':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserResponse'
              example:
                data:
                  addUser:
                    success: true
                    errors: []
                    user:
                      id: VXNlcjoxNjUzNjA=
                      createdAt: 2025-02-03 10:25:44 UTC
                      directCustomer: true
                      email: user@example.com
                      firstName: John
                      lastName: null
                      inviteStatus: INVITE_SENT
                      customRole:
                        id: Q3VzdG9tUm9sZToyMDgzMQ==
                        name: Admin
                      accountId: QWNjb3VudDoxNjE1NA==
                      preferences:
                        locale: en-US
                        dateFormat: null
                        timezone: null
                        columnOrder: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request - Invalid input parameters
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Valid API key required
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions to create users
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932627-run
  /folders/default:
    get:
      summary: Default folder
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Returns the default folder (ID and name) configured for the specified user within the account.
        Returns null if the user has no default folder set.

        </span>'
      operationId: defaultFolder
      tags:
      - Organizing locations
      - Organizing locations
      parameters:
      - name: userId
        in: query
        description: ID of the user whose default folder should be fetched.
        required: true
        example: 12345
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      defaultFolder:
                        $ref: '#/components/schemas/DefaultFolderType'
                    x-apidog-orders:
                    - defaultFolder
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051830-run
  /folders/delete:
    post:
      summary: Delete a folder
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API deletes a specified folder from the account. This action is irreversible.


        **Behavior:**

        - Any locations within the folder will be unassigned but not archived.

        - Once deleted, the folder cannot be restored.

        </span>'
      operationId: deleteFolder
      tags:
      - Organizing locations
      - Folders
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - name
                  properties:
                    name:
                      type: string
                      description: The name of the folder to delete
                      examples:
                      - Acme New
                  x-apidog-orders:
                  - name
              x-apidog-orders:
              - input
            example:
              input:
                name: Acme New
      responses:
        '200':
          description: Folder successfully deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      deleteFolder:
                        type: object
                        properties:
                          errors:
                            type: null
                            description: Array of errors if any occurred during deletion
                          success:
                            type: boolean
                            description: Indicates if the deletion was successful
                        x-apidog-orders:
                        - errors
                        - success
                    x-apidog-orders:
                    - deleteFolder
                x-apidog-orders:
                - data
              example:
                data:
                  deleteFolder:
                    errors: null
                    success: true
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - folder name is invalid or missing
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '403':
          description: Unauthorized - insufficient permissions to delete folder
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Folder not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660288-run
  /posts/{postId}:
    delete:
      summary: Delete a post
      deprecated: false
      description: ''
      tags:
      - Posts
      parameters:
      - name: postId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Posts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169611-run
    get:
      summary: Get a single post
      deprecated: false
      description: ''
      tags:
      - Posts
      parameters:
      - name: postId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Posts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169610-run
  /locations/photos/remove:
    post:
      summary: Delete Location Photos
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API allows you to delete one or more photos\
        \ of type ADDITIONAL from a specified location.\n\n:::info[] \n<span style=\"font-size: 14px;\"\
        > **Note** \nOnly ADDITIONAL photo types can be removed.\nLOGO and COVER photo types cannot be\
        \ deleted using this endpoint.</span>\n:::\n\nFor more details, refer to [Manage photos for your\
        \ location](https://developer.synup.com/doc-833258.md).\t\n\n</span>"
      operationId: deleteLocationPhotos
      tags:
      - Locations
      - Locations
      - Photos
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - photoIds
                  - locationId
                  properties:
                    locationId:
                      type: string
                      description: ID of the location to remove photos from
                      examples:
                      - TG9jYXRpb246MTM5NTc=
                    photoIds:
                      type: array
                      description: List of Photo IDs to be deleted
                      items:
                        type: string
                      examples:
                      - - TG9jYXRpb25QaG90bzoxMjI2MA==
                  x-apidog-orders:
                  - locationId
                  - photoIds
              x-apidog-orders:
              - input
            example: ''
      responses:
        '200':
          description: 'Logo/Cover Cannot Be Starred: If a request includes photos of type LOGO or COVER,
            the operation will fail for those photos.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      removeLocationPhotos:
                        type: object
                        properties:
                          success:
                            type: boolean
                          errors:
                            type: 'null'
                          photos:
                            type: array
                            items:
                              type: object
                              properties:
                                databaseId:
                                  type: integer
                                fileSize:
                                  type: integer
                                id:
                                  type: string
                                name:
                                  type: string
                                starred:
                                  type: boolean
                                thumbnailUrl:
                                  type: string
                                type:
                                  type: string
                                url:
                                  type: string
                                publisherOverride:
                                  type: string
                              x-apidog-orders:
                              - databaseId
                              - fileSize
                              - id
                              - name
                              - starred
                              - thumbnailUrl
                              - type
                              - url
                              - publisherOverride
                          clientMutationId:
                            type: 'null'
                        required:
                        - success
                        - errors
                        - photos
                        - clientMutationId
                        x-apidog-orders:
                        - success
                        - errors
                        - photos
                        - clientMutationId
                    required:
                    - removeLocationPhotos
                    x-apidog-orders:
                    - removeLocationPhotos
                required:
                - data
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      removeLocationPhotos:
                        success: true
                        errors: null
                        photos:
                        - databaseId: 5638205
                          fileSize: 95636
                          id: TWVkaWFGaWxlOjU2MzgyMDU=
                          name: 090f5748-2f84-405e-bd04-6cd42dad2496
                          starred: false
                          thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_7c7fdefb-c50d-4478-8b8e-957011444445.jpg
                          type: ADDITIONAL
                          url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/7c7fdefb-c50d-4478-8b8e-957011444445.jpg
                          publisherOverride: ''
                        clientMutationId: null
                '2':
                  summary: Exception
                  value:
                    data:
                      removeLocationPhotos:
                        success: false
                        errors:
                        - message: 'SY15014: Can not remove Logo/Cover'
                          contextInfo:
                          - key: null
                            value: null
                          code: SY15014
                        photos: null
                        clientMutationId: null
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642416-run
  /connected-accounts/disconnect-facebook:
    post:
      summary: Disconnect Facebook Account
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API removes the connection between your account and a Facebook Page account.

        </span>

        '
      operationId: disconnectGoogleAccount
      tags:
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    connectedAccountId:
                      type: string
                      description: Connected Account Id which needs to be disconnected
                  required:
                  - connectedAccountId
                  x-apidog-orders:
                  - connectedAccountId
              required:
              - input
              x-apidog-orders:
              - input
            example:
              input:
                connectedAccountId: d2397854-52c2-41d7-95f1-b90cba16498d
      responses:
        '200':
          description: Successful disconnection response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      fbBulkDisconnect:
                        type: object
                        properties:
                          success:
                            type: boolean
                            description: True if the request was successful
                        x-apidog-orders:
                        - success
                    x-apidog-orders:
                    - fbBulkDisconnect
                x-apidog-orders:
                - data
              example:
                data:
                  fbBulkDisconnect:
                    success: true
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Connected account not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13686527-run
  /connected-accounts/disconnect-google:
    post:
      summary: Disconnect GMB Profile
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API removes the connection between your account and a Google My Business (GMB) account.

        </span>

        '
      operationId: disconnectGoogleAccount
      tags:
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    connectedAccountId:
                      type: string
                      description: "Connected Account Id which needs to be disconnected\t"
                      format: uuid
                  required:
                  - connectedAccountId
                  x-apidog-orders:
                  - connectedAccountId
              required:
              - input
              x-apidog-orders:
              - input
            example:
              input:
                connectedAccountId: d2397854-52c2-41d7-95f1-b90cba16498d
      responses:
        '200':
          description: Successful disconnection response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      gmbBulkDisconnect:
                        type: object
                        properties:
                          success:
                            type: boolean
                            description: True if the request was success. Otherwise returns False
                        x-apidog-orders:
                        - success
                    x-apidog-orders:
                    - gmbBulkDisconnect
                x-apidog-orders:
                - data
              example:
                data:
                  gmbBulkDisconnect:
                    success: true
                    __typename: BulkDisconnectResult
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '404':
          description: Connected account not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13678474-run
  /connected-accounts/disconnect-listing:
    post:
      summary: Disconnect Location from Listing
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API removes the connection between a location\
        \ in your account and its associated Google My Business or Facebook Page listing.\n\n**Required\
        \ Fields:**\n- locationId – Base64-encoded unique identifier of the location.\n- siteType – Specifies\
        \ the platform (Google My Business or Facebook Page).\n    \n**Behavior:**\n- Once disconnected,\
        \ the system stops syncing and managing the listing.\n- The listing remains active on the external\
        \ platform, but updates from your system will no longer be applied.\n</span>"
      tags:
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisconnectListingRequest'
            example:
              input:
                locationId: TG9jYXRpb246Mjc1ODM2
                site: GOOGLE
      responses:
        '200':
          description: Disconnection process completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisconnectListingResponse'
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      disconnectConnectedAccountsLocations:
                        clientMutationId: null
                        errors: null
                        success: true
                '2':
                  summary: If not connected
                  value:
                    data:
                      disconnectConnectedAccountsLocations: null
                    errors:
                    - message: SY10057:Location is not connected for the site
          headers: {}
          x-apidog-name: OK
        '400':
          description: Invalid request - Malformed base64 string or invalid site value
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Not Found - Location or listing not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13680775-run
  /locations/download:
    get:
      summary: Download locations
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Generates a CSV export of the selected locations and returns a download URL. The export runs asynchronously
        — the response confirms the request was accepted, and the user is notified by email when the CSV
        is ready.


        Use `selectionType` to choose between all matching locations (`ALL_ITEMS`) or an explicit set
        (`SELECTED_ITEMS` with `locationIds`). The `filterInput` parameter accepts the same JSON-encoded
        filter object as Filter locations.

        </span>'
      operationId: downloadLocations
      tags:
      - Locations
      - Locations
      parameters:
      - name: filterInput
        in: query
        description: JSON-encoded filter object. Defaults to an empty filter (all locations).
        required: false
        example: '{"tags":["priority"]}'
        schema:
          type: string
      - name: selectionType
        in: query
        description: Whether to export all matching locations or an explicit selection.
        required: false
        example: ALL_ITEMS
        schema:
          type: string
          enum:
          - ALL_ITEMS
          - SELECTED_ITEMS
      - name: locationIds
        in: query
        description: Location IDs to export when selectionType is SELECTED_ITEMS.
        required: false
        example: ''
        schema:
          type: array
          items:
            type: string
      - name: emails
        in: query
        description: Email addresses to notify when the CSV is ready.
        required: false
        example: ''
        schema:
          type: array
          items:
            type: string
      - name: archived
        in: query
        description: Filter by archived state (true/false).
        required: false
        example: ''
        schema:
          type: boolean
      - name: approved
        in: query
        description: Filter by approved state (true/false).
        required: false
        example: ''
        schema:
          type: boolean
      - name: archivalScheduledAt
        in: query
        description: Return only locations scheduled for archival.
        required: false
        example: ''
        schema:
          type: boolean
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      downloadLocations:
                        $ref: '#/components/schemas/DownloadLocationsInBulkType'
                    x-apidog-orders:
                    - downloadLocations
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051637-run
  /locations/reviews/respond/edit:
    post:
      summary: Edit Response for Interaction
      deprecated: false
      description: '<span style="font-size: 14px;">

        Edit the existing response provided any Interaction

        </span>'
      operationId: respondToInteraction
      tags:
      - Reviews
      - Interactions
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - reviewId
              - responseContent
              - responseId
              properties:
                responseContent:
                  type: string
                  description: Response text content
                reviewId:
                  type: string
                  format: uuid
                  description: ID of the interaction
                responseId:
                  type: string
                  description: "Response ID\t"
                  format: uuid
              x-apidog-orders:
              - reviewId
              - responseContent
              - responseId
            example:
              reviewId: 2090753a-ece6-4837-8336-8494ad308523
              responseContent: This is a edited sample response
              responseId: 2090753a-ece6-4837-8336-8494ad308523
      responses:
        '200':
          description: Response successfully posted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      editResponse:
                        type: object
                        properties:
                          status:
                            type: boolean
                          reviewId:
                            type: string
                            format: uuid
                          responseId:
                            type: string
                            format: uuid
                        x-apidog-orders:
                        - status
                        - reviewId
                        - responseId
                        required:
                        - reviewId
                        - responseId
                    x-apidog-orders:
                    - editResponse
                x-apidog-orders:
                - data
              example:
                data:
                  editResponse:
                    status: 'true'
                    reviewId: 2090753a-ece6-4837-8336-8494ad308523
                    responseId: 2090753a-ece6-4837-8336-8494ad308524
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19356956-run
  /review_widget/edit:
    post:
      summary: Edit Review Widget
      deprecated: false
      description: ''
      tags:
      - Reviews
      parameters:
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API nQWIQkSj_nLpgzeSXtSjNVCxhVU
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                widgetId:
                  type: string
                minimumRating:
                  type: integer
                name:
                  type: string
                readOnly:
                  type: boolean
                reviewCount:
                  type: integer
                sites:
                  type: array
                  items:
                    type: string
                widgetHeight:
                  type: string
                widgetType:
                  type: string
                widgetWidth:
                  type: string
              required:
              - widgetId
              - minimumRating
              - name
              - readOnly
              - reviewCount
              - sites
              - widgetHeight
              - widgetType
              - widgetWidth
            example:
              widgetId: e4cd2716-ab7a-4218-95f9-302c98959998
              minimumRating: 5
              name: 'testing functionality2 '
              readOnly: false
              reviewCount: 10
              sites:
              - maps.google.com
              - facebook.com
              - yelp.com
              widgetHeight: 470px
              widgetType: medium_slider
              widgetWidth: 100%
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      editReviewWidget:
                        type: object
                        properties:
                          widget:
                            type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              description:
                                type: 'null'
                              widgetType:
                                type: string
                              reviewCount:
                                type: integer
                              minimumRating:
                                type: integer
                              widgetWidth:
                                type: string
                              widgetHeight:
                                type: string
                              sites:
                                type: array
                                items:
                                  type: string
                              readOnly:
                                type: boolean
                              locationId:
                                type: string
                              archived:
                                type: boolean
                              createdAt:
                                type: string
                              updatedAt:
                                type: string
                            required:
                            - id
                            - name
                            - description
                            - widgetType
                            - reviewCount
                            - minimumRating
                            - widgetWidth
                            - widgetHeight
                            - sites
                            - readOnly
                            - locationId
                            - archived
                            - createdAt
                            - updatedAt
                          errors:
                            type: 'null'
                        required:
                        - widget
                        - errors
                    required:
                    - editReviewWidget
                required:
                - data
              example:
                data:
                  editReviewWidget:
                    widget:
                      id: e4cd2716-ab7a-4218-95f9-302c98959998
                      name: 'testing functionality2 '
                      description: null
                      widgetType: medium slider
                      reviewCount: 10
                      minimumRating: 5
                      widgetWidth: 100%
                      widgetHeight: 470px
                      sites:
                      - maps.google.com
                      - facebook.com
                      - yelp.com
                      readOnly: false
                      locationId: TG9jYXRpb246NzAzNTY1
                      archived: false
                      createdAt: '2025-08-06 07:32:11.613863'
                      updatedAt: '2025-08-06 07:34:28.132402'
                    errors: null
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-20127698-run
  /social-post-ideas/extended-brand-config:
    get:
      summary: Extended brand config
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the extended generation config for a social profile — brand tone, target customers, contact/address,
        brand colors and logos, and the services/products/content-rules used to ground social post-idea
        generation.

        </span>'
      operationId: extendedBrandConfig
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      extendedBrandConfig:
                        $ref: '#/components/schemas/ExtendedBrandConfig'
                    x-apidog-orders:
                    - extendedBrandConfig
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055590-run
  /bulk-posts/{bulkPostId}:
    get:
      summary: Fetch a bulk post by ID
      deprecated: false
      description: ''
      tags:
      - Posts
      parameters:
      - name: bulkPostId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Posts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169732-run
  /locations/{locationId}/grid-reports:
    get:
      summary: Fetch All Grid Reports for Location
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API generates a new rank grid report to analyze\
        \ business rankings for specified keywords across a grid specified by the user using grid distance\
        \ and the number of grid coordinates to be analyzed.\n**Behavior:**\n- Returns a list of reports\
        \ generated for the given location.\n- Includes report IDs, keywords analyzed, and timestamps.\n\
        - Can be used to track ranking trends over time.\n   \n    \n</span>\n\n"
      operationId: getAllGridReports
      tags:
      - Grid Rank
      - Grid Rank
      parameters:
      - name: locationId
        in: path
        description: Location ID should be provided in Base64 encoded format. Must be in the format Location:<Location
          ID>
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Grid rank reports retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllGridReportsResponse'
              example:
                data:
                  gridrankReportsByLocationId:
                  - id: df996f3d-1c0e-48da-be74-8cfec452984b
                    locationId: '84703'
                    accountId: '15004'
                    keyword: italian restaurant
                    businessName: Chianti, Koramangala
                    businessStreet: No 12, 5th Block, Koramangala
                    businessCity: Bengaluru
                    businessState: Karnataka
                    businessCountry: India
                    gridSize: 3
                    gridDistance: 20
                    gridDistanceUnit: km
                    gridDistanceInKm: 20
                    ranks:
                    - rank: 6
                      latitude: 12.80803271879746
                      longitude: 77.4894662571528
                    averageRank: 8.25
                    topOneShare: 0
                    topTwoShare: 0
                    status: COMPLETED
                    latitude: 12.935216
                    longitude: 77.619961
                    placeId: null
                    createdAt: '1719372126514'
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request - Invalid location ID format
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Valid API key required
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Location not found
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Grid Rank
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932576-run
  /locations/{locationId}/reviews:
    get:
      summary: Fetch all interactions
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API retrieves interactions for a specific\
        \ location, supporting multiple filters to refine results.\n    \n    \n **Filtering Options:**\n\
        - Date Range – Fetch interactions within a specified time frame.\n- Interaction Type – Filter\
        \ by reviews, social engagements, or directory interactions.\n- Platform – Retrieve interactions\
        \ from specific sources (e.g., Google, Facebook, Yelp).\n- Response Status – Show only responded\
        \ or unresponded interactions.\n- Rating – Filter reviews by star ratings (if applicable).\n -\
        \ Keyword – Filter reviews whose content matches a search keyword.\n</span>\n"
      tags:
      - Reviews
      - Interactions
      parameters:
      - name: locationId
        in: path
        description: Base64 encoded location ID
        required: true
        example: ''
        schema:
          type: string
      - name: siteUrls
        in: query
        description: Filter by source websites
        required: false
        schema:
          type: array
          items:
            type: string
      - name: category
        in: query
        description: Filter by interaction category
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - REVIEW
      - name: startDate
        in: query
        description: Start date for filtering (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date for filtering (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
      - name: ratingFilters
        in: query
        description: "Filter by rating (1-5). Pass multiple values as an array. Example: [3,4]\t"
        required: false
        schema:
          type: array
          items:
            type: integer
            minimum: 1
            maximum: 5
      - name: searchString
        in: query
        description: 'Filter interactions by keyword. Returns only interactions whose content matches
          the keyword. Example: pizza'
        required: false
        example: pizza
        schema:
          type: string
      - name: before
        in: query
        description: If specified, records after the cursor are returned
        required: false
        schema:
          type: string
      - name: after
        in: query
        description: "If specified, records before the cursor are returned\t"
        required: false
        schema:
          type: string
      - name: first
        in: query
        description: "Specifies the number of records to fetch from the beginning\t"
        required: false
        schema:
          type: string
      - name: last
        in: query
        description: Specifies the number of records to fetch from the end
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Interactions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InteractionsResponse'
              example:
                data:
                  interactions:
                    pageInfo:
                      hasNextPage: false
                      hasPreviousPage: false
                      endCursor: null
                      total: null
                    edges:
                    - node:
                        id: 9990178a-f119-43da-adbe-e2facad5a870
                        source: maps.google.com
                        authorName: Dale Rohwedder
                        authorAvatar: https://lh6.googleusercontent.com/-rwVBMk41wg0/AAAAAAAAAAI/AAAAAAAAADc/NamFETXVIRw/w36-h36-p-mo/photo.jpg
                        rating: 4
                        date: '2019-01-24T06:13:15.332985+00:00'
                        category: Review
                      cursor: SW50ZXJhY3Rpb246OTk5MDE3OGEtZjExOS00M2RhLWFkYmUtZTJmYWNhZDVhODcw
                    totalCount: 1
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request - Invalid parameters
          headers: {}
          x-apidog-name: Bad Request
        '404':
          description: Location not found
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932709-run
  /locations/{locationId}/bulk-posts:
    get:
      summary: Fetch bulk posts for a location
      deprecated: false
      description: ''
      tags:
      - Posts
      parameters:
      - name: locationId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: page
        in: query
        description: ''
        required: true
        example: '1'
        schema:
          type: string
      - name: perPage
        in: query
        description: ''
        required: true
        example: '10'
        schema:
          type: string
      - name: tag
        in: query
        description: ''
        required: false
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Posts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169760-run
  /connected-accounts/{connectedAccountId}/details:
    get:
      summary: Fetch Connected Account Details
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API retrieves detailed information about\
        \ a specific connected account. \n    \n**Behavior:**\n\n- Returns account details only if the\
        \ account is currently connected.\n- If the account has been disconnected, no data will be returned.\n\
        \   \n    \n</span>\n"
      operationId: getConnectedAccountDetails
      tags:
      - Connected Accounts
      parameters:
      - name: connectedAccountId
        in: path
        description: Unique identifier of the connected account
        required: true
        example: bc818dc7-1576-4e50-a69d-c69d22103588
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved connected account details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectedAccountDetailsResponse'
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      connectedAccountDetails:
                        details:
                          connectedAccountId: bc818dc7-1576-4e50-a69d-c69d22103588
                          connectedAccountType: GoogleAccount
                          connectedLocationsCount: 20
                          connectivityIssue: null
                          email: abc@synup.com
                          lastFetchMatchesRequestedAt: 2022-09-20 12:14:13 UTC
                          requestMatches: true
                          requestMatchesStatus: MATCH_COMPLETED
                          status: CONNECTED
                          remarks: ''
                '2':
                  summary: Connected Account Not Found / Disconnected
                  value:
                    data:
                      connectedAccountDetails: null
                    errors:
                    - message: 'SY30036: Requested resource not found'
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: Connected account not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Record Not Found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13687153-run
  /connected-accounts/connected-account-listings:
    post:
      summary: Fetch Connected Account Listings
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n\nThis API retrieves all listings accessible to\
        \ a specific Google My Business or Facebook Page account.\n\nFeatures:\n- Pagination support –\
        \ Up to 500 records per page.\n- Filtering options – Search by:\n    - Street address\n    - Postal\
        \ code\n    - City\n    - Phone number\n    - Business name\n</span>"
      tags:
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchListingsRequest'
            example:
              connectedAccountId: 3db66afa-151d-4212-a8b7-949f9fe9aaf9
      responses:
        '200':
          description: Successfully retrieved listings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchListingsResponse'
          headers: {}
          x-apidog-name: OK
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13680740-run
  /locations/{locationId}/menus:
    get:
      summary: Fetch menus for a location
      deprecated: false
      description: ''
      tags:
      - Menus
      parameters:
      - name: locationId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: first
        in: query
        description: ''
        required: true
        example: '10'
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Menus
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169802-run
  /locations/{locationId}/posts:
    get:
      summary: Fetch posts for a location
      deprecated: false
      description: ''
      tags:
      - Posts
      parameters:
      - name: locationId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: page
        in: query
        description: ''
        required: true
        example: '1'
        schema:
          type: string
      - name: perPage
        in: query
        description: ''
        required: true
        example: '10'
        schema:
          type: string
      - name: tag
        in: query
        description: ''
        required: false
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Posts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169608-run
  /grid-report/{reportId}:
    get:
      summary: Fetch Rank Grid Report By ID
      deprecated: false
      description: "\n<span style=\"font-size: 14px;\">\n    \nThis API retrieves all grid rank reports\
        \ associated with a specific location.\n\n**Behaviour:**\n- Business details – It returns a list\
        \ of reports generated for the given location.\n- Grid configuration – Grid size, geographic coordinates,\
        \ and search parameters.\n- Ranking results – Performance across specified keywords within the\
        \ grid.\n    \n</span>"
      operationId: getGridReport
      tags:
      - Grid Rank
      - Grid Rank
      parameters:
      - name: reportId
        in: path
        description: UUID of the report to fetch
        required: true
        example: ''
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Grid rank report retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GridReportResponse'
              example:
                data:
                  gridrankReportById:
                    id: df996f3d-1c0e-48da-be74-8cfec452984b
                    locationId: '84703'
                    accountId: '15004'
                    keyword: italian restaurant
                    businessName: Chianti, Koramangala
                    businessStreet: No 12, 5th Block, Koramangala
                    businessCity: Bengaluru
                    businessState: Karnataka
                    businessCountry: India
                    gridSize: 3
                    gridDistance: 20
                    gridDistanceUnit: km
                    gridDistanceInKm: 20
                    ranks:
                    - rank: 6
                      latitude: 12.80803271879746
                      longitude: 77.4894662571528
                    averageRank: 8.25
                    topOneShare: 0
                    topTwoShare: 0
                    status: COMPLETED
                    latitude: 12.935216
                    longitude: 77.619961
                    placeId: null
                    createdAt: '1719372126514'
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request - Invalid report ID format
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Valid API key required
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Report not found
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Grid Rank
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932585-run
  /locations/filter:
    get:
      summary: Filter locations
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Returns a paginated list of locations that match the supplied filters.


        The filter criteria are passed as a single JSON-encoded object in the `input` query parameter.
        Supported filter keys include name/store/phone search (`query`, `storeId`, `phone`), location
        identifiers (`ids`), package tier (`package`), `tags`, `folders`, `categories`, address filters
        (`postalCode`, `city`, `stateIso`), custom attributes (`customAttributes`), GBP categories (`primaryGbpSiteCategories`,
        `additionalGbpSiteCategories`), add-ons (`addOnIds`), Google verification status (`googleVerificationStatus`),
        and client account scoping (`clientIds`).


        Results are returned as a Relay-style connection (`edges` + `pageInfo`). Use the `first`/`after`
        (or `last`/`before`) parameters to page through results.

        </span>'
      operationId: filterLocations
      tags:
      - Locations
      - Locations
      parameters:
      - name: input
        in: query
        description: JSON-encoded filter object. See the description for supported keys. Defaults to an
          empty filter (all locations).
        required: false
        example: '{"tags":["priority"],"city":["Austin"]}'
        schema:
          type: string
      - name: first
        in: query
        description: Number of records to return from the start of the result set.
        required: false
        example: 50
        schema:
          type: integer
      - name: after
        in: query
        description: Cursor to fetch records after.
        required: false
        example: ''
        schema:
          type: string
      - name: last
        in: query
        description: Number of records to return from the end of the result set.
        required: false
        example: 0
        schema:
          type: integer
      - name: before
        in: query
        description: Cursor to fetch records before.
        required: false
        example: ''
        schema:
          type: string
      - name: archived
        in: query
        description: Filter by archived state (true/false).
        required: false
        example: ''
        schema:
          type: boolean
      - name: approved
        in: query
        description: Filter by approved state (true/false).
        required: false
        example: ''
        schema:
          type: boolean
      - name: hasErrors
        in: query
        description: Return only locations that currently have errors.
        required: false
        example: ''
        schema:
          type: boolean
      - name: archivalScheduledAt
        in: query
        description: Return only locations scheduled for archival.
        required: false
        example: ''
        schema:
          type: boolean
      - name: blacklistIds
        in: query
        description: Location IDs to exclude from the result set.
        required: false
        example: ''
        schema:
          type: array
          items:
            type: string
      - name: sortByNameAsc
        in: query
        description: Sort results by location name ascending.
        required: false
        example: ''
        schema:
          type: boolean
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      filterLocations:
                        $ref: '#/components/schemas/LocationSummaryConnectionType'
                    x-apidog-orders:
                    - filterLocations
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '400':
          description: Bad request - Invalid filter or parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051643-run
  /local-post-ideas/generate-all-series-posts:
    post:
      summary: Generate all local series posts
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates all remaining posts for a content series in one call. Returns the generated ideas and
        a count.

        </span>'
      operationId: generateAllLocalSeriesPosts
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateAllLocalSeriesPostsRequest'
            example:
              locationId: TG9jYXRpb246MQ==
              seriesId: 3a1f...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateAllLocalSeriesPosts:
                        $ref: '#/components/schemas/LocalGenerateIdeasResponse'
                    x-apidog-orders:
                    - generateAllLocalSeriesPosts
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052188-run
  /social-post-ideas/generate-all-series-posts:
    post:
      summary: Generate all series posts
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates all remaining posts for a content series in one call. Returns the number of posts generated.

        </span>'
      operationId: generateAllSeriesPosts
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateAllSeriesPostsRequest'
            example:
              socialProfileId: 6f1c2a90-...
              seriesId: 3a1f...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateAllSeriesPosts:
                        $ref: '#/components/schemas/GenerateAllSeriesPostsResponse'
                    x-apidog-orders:
                    - generateAllSeriesPosts
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055591-run
  /social-post-ideas/generate-calendar-day:
    post:
      summary: Generate calendar day
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates (or regenerates) the post idea for a specific calendar-day slot, identified by its idea
        ID.

        </span>'
      operationId: generateCalendarDay
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateCalendarDayRequest'
            example:
              ideaId: 91b2...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateCalendarDay:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - generateCalendarDay
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055593-run
  /social-post-ideas/generate-holiday-idea-variant:
    post:
      summary: Generate holiday idea variant
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates a new post-idea variant for a given observance/holiday for a brand. Optionally steer
        with an `observanceDate` and `topic`.

        </span>'
      operationId: generateHolidayIdeaVariant
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateHolidayIdeaVariantRequest'
            example:
              socialProfileId: 6f1c2a90-...
              observanceName: Black Friday
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateHolidayIdeaVariant:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - generateHolidayIdeaVariant
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055594-run
  /social-post-ideas/generate-idea-visual:
    post:
      summary: Generate idea visual
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates an on-demand visual (image) for a social post idea from a prompt, optionally grounded
        by up to two `referenceImageUrls` and a target `imageSize`.

        </span>'
      operationId: generateIdeaVisual
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateIdeaVisualRequest'
            example:
              ideaId: 91b2...
              prompt: bright storefront on a sunny day
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateIdeaVisual:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - generateIdeaVisual
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055608-run
  /local-post-ideas/generate-holiday-idea-variant:
    post:
      summary: Generate local holiday idea variant
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates a new post-idea variant for a given observance/holiday at a location. Optionally steer
        with an `observanceDate` and `topic`.

        </span>'
      operationId: generateLocalHolidayIdeaVariant
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateLocalHolidayIdeaVariantRequest'
            example:
              locationId: TG9jYXRpb246MQ==
              observanceName: Mother's Day
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateLocalHolidayIdeaVariant:
                        $ref: '#/components/schemas/LocalRegenerateResponse'
                    x-apidog-orders:
                    - generateLocalHolidayIdeaVariant
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052189-run
  /local-post-ideas/generate-series-post:
    post:
      summary: Generate local series post
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates a single post for a content series at the given slot index.

        </span>'
      operationId: generateLocalSeriesPost
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateLocalSeriesPostRequest'
            example:
              seriesId: 3a1f...
              slotIndex: '0'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateLocalSeriesPost:
                        $ref: '#/components/schemas/LocalRegenerateResponse'
                    x-apidog-orders:
                    - generateLocalSeriesPost
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052190-run
  /social-post-ideas/generate-observance-idea:
    post:
      summary: Generate observance idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates a post idea for a given observance/holiday for a brand. Optionally steer with an `observanceDate`
        and a `hint`.

        </span>'
      operationId: generateObservanceIdea
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateObservanceIdeaRequest'
            example:
              socialProfileId: 6f1c2a90-...
              observanceName: Earth Day
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateObservanceIdea:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - generateObservanceIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055609-run
  /social-post-ideas/generate-series-post:
    post:
      summary: Generate series post
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates a single post for a content series at the given slot index.

        </span>'
      operationId: generateSeriesPost
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateSeriesPostRequest'
            example:
              socialProfileId: 6f1c2a90-...
              seriesId: 3a1f...
              slotIndex: 0
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generateSeriesPost:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - generateSeriesPost
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40055610-run
  /reviews/site-config:
    get:
      summary: Get a list of interaction sources for account
      deprecated: false
      description: '<span style="font-size: 14px;">

        Use this endpoint to list the interaction sources for a particular account as per the account''s
        subscription.

        </span>'
      tags:
      - Reviews/Review Sources
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      interactionSiteConfig:
                        type: array
                        items:
                          type: object
                          properties:
                            site:
                              type: string
                            siteUrl:
                              type: string
                          required:
                          - site
                          - siteUrl
                          x-apidog-orders:
                          - site
                          - siteUrl
                      interactionsSetting:
                        type: object
                        properties:
                          siteSettings:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                url:
                                  type: string
                                  nullable: true
                              required:
                              - name
                              - url
                              x-apidog-orders:
                              - name
                              - url
                        required:
                        - siteSettings
                        x-apidog-orders:
                        - siteSettings
                    required:
                    - interactionSiteConfig
                    - interactionsSetting
                    x-apidog-orders:
                    - interactionSiteConfig
                    - interactionsSetting
                required:
                - data
                x-apidog-orders:
                - data
              example: "{\n   \"data\": {\n      \"interactionSiteConfig\": [\n         {\n          \
                \  \"site\": \"Google\",\n            \"siteUrl\": \"maps.google.com\"\n         },\n\
                \         {\n            \"site\": \"Facebook\",\n            \"siteUrl\": \"facebook.com\"\
                \n         },\n         {\n            \"site\": \"Yelp\",\n            \"siteUrl\": \"\
                yelp.com\"\n         },\n         {\n            \"site\": \"Zillow\",\n            \"\
                siteUrl\": \"zillow.com\"\n         },\n         {\n            \"site\": \"Dealerrater\"\
                ,\n            \"siteUrl\": \"dealerrater.com\"\n         },\n         {\n           \
                \ \"site\": \"Cars.com\",\n            \"siteUrl\": \"cars.com\",\n         },\n     \
                \    {\n            \"site\": \"Edmunds\",\n            \"siteUrl\": \"edmunds.com\"\n\
                \         },\n         {\n            \"site\": \"Foursquare\",\n            \"siteUrl\"\
                : \"foursquare.com\"\n         },\n         {\n            \"site\": \"Trustpilot\",\n\
                \            \"siteUrl\": \"trustpilot.com\"\n         },\n         {\n            \"\
                site\": \"BBB\",\n            \"siteUrl\": \"bbb.org\"\n         },\n         {\n    \
                \        \"site\": \"Indeed\",\n            \"siteUrl\": \"indeed.com\"\n         },\n\
                \         {\n            \"site\": \"Judysbook\",\n            \"siteUrl\": \"judysbook.com\"\
                \n         },\n         {\n            \"site\": \"Cargurus\",\n            \"siteUrl\"\
                : \"cargurus.com\"\n         },\n         {\n            \"site\": \"Tripadvisor\",\n\
                \            \"siteUrl\": \"tripadvisor.com\"\n         },\n         {\n            \"\
                site\": \"Tripadvisor Attractions\",\n            \"siteUrl\": \"tripadvisor-attractions.com\"\
                \n         },\n         {\n            \"site\": \"Glassdoor\",\n            \"siteUrl\"\
                : \"glassdoor.com\"\n         },\n         {\n            \"site\": \"OpenTable\",\n \
                \           \"siteUrl\": \"opentable.com\"\n         },\n         {\n            \"site\"\
                : \"Yellowpages\",\n            \"siteUrl\": \"yellowpages.com\"\n         },\n      \
                \   {\n            \"site\": \"Zomato\",\n            \"siteUrl\": \"zomato.com\"\n  \
                \       }\n      ]\n   }\n}"
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Reviews/Review Sources
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19357376-run
  /locations/{location_id}/reviews/settings:
    get:
      summary: Get a list of interaction sources for location
      deprecated: false
      description: '<span style="font-size: 14px;">

        Review sources are used to pull in reviews from the supported review partners. Each interaction
        source should have an associated valid URL to pull in reviews from.


        Use this endpoint to list the interaction sources for a particular location. This API will return
        the interaction sources and the associated URL for each source. If the URL is present it means
        its connected to the location, if the URL is null it means its not connected to the location.
        It will also return the eligible interaction sources for the location as per the account''s subscription.




        </span>'
      tags:
      - Reviews/Review Sources
      parameters:
      - name: location_id
        in: path
        description: Base64 encoded location ID
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      interactionsSetting:
                        type: object
                        properties:
                          siteSettings:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                url:
                                  type: string
                                  nullable: true
                              required:
                              - name
                              - url
                              x-apidog-orders:
                              - name
                              - url
                        required:
                        - siteSettings
                        x-apidog-orders:
                        - siteSettings
                    required:
                    - interactionsSetting
                    x-apidog-orders:
                    - interactionsSetting
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  interactionsSetting:
                    siteSettings:
                    - name: maps.google.com
                      url: null
                    - name: facebook.com
                      url: https://www.facebook.com/Restaurant12-1655954454665117/
                    - name: yelp.com
                      url: null
                    - name: foursquare.com
                      url: null
                    - name: tripadvisor.com
                      url: null
                    - name: tripadvisor-attractions.com
                      url: null
                    - name: dealerrater.com
                      url: null
                    - name: judysbook.com
                      url: null
                    - name: merchantcircle.com
                      url: null
                    - name: opentable.com
                      url: null
                    - name: yellowbook.com
                      url: null
                    - name: yellowpages.com
                      url: null
                    - name: trulia.com
                      url: null
                    - name: reach150.com
                      url: null
                    - name: realtor.com
                      url: null
                    - name: zillow.com
                      url: null
                    - name: citysearch.com
                      url: null
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Reviews/Review Sources
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19357317-run
  /countries:
    get:
      summary: Get a list of supported countries and their states
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API fetches a list of supported countries, including their database IDs, ISO codes, and states.
        The retrieved ISO codes should be used as input values when creating or updating locations.

        </span>'
      tags:
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of countries and their states
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      supportedCountries:
                        type: array
                        description: List of supported countries
                        items:
                          type: object
                          properties:
                            databaseId:
                              type: integer
                              description: Unique identifier for the country in the database.
                              examples:
                              - 13
                            id:
                              type: string
                              description: Base64 encoded unique country identifier.
                              examples:
                              - Q291bnRyeToxMw==
                            iso:
                              type: string
                              description: ISO 3166-1 alpha-2 country code.
                              examples:
                              - AU
                            name:
                              type: string
                              description: Name of the country.
                              examples:
                              - Australia
                            states:
                              type: array
                              description: List of states within the country (if available).
                              items:
                                type: object
                                properties:
                                  countryId:
                                    type: integer
                                    description: Unique identifier of the country associated with the
                                      state.
                                    examples:
                                    - 13
                                  id:
                                    type: string
                                    description: Unique identifier for the state.
                                    examples:
                                    - '136'
                                  iso:
                                    type: string
                                    description: State ISO code (if applicable).
                                    examples:
                                    - WA
                                  name:
                                    type: string
                                    description: Name of the state.
                                    examples:
                                    - Western Australia
                                x-apidog-orders:
                                - countryId
                                - id
                                - iso
                                - name
                          x-apidog-orders:
                          - databaseId
                          - id
                          - iso
                          - name
                          - states
                    x-apidog-orders:
                    - supportedCountries
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized. API key is missing or invalid.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13600948-run
  /locations/{locationId}/ai-listings:
    get:
      summary: Get AI listings
      deprecated: false
      description: 'This API retrieves all premium listings associated with a specific location.


        Response Includes: Business Advice ,  Visibility Score and Sites Results'
      tags:
      - Listings
      parameters:
      - name: locationId
        in: path
        description: ID of the location in base-64 enconded format
        required: true
        example: TG9jYXRpb246MTI0MjE=
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'API key for authentication


          Example:

          API T9V35W3xxxxxxxxxxx'
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: 'Example:

          application/json'
        required: true
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      fetchAiListings:
                        type: object
                        properties:
                          aiBusinessAdvice:
                            type: object
                            properties:
                              footer:
                                type: string
                              header:
                                type: string
                              tips:
                                type: array
                                items:
                                  type: string
                              __typename:
                                type: string
                            required:
                            - footer
                            - header
                            - tips
                            - __typename
                            x-apidog-orders:
                            - footer
                            - header
                            - tips
                            - __typename
                          aiVisibilityScore:
                            type: integer
                          aiSitesResults:
                            type: array
                            items:
                              type: object
                              properties:
                                siteUrl:
                                  type: string
                                liveLink:
                                  type: string
                                  nullable: true
                                aiScore:
                                  type: object
                                  properties:
                                    addressSimilarity:
                                      type: number
                                    phoneSimilarity:
                                      type: integer
                                    overallSimilarity:
                                      type: number
                                    websiteSimilarity:
                                      type: integer
                                  required:
                                  - addressSimilarity
                                  - phoneSimilarity
                                  - overallSimilarity
                                  - websiteSimilarity
                                  x-apidog-orders:
                                  - addressSimilarity
                                  - phoneSimilarity
                                  - overallSimilarity
                                  - websiteSimilarity
                                aiResponse:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    address:
                                      type: string
                                    website:
                                      type: string
                                    phone:
                                      type: string
                                  required:
                                  - name
                                  - address
                                  - website
                                  - phone
                                  x-apidog-orders:
                                  - name
                                  - address
                                  - website
                                  - phone
                                customerPrompt:
                                  type: string
                              required:
                              - siteUrl
                              - liveLink
                              - aiScore
                              - aiResponse
                              - customerPrompt
                              x-apidog-orders:
                              - siteUrl
                              - liveLink
                              - aiScore
                              - aiResponse
                              - customerPrompt
                        required:
                        - aiBusinessAdvice
                        - aiVisibilityScore
                        - aiSitesResults
                        x-apidog-orders:
                        - aiBusinessAdvice
                        - aiVisibilityScore
                        - aiSitesResults
                    required:
                    - fetchAiListings
                    x-apidog-orders:
                    - fetchAiListings
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  fetchAiListings:
                    aiBusinessAdvice:
                      footer: By focusing on these locally inspired tips, you can enhance your business's
                        appeal and attract more customers in Winter Park.
                      header: 'Winter Park is a popular destination known for its stunning mountain views,
                        outdoor recreational activities, and vibrant local culture. Based on the local
                        trends and traditions, here are some suggestions to improve your bicycle rental
                        business:'
                      tips:
                      - 'Local Partnerships :: Collaborate with nearby hotels and resorts to offer exclusive
                        rental deals.'
                      - 'Trail Maps :: Provide detailed maps of popular biking trails and scenic routes.'
                      - 'Guided Tours :: Offer guided bike tours showcasing local landmarks and hidden
                        gems.'
                      - 'Seasonal Events :: Host biking events or races during peak tourist seasons.'
                      - 'Loyalty Programs :: Implement a rewards program for repeat customers and referrals.'
                      - 'Social Media Presence :: Share customer stories and local biking highlights on
                        social platforms.'
                      - 'Merchandise Sales :: Sell branded gear and souvenirs to enhance the customer
                        experience.'
                      - 'Maintenance Workshops :: Offer bike maintenance workshops to attract biking enthusiasts.'
                      - 'Eco-Friendly Options :: Introduce eco-friendly bike options and promote sustainable
                        practices.'
                      - 'Community Engagement :: Participate in local festivals and sponsor community
                        events.'
                      __typename: AiBusinessAdvice
                    aiVisibilityScore: 40
                    aiSitesResults:
                    - siteUrl: openai.com
                      liveLink: https://ai-listing-chatgpt.vercel.app/listing/4140924
                      aiScore:
                        addressSimilarity: 0.7952201644509336
                        phoneSimilarity: 1
                        overallSimilarity: 0.5
                        websiteSimilarity: 1
                        __typename: AiListingsScore
                      aiResponse:
                        name: Christy Sports
                        address: 78902 US-40, Winter Park, CO 80482, USA
                        website: https://www.christysports.com
                        phone: +1 970-726-8873
                        __typename: AiListingsResponse
                      customerPrompt: What is the Address, Phone Number, Business Website, Opening Hours
                        of Christy Sports located in Winter Park as of today.
                      __typename: AiListingsData
                    - siteUrl: gemini.google.com
                      liveLink: https://ai-listing-gemini.vercel.app/listing/4141628
                      aiScore:
                        addressSimilarity: 0.7952201644509336
                        phoneSimilarity: 1
                        overallSimilarity: 0.5
                        websiteSimilarity: 1
                        __typename: AiListingsScore
                      aiResponse:
                        name: Christy Sports
                        address: 78902 US-40, Winter Park, CO 80482, USA
                        website: https://www.christysports.com
                        phone: +1 970-726-8873
                        __typename: AiListingsResponse
                      customerPrompt: What is the Address, Phone Number, Business Website, Opening Hours
                        of Christy Sports located in Winter Park as of today.
                      __typename: AiListingsData
                    - siteUrl: perplexity.ai
                      liveLink: null
                      aiScore:
                        addressSimilarity: 0.7952201644509336
                        phoneSimilarity: 1
                        overallSimilarity: 0
                        websiteSimilarity: 1
                        __typename: AiListingsScore
                      aiResponse:
                        name: Christy Sports
                        address: 78902 US-40, Winter Park, CO 80482, USA
                        website: https://www.christysports.com
                        phone: +1 970-726-8873
                        __typename: AiListingsResponse
                      customerPrompt: What is the Address, Phone Number, Business Website, Opening Hours
                        of Christy Sports located in Winter Park as of today.
                      __typename: AiListingsData
                    - siteUrl: copilot.microsoft.com
                      liveLink: null
                      aiScore:
                        addressSimilarity: 0.7952201644509336
                        phoneSimilarity: 1
                        overallSimilarity: 0
                        websiteSimilarity: 1
                        __typename: AiListingsScore
                      aiResponse:
                        name: Christy Sports
                        address: 78902 US-40, Winter Park, CO 80482, USA
                        website: https://www.christysports.com
                        phone: +1 970-726-8873
                        __typename: AiListingsResponse
                      customerPrompt: What is the Address, Phone Number, Business Website, Opening Hours
                        of Christy Sports located in Winter Park as of today.
                      __typename: AiListingsData
                    - siteUrl: intellychat.com
                      liveLink: https://ai-listing-intellychat.vercel.app/listing/4141631
                      aiScore:
                        addressSimilarity: 0.7952201644509336
                        phoneSimilarity: 1
                        overallSimilarity: 0
                        websiteSimilarity: 1
                        __typename: AiListingsScore
                      aiResponse:
                        name: Christy Sports
                        address: 78902 US-40, Winter Park, CO 80482, USA
                        website: https://www.christysports.com
                        phone: +1 970-726-8873
                        __typename: AiListingsResponse
                      customerPrompt: What is the Address, Phone Number, Business Website, Opening Hours
                        of Christy Sports located in Winter Park as of today.
                      __typename: AiListingsData
                    - siteUrl: myndmeld.com
                      liveLink: https://ai-listing-myndmeld.vercel.app/listing/4141630
                      aiScore:
                        addressSimilarity: 0.7952201644509336
                        phoneSimilarity: 1
                        overallSimilarity: 0.5
                        websiteSimilarity: 1
                        __typename: AiListingsScore
                      aiResponse:
                        name: Christy Sports
                        address: 78902 US-40, Winter Park, CO 80482, USA
                        website: https://www.christysports.com
                        phone: +1 970-726-8873
                        __typename: AiListingsResponse
                      customerPrompt: What is the Address, Phone Number, Business Website, Opening Hours
                        of Christy Sports located in Winter Park as of today.
                      __typename: AiListingsData
                    __typename: AiListings
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Listings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19356815-run
  /locations/listings/duplicates:
    get:
      summary: Get all duplicate listings for an account
      deprecated: false
      description: '<span style="font-size: 14px;">


        This API retrieves a paginated list of all duplicate listings detected within the account, with
        optional filtering


        </span>'
      operationId: getAccountDuplicateListings
      tags:
      - Listings
      - Listings
      parameters:
      - name: tag
        in: query
        description: Filter duplicates by location tag
        required: false
        example: test
        schema:
          type: string
      - name: page
        in: query
        description: Page number for pagination
        required: false
        example: 1
        schema:
          type: integer
          minimum: 1
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: Duplicate listings retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      duplicateListingsRollup:
                        type: object
                        properties:
                          pageInfo:
                            type: object
                            properties:
                              hasNextPage:
                                type: boolean
                                description: Indicates if there are more pages after the current one
                              hasPreviousPage:
                                type: boolean
                                description: Indicates if there are previous pages
                              totalPages:
                                type: integer
                                description: Total number of pages available
                              totalRecords:
                                type: integer
                                description: Total number of duplicate listings
                            x-apidog-orders:
                            - hasNextPage
                            - hasPreviousPage
                            - totalPages
                            - totalRecords
                          records:
                            type: array
                            items:
                              type: object
                              properties:
                                addressValid:
                                  type: boolean
                                  description: Indicates if the address matches the primary listing
                                categoryValid:
                                  type: boolean
                                  description: Indicates if the business category matches
                                  nullable: true
                                city:
                                  type: string
                                  description: City name
                                countryCode:
                                  type: string
                                  description: ISO country code
                                  nullable: true
                                duplicateProcessingState:
                                  type: string
                                  enum:
                                  - POTENTIAL
                                  description: Current state of duplicate processing
                                id:
                                  type: string
                                  description: Unique identifier for the duplicate listing
                                liveLink:
                                  type: string
                                  description: URL of the duplicate listing
                                locationId:
                                  type: string
                                  description: ID of the associated location
                                name:
                                  type: string
                                  description: Business name
                                nameValid:
                                  type: boolean
                                  description: Indicates if the business name matches
                                originalLiveLink:
                                  type: string
                                  description: URL of the primary listing
                                phone:
                                  type: string
                                  description: Phone number
                                  nullable: true
                                phoneValid:
                                  type: boolean
                                  description: Indicates if the phone number matches
                                postalCode:
                                  type: string
                                  description: Postal/ZIP code
                                siteName:
                                  type: string
                                  description: Name of the directory site
                                siteUrl:
                                  type: string
                                  description: Base URL of the directory site
                                state:
                                  type: string
                                  description: State/province code
                                  nullable: true
                                street:
                                  type: string
                                  description: Street address
                              x-apidog-orders:
                              - addressValid
                              - categoryValid
                              - city
                              - countryCode
                              - duplicateProcessingState
                              - id
                              - liveLink
                              - locationId
                              - name
                              - nameValid
                              - originalLiveLink
                              - phone
                              - phoneValid
                              - postalCode
                              - siteName
                              - siteUrl
                              - state
                              - street
                        x-apidog-orders:
                        - pageInfo
                        - records
                    x-apidog-orders:
                    - duplicateListingsRollup
                x-apidog-orders:
                - data
              example:
                data:
                  duplicateListingsRollup:
                    pageInfo:
                      hasNextPage: true
                      hasPreviousPage: false
                      totalPages: 2
                      totalRecords: 89
                    records:
                    - addressValid: false
                      categoryValid: null
                      city: Chicago
                      countryCode: null
                      duplicateProcessingState: POTENTIAL
                      id: '43843437'
                      liveLink: https://www.judysbook.com/Buffalo-Wild-Wings-Restaurants-chicago-r14401354.htm
                      locationId: '203040'
                      name: Buffalo Wild Wings
                      nameValid: true
                      originalLiveLink: https://www.judysbook.com/Buffalo-Wild-Wings-BtoB%7eAccountants-Business-chicago-r39915056.htm
                      phone: '--- ''7738689453''

                        '
                      phoneValid: true
                      postalCode: '60614'
                      siteName: Judys Book
                      siteUrl: judysbook.com
                      state: IL
                      street: 2464 North Lincoln Avenue
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Insufficient permissions to access duplicate listings
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Listings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13672026-run
  /locations/{locationId}/bing-analytics:
    get:
      summary: Get Bing Analytics
      deprecated: false
      description: Fetch profile analytics for Bing data for a specific location
      tags:
      - Profile Analytics
      parameters:
      - name: locationId
        in: path
        description: Location ID
        required: true
        example: ''
        schema:
          type: string
          examples:
          - TG9jYXRpb246MTI5Njkw
      - name: fromDate
        in: query
        description: Start date of date range filter (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2018-12-17'
      - name: toDate
        in: query
        description: End date of date range filter (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2019-01-31'
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      bingInsights:
                        type: object
                        properties:
                          views:
                            type: array
                            description: The number of views the Bing profile has received
                            items:
                              type: object
                              properties:
                                startTime:
                                  type: string
                                  format: date-time
                                  description: Start time of the analytics period
                                  examples:
                                  - '2018-12-17T00:00:00+00:00'
                                value:
                                  type: integer
                                  description: Number of views for the period
                                  examples:
                                  - 73
                              x-apidog-orders:
                              - startTime
                              - value
                              x-apidog-ignore-properties: []
                        x-apidog-orders:
                        - views
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - bingInsights
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Profile Analytics
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695983-run
  /folder-details:
    get:
      summary: Get details of a folder
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API retrieves detailed information about a\
        \ specific folder.\n\n\n**Response Includes:**\n- Folder details (ID, name)\n- Parent folder information\
        \ (if applicable)\n- Creation date\n    \n\n:::info[]\n<span style=\"font-size: 14px;\">    \n\
        Note: Either folderId or folderName must be provided as a query parameter.\n    </span>\n:::\n\
        </span>"
      tags:
      - Organizing locations
      parameters:
      - name: folderId
        in: query
        description: Unique identifier of the folder
        required: false
        example: 67049f29-3bc6-4e82-875b-02159b4b1fea
        schema:
          type: string
          format: uuid
      - name: folderName
        in: query
        description: Name of the folder
        required: false
        example: franchise
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved folder details
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      getFolderDetails:
                        type: object
                        properties:
                          locations:
                            type: array
                            description: List of locations in the folder
                            items:
                              type: object
                              x-apidog-orders: []
                              properties: {}
                          folderName:
                            type: string
                            description: Name of the folder
                            examples:
                            - franchise
                          parentFolderId:
                            type: string
                            format: uuid
                            description: Unique identifier of the parent folder
                            examples:
                            - 72a9f81d-1c74-44c2-8e7d-7c51787cbc09
                          parentFolderName:
                            type: string
                            description: Name of the parent folder
                            examples:
                            - all_franchise
                          createdAt:
                            type: string
                            format: date-time
                            description: Creation timestamp of the folder
                            examples:
                            - 2024-04-03 10:29:49 UTC
                        required:
                        - locations
                        - folderName
                        - parentFolderId
                        - parentFolderName
                        - createdAt
                        x-apidog-orders:
                        - locations
                        - folderName
                        - parentFolderId
                        - parentFolderName
                        - createdAt
                    x-apidog-orders:
                    - getFolderDetails
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660126-run
  /locations/{locationId}/listings/duplicates:
    get:
      summary: Get duplicate listings for a location
      deprecated: false
      description: '<span style="font-size: 14px;">


        This API retrieves all duplicate listings identified for a specific location across various directories.

        </span>'
      operationId: getDuplicateListings
      tags:
      - Listings
      - Listings
      parameters:
      - name: locationId
        in: path
        description: The unique identifier of the location
        required: true
        example: TG9jYXRpb246MjcyODc2
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: Duplicate listings retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      duplicateListingsForLocation:
                        type: array
                        items:
                          type: object
                          properties:
                            primaryListingUrl:
                              type: string
                              description: URL of the primary business listing
                            siteId:
                              type: string
                              description: Unique identifier for the directory site
                            siteName:
                              type: string
                              description: Name of the directory site
                            siteUrl:
                              type: string
                              description: Base URL of the directory site
                            duplicateListings:
                              type: array
                              items:
                                type: object
                                properties:
                                  addressValid:
                                    type: boolean
                                    description: Indicates if the address matches the primary listing
                                  city:
                                    type: string
                                    description: City name
                                  street:
                                    type: string
                                    description: Street address
                                  state:
                                    type: string
                                    description: State/province code
                                    nullable: true
                                  postalCode:
                                    type: string
                                    description: Postal/ZIP code
                                  phone:
                                    type: string
                                    description: Phone number
                                    nullable: true
                                  phoneValid:
                                    type: boolean
                                    description: Indicates if the phone number matches the primary listing
                                  name:
                                    type: string
                                    description: Business name
                                  nameValid:
                                    type: boolean
                                    description: Indicates if the business name matches the primary listing
                                  duplicateProcessingState:
                                    type: string
                                    enum:
                                    - POTENTIAL
                                    description: Current state of duplicate processing
                                  liveLink:
                                    type: string
                                    description: URL of the duplicate listing
                                  id:
                                    type: string
                                    description: Unique identifier for the duplicate listing
                                  countryCode:
                                    type: string
                                    description: ISO country code
                                    nullable: true
                                x-apidog-orders:
                                - addressValid
                                - city
                                - street
                                - state
                                - postalCode
                                - phone
                                - phoneValid
                                - name
                                - nameValid
                                - duplicateProcessingState
                                - liveLink
                                - id
                                - countryCode
                          x-apidog-orders:
                          - primaryListingUrl
                          - siteId
                          - siteName
                          - siteUrl
                          - duplicateListings
                    x-apidog-orders:
                    - duplicateListingsForLocation
                x-apidog-orders:
                - data
              example:
                data:
                  duplicateListingsForLocation:
                  - primaryListingUrl: https://chicago.opendi.us/9170659.html
                    siteId: U2l0ZToxNjI=
                    siteName: OpenDi.us
                    siteUrl: opendi.us
                    duplicateListings:
                    - addressValid: false
                      city: Chicago
                      street: 111/1123 N Elston Ave street 2
                      state: null
                      postalCode: '60603'
                      phone: null
                      phoneValid: false
                      name: Jr consultants
                      nameValid: true
                      duplicateProcessingState: POTENTIAL
                      liveLink: https://chicago.opendi.us/8773423.html
                      id: TGlzdGluZ0l0ZW06NDMzODcxMzE=
                      countryCode: US
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid location ID
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Insufficient permissions to access duplicate listings
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Listings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13671710-run
  /locations/{locationId}/facebook-analytics:
    get:
      summary: Get Facebook Page Analytics
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves profile analytics data from Facebook for a specific location.

        </span>'
      tags:
      - Profile Analytics
      parameters:
      - name: locationId
        in: path
        description: Location ID
        required: true
        example: ''
        schema:
          type: string
          examples:
          - TG9jYXRpb246MTI5Njkw
      - name: fromDate
        in: query
        description: Start date of date range filter (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2018-01-01'
      - name: toDate
        in: query
        description: End date of date range filter (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2018-12-31'
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      facebookInsights:
                        type: object
                        properties:
                          ctaAction:
                            type: array
                            description: The number of times the CTA on the page was clicked
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          directionsAction:
                            type: array
                            description: The number of times directions for the particular location was
                              requested
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          phoneAction:
                            type: array
                            description: The number of times the call number for the location was requested
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          views:
                            type: array
                            description: The number of times the page was viewed
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          websiteAction:
                            type: array
                            description: The number of times the website URL for the location was requested
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                        x-apidog-orders:
                        - ctaAction
                        - directionsAction
                        - phoneAction
                        - views
                        - websiteAction
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - facebookInsights
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Profile Analytics
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695985-run
  /locations/{locationId}/google-analytics:
    get:
      summary: Get Google My Business Analytics
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves a specific location''s profile analytics data from Google Business Profile
        (GBP).

        </span>'
      tags:
      - Profile Analytics
      parameters:
      - name: locationId
        in: path
        description: Location ID
        required: true
        example: ''
        schema:
          type: string
          examples:
          - TG9jYXRpb246MTI5Njkw
      - name: fromDate
        in: query
        description: Start date of date range filter (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2018-01-01'
      - name: toDate
        in: query
        description: End date of date range filter (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2018-12-31'
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      googleInsights:
                        type: object
                        properties:
                          directionsAction:
                            type: array
                            description: The number of times directions for the particular location was
                              requested
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          maps:
                            type: array
                            description: The number of times the location showed up on Google Maps
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          phoneAction:
                            type: array
                            description: The number of times the call number for the location was requested
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          search:
                            type: array
                            description: The number of times the location showed up on Google Search results
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          websiteAction:
                            type: array
                            description: The number of times the website URL for the location was requested
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                          total:
                            type: array
                            description: The total sum of all the above interactions
                            items:
                              $ref: '#/components/schemas/InsightMetric'
                        x-apidog-orders:
                        - directionsAction
                        - maps
                        - phoneAction
                        - search
                        - websiteAction
                        - total
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - googleInsights
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Profile Analytics
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695987-run
  /locations/{locationId}/{type}:
    get:
      summary: Get Interaction Analytics
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API retrieves interaction analytics data based\
        \ on the requested analytics type.\n\n**Available Analytics Types:**\n- `review-analytics-overview`\
        \ – Provides overall statistics, including total interactions, average ratings, and response rates.\n\
        - `review-analytics-timeline` – Returns time-based analytics, showing interaction trends over\
        \ a selected period.\n- `review-analytics-sites-stats` – Provides site-wise breakdown, showing\
        \ performance across platforms like Google, Facebook, and Yelp.\n\n </span>"
      operationId: getAnalytics
      tags:
      - Reviews
      - Analytics
      parameters:
      - name: locationId
        in: path
        description: Base64 encoded location ID (e.g., TG9jYXRpb246MTA1NTk0Nw==)
        required: true
        example: ''
        schema:
          type: string
      - name: type
        in: path
        description: Type of analytics data to retrieve
        required: true
        example: ''
        schema:
          type: string
          enum:
          - review-analytics-overview
          - review-analytics-timeline
          - review-analytics-sites-stats
      - name: startDate
        in: query
        description: Required for timeline analytics. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Required for timeline analytics. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved analytics data
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
              examples:
                '1':
                  summary: Overall Analytics Stats
                  value:
                    data:
                      interactionsAnalyticsStats:
                        stats:
                        - name: total-reviews
                          value: 24575
                          delta: 100
                        - name: new-reviews
                          value: 24575
                          delta: 100
                        - name: overall-rating
                          value: 1.628321464903357
                          delta: 100
                        - name: review-response-rate
                          value: 0.10579857578840285
                          delta: 100
                '2':
                  summary: Analytics Timeline
                  value:
                    data:
                      interactionsChartData:
                        data:
                        - date: '2023-04-01'
                          interactionCount: 1
                          averageRating: 1
                        - date: '2023-04-02'
                          interactionCount: 1
                          averageRating: 1
                        - date: '2024-09-15'
                          interactionCount: 2
                          averageRating: 1
                '3':
                  summary: Site-wise Analytics
                  value:
                    data:
                      interactionsSitesStats:
                        stats:
                        - key: Yelp
                          siteUrl: yelp.com
                          averageRating:
                            value: 1.628321464903357
                            delta: 100
                          totalInteractions:
                            value: 24575
                            delta: 100
                          newInteractions:
                            value: 24575
                            delta: 100
                          recency: '1738540800000.0'
                          baseRating: 1.629760631734803
                          baseInteractions: 24314
                          humanizedRecency: 1 day ago
                        - key: Consolidated
                          siteUrl: Consolidated
                          averageRating:
                            value: 1.628321464903357
                            delta: 100
                          totalInteractions:
                            value: 24575
                            delta: 100
                          newInteractions:
                            value: 24575
                            delta: 100
                          recency: '1738540800000.0'
                          baseRating: 1.629760631734803
                          baseInteractions: 24314
                          humanizedRecency: 1 day ago
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932683-run
  /locations/{locationId}/keywords-performance:
    get:
      summary: Get keywords performance
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves the ranking performance of all keywords associated with a specific location.

        </span>'
      tags:
      - Rankings
      parameters:
      - name: locationId
        in: path
        description: Location ID
        required: true
        example: ''
        schema:
          type: string
          examples:
          - TG9jYXRpb246OTUzMTUw
      - name: fromDate
        in: query
        description: Start date to fetch rankings from (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2025-02-01'
      - name: toDate
        in: query
        description: End date to fetch rankings until (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          examples:
          - '2025-02-07'
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      keywordsByLocationId:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              examples:
                              - S2V5d29yZDoxODQ1OTY4
                            databaseId:
                              type: string
                              examples:
                              - '1845968'
                            name:
                              type: string
                              examples:
                              - local business
                            sites:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    enum:
                                    - Google
                                    - Yahoo
                                    - Google Maps
                                    - Bing
                                    examples:
                                    - Google
                                  rankings:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        rank:
                                          type: integer
                                          examples:
                                          - 5
                                        rankedAt:
                                          type: string
                                          format: date-time
                                          examples:
                                          - '2025-02-04T03:28:57.931518'
                                        matchType:
                                          type: string
                                          examples:
                                          - location_url
                                          nullable: true
                                        matchUrl:
                                          type: string
                                          examples:
                                          - https://example.com/location
                                          nullable: true
                                      x-apidog-orders:
                                      - rank
                                      - rankedAt
                                      - matchType
                                      - matchUrl
                                x-apidog-orders:
                                - name
                                - rankings
                          x-apidog-orders:
                          - id
                          - databaseId
                          - name
                          - sites
                    x-apidog-orders:
                    - keywordsByLocationId
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: success
                  value:
                    data:
                      keywordsByLocationId:
                      - id: S2V5d29yZDoxODQ1OTY4
                        databaseId: '1845968'
                        name: local business
                        sites:
                        - name: Google
                          rankings:
                          - rank: 5
                            rankedAt: '2025-02-04T03:28:57.931518'
                            matchType: location_url
                            matchUrl: https://example.com/location
                '2':
                  summary: noKeywords
                  value:
                    data:
                      keywordsByLocationId: []
                '3':
                  summary: noRankings
                  value:
                    data:
                      keywordsByLocationId:
                      - id: S2V5d29yZDoxODg2NDQ5
                        databaseId: '1886449'
                        name: local business near me
                        sites:
                        - name: Google
                          rankings:
                          - rank: 0
                            rankedAt: '2025-01-13T12:22:19.409968'
                            matchType: null
                            matchUrl: null
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      keywordsByLocationId:
                        type: null
                    x-apidog-orders:
                    - keywordsByLocationId
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          examples:
                          - 'SY90001: Not authorized to access this resource'
                      x-apidog-orders:
                      - message
                x-apidog-orders:
                - data
                - errors
          headers: {}
          x-apidog-name: Unauthorized
      security: []
      x-apidog-folder: Rankings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695557-run
  /locations-by-store-codes:
    get:
      summary: Get locations by store codes
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">

        This API retrieves location details based on specified store codes. Using unique store codes,
        allows businesses to fetch location-specific information such as name, address, contact details,
        business hours, and other relevant attributes.

        </span>'
      operationId: getLocationsByStoreCodes
      tags:
      - Locations
      parameters:
      - name: storeCodes
        in: query
        description: Array of store codes in JSON string format.
        required: true
        example: '["storeCode1", "storeCode2"]'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      getLocationsByStoreCodes:
                        type: array
                        items:
                          type: object
                          properties:
                            accountId:
                              type: integer
                            addOns:
                              type: array
                              items:
                                type: string
                            additionalCategoryIds:
                              type: array
                              items:
                                type: string
                            additionalCategoryNames:
                              type: array
                              items:
                                type: string
                            additionalInfo:
                              type: 'null'
                            additionalPhones:
                              type: array
                              items:
                                type: string
                            approved:
                              type: string
                            archivalScheduledAt:
                              type: 'null'
                            archived:
                              type: boolean
                            archivedAt:
                              type: 'null'
                            bizUrl:
                              type: string
                            bizUrlUtm:
                              type: boolean
                            bookingUrl:
                              type: 'null'
                            businessHours:
                              type: array
                              items:
                                type: string
                            cancellationScheduledAt:
                              type: 'null'
                            categoryId:
                              type: integer
                            city:
                              type: string
                            contentPreferredLanguage:
                              type: string
                            countryCode:
                              type: string
                            countryIso:
                              type: string
                            createErrors:
                              type: array
                              items:
                                type: string
                            createdDate:
                              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
                                required:
                                - archived
                                - enumValues
                                - name
                                - slug
                                - type
                                - value
                                x-apidog-orders:
                                - archived
                                - enumValues
                                - name
                                - slug
                                - type
                                - value
                            databaseId:
                              type: integer
                            description:
                              type: string
                            enabledSiteIds:
                              type: array
                              items:
                                type: string
                            facebookUrl:
                              type: 'null'
                            folderId:
                              type: string
                            folderName:
                              type: string
                            franchise:
                              type: boolean
                            googleAdsPhone:
                              type: 'null'
                            googleVerificationStatus:
                              type: object
                              properties:
                                message:
                                  type: 'null'
                                status:
                                  type: string
                              required:
                              - message
                              - status
                              x-apidog-orders:
                              - message
                              - status
                            googleplusUrl:
                              type: 'null'
                            hideAddress:
                              type: boolean
                            id:
                              type: string
                            instagramUrl:
                              type: 'null'
                            isRestaurant:
                              type: boolean
                            lastUpdatedDate:
                              type: string
                            latitude:
                              type: string
                            linkedinUrl:
                              type: 'null'
                            locationPhotos:
                              type: array
                              items:
                                type: object
                                properties:
                                  databaseId:
                                    type: integer
                                  fileSize:
                                    type: integer
                                  id:
                                    type: string
                                  name:
                                    type: string
                                  starred:
                                    type: boolean
                                  thumbnailUrl:
                                    type: string
                                  type:
                                    type: string
                                  url:
                                    type: string
                                required:
                                - databaseId
                                - fileSize
                                - id
                                - name
                                - starred
                                - thumbnailUrl
                                - type
                                - url
                                x-apidog-orders:
                                - databaseId
                                - fileSize
                                - id
                                - name
                                - starred
                                - thumbnailUrl
                                - type
                                - url
                            longitude:
                              type: string
                            managedServiceSiteBuckets:
                              type: array
                              items:
                                type: string
                            managedServiceSites:
                              type: array
                              items:
                                type: string
                            moreHours:
                              type: array
                              items:
                                type: string
                            name:
                              type: string
                            offeringsUrl:
                              type: 'null'
                            ownerEmail:
                              type: 'null'
                            ownerName:
                              type: 'null'
                            package:
                              type: string
                            paymentMethods:
                              type: array
                              items:
                                type: string
                            phone:
                              type: 'null'
                            pinterestUrl:
                              type: 'null'
                            planId:
                              type: integer
                            planName:
                              type: string
                            postalCode:
                              type: string
                            publisherAttributes:
                              type: array
                              items:
                                type: string
                            reservationUrl:
                              type: 'null'
                            serviceItems:
                              type: array
                              items:
                                type: object
                                properties:
                                  categoryId:
                                    type: string
                                  countryIso:
                                    type: 'null'
                                  currencyCode:
                                    type: 'null'
                                  description:
                                    type: 'null'
                                  id:
                                    type: string
                                  languageCode:
                                    type: 'null'
                                  name:
                                    type: string
                                  price:
                                    type: 'null'
                                required:
                                - categoryId
                                - countryIso
                                - currencyCode
                                - description
                                - id
                                - languageCode
                                - name
                                - price
                                x-apidog-orders:
                                - categoryId
                                - countryIso
                                - currencyCode
                                - description
                                - id
                                - languageCode
                                - name
                                - price
                            stateIso:
                              type: string
                            stateName:
                              type: string
                            storeId:
                              type: string
                            street:
                              type: 'null'
                            street1:
                              type: 'null'
                            subCategoryId:
                              type: integer
                            subCategoryName:
                              type: string
                            tagline:
                              type: 'null'
                            tags:
                              type: array
                              items:
                                type: string
                            temporarilyClosed:
                              type: boolean
                            tiktokUrl:
                              type: 'null'
                            toplineMessage:
                              type: 'null'
                            toplineMessageText:
                              type: 'null'
                            twitterUrl:
                              type: 'null'
                            uid:
                              type: string
                            updatedAt:
                              type: string
                            videos:
                              type: array
                              items:
                                type: string
                            voiceStatus:
                              type: integer
                            yearOfIncorporation:
                              type: 'null'
                            youtubeUrl:
                              type: 'null'
                          x-apidog-orders:
                          - accountId
                          - addOns
                          - additionalCategoryIds
                          - additionalCategoryNames
                          - additionalInfo
                          - additionalPhones
                          - approved
                          - archivalScheduledAt
                          - archived
                          - archivedAt
                          - bizUrl
                          - bizUrlUtm
                          - bookingUrl
                          - businessHours
                          - cancellationScheduledAt
                          - categoryId
                          - city
                          - contentPreferredLanguage
                          - countryCode
                          - countryIso
                          - createErrors
                          - createdDate
                          - customAttributes
                          - databaseId
                          - description
                          - enabledSiteIds
                          - facebookUrl
                          - folderId
                          - folderName
                          - franchise
                          - googleAdsPhone
                          - googleVerificationStatus
                          - googleplusUrl
                          - hideAddress
                          - id
                          - instagramUrl
                          - isRestaurant
                          - lastUpdatedDate
                          - latitude
                          - linkedinUrl
                          - locationPhotos
                          - longitude
                          - managedServiceSiteBuckets
                          - managedServiceSites
                          - moreHours
                          - name
                          - offeringsUrl
                          - ownerEmail
                          - ownerName
                          - package
                          - paymentMethods
                          - phone
                          - pinterestUrl
                          - planId
                          - planName
                          - postalCode
                          - publisherAttributes
                          - reservationUrl
                          - serviceItems
                          - stateIso
                          - stateName
                          - storeId
                          - street
                          - street1
                          - subCategoryId
                          - subCategoryName
                          - tagline
                          - tags
                          - temporarilyClosed
                          - tiktokUrl
                          - toplineMessage
                          - toplineMessageText
                          - twitterUrl
                          - uid
                          - updatedAt
                          - videos
                          - voiceStatus
                          - yearOfIncorporation
                          - youtubeUrl
                    required:
                    - getLocationsByStoreCodes
                    x-apidog-orders:
                    - getLocationsByStoreCodes
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  getLocationsByStoreCodes:
                  - accountId: 11073
                    name: Sample Store
                    storeId: jio678
                    city: Chicago
                    countryIso: US
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - Invalid store codes format
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: One or more store codes not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13651265-run
  /locations/{locationId}/photos:
    get:
      summary: Get Photos by Location IDs
      deprecated: false
      description: "<br>\n<span style=\"font-size: 14px;\">\n\nThis API allows returns all media files\
        \ of a specific location. \n\nFor more details, refer to `Photo specifications for your business\
        \ location` markdown.\n\n</span>\n"
      tags:
      - Locations
      - Locations
      - Photos
      parameters:
      - name: locationId
        in: path
        description: Location ID should be provided in Base64 encoded format. Must be in the format Location:<Location
          ID>
        required: true
        example: TG9jYXRpb246MTIzNA==
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      mediaFilesOfLocation:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            url:
                              type: string
                            uploadedBy:
                              type: 'null'
                            fileName:
                              type: string
                            fileSize:
                              type: string
                            fileType:
                              type: string
                            fileExtension:
                              type: string
                            archived:
                              type: boolean
                            accountId:
                              type: integer
                            thumbnailUrl:
                              type: string
                            starred:
                              type: boolean
                            category:
                              type: object
                              properties:
                                name:
                                  type: string
                                id:
                                  type: integer
                                  nullable: true
                              required:
                              - name
                              - id
                              x-apidog-orders:
                              - name
                              - id
                            mediaLabels:
                              type: array
                              items:
                                type: string
                            fileDimensions:
                              type: object
                              properties:
                                height:
                                  type: integer
                                width:
                                  type: integer
                              required:
                              - height
                              - width
                              x-apidog-orders:
                              - height
                              - width
                            uploadedAt:
                              type: string
                            locationId:
                              type: string
                            publisherOverride:
                              type: string
                          required:
                          - id
                          - url
                          - uploadedBy
                          - fileName
                          - fileSize
                          - fileType
                          - fileExtension
                          - archived
                          - accountId
                          - thumbnailUrl
                          - starred
                          - category
                          - mediaLabels
                          - fileDimensions
                          - uploadedAt
                          - locationId
                          - publisherOverride
                          x-apidog-orders:
                          - id
                          - url
                          - uploadedBy
                          - fileName
                          - fileSize
                          - fileType
                          - fileExtension
                          - archived
                          - accountId
                          - thumbnailUrl
                          - starred
                          - category
                          - mediaLabels
                          - fileDimensions
                          - uploadedAt
                          - locationId
                          - publisherOverride
                    required:
                    - mediaFilesOfLocation
                    x-apidog-orders:
                    - mediaFilesOfLocation
                required:
                - data
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      mediaFilesOfLocation:
                      - id: TWVkaWFGaWxlOjE1MjQxMTI2
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4bfe278e-20b6-452d-9452-78bcf1b42c23.jpg
                        uploadedBy: null
                        fileName: f806ffe20422997c10679184617176a0_7f6c96df7edcda94fa06671f91503400_615cc436-7ecd-4b88-a877-69cd732e09c7.jpg
                        fileSize: '1896470'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/thumbnail_4bfe278e-20b6-452d-9452-78bcf1b42c23.jpg
                        starred: false
                        category:
                          name: Logo
                          id: 4
                        mediaLabels: []
                        fileDimensions:
                          height: 2016
                          width: 1512
                        uploadedAt: '2025-08-13T07:23:08.513340'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MzE=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/2f01e5b9-3ef0-46c0-915f-5ffbd86ffda0.png
                        uploadedBy: null
                        fileName: a19b5ecb-a02d-4bb6-9d98-8b8d93692051
                        fileSize: '2452380'
                        fileType: image
                        fileExtension: .png
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_2f01e5b9-3ef0-46c0-915f-5ffbd86ffda0.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1069
                          width: 1901
                        uploadedAt: '2023-12-06T11:49:10.330065'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MzA=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/c4da92af-8a3e-4efc-ac93-308125e263c2.jpg
                        uploadedBy: null
                        fileName: ce07c65e-bccf-44c4-a316-bdf684ebc200
                        fileSize: '226346'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_c4da92af-8a3e-4efc-ac93-308125e263c2.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 720
                          width: 1280
                        uploadedAt: '2023-12-06T11:49:09.259954'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3Mjk=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/4f261548-7af1-4587-854f-88be3bba1daf.png
                        uploadedBy: null
                        fileName: 2f417f09-35b7-439c-ab2d-a1e5336bc6b6
                        fileSize: '1459771'
                        fileType: image
                        fileExtension: .png
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_4f261548-7af1-4587-854f-88be3bba1daf.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 802
                          width: 1338
                        uploadedAt: '2023-12-06T11:49:08.723470'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3Mjg=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/e9020dee-71f9-473e-8cae-00346ade05c9.jpg
                        uploadedBy: null
                        fileName: c591d809-31c8-4988-b8c2-512f8b256488
                        fileSize: '59008'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_e9020dee-71f9-473e-8cae-00346ade05c9.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 683
                          width: 455
                        uploadedAt: '2023-12-06T11:49:07.836766'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3Mjc=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/5e37f2c2-8c3e-4953-aadd-6e7d7cef31b5.jpg
                        uploadedBy: null
                        fileName: 0fbc2cd3-61cf-4bc0-8aca-219505fb02d6
                        fileSize: '276873'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_5e37f2c2-8c3e-4953-aadd-6e7d7cef31b5.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 2160
                          width: 2160
                        uploadedAt: '2023-12-06T11:49:07.366851'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MjY=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/910e353a-985a-4895-b8a4-6b847f7b30a7.jpg
                        uploadedBy: null
                        fileName: 11d1c85f-5985-42e3-9fc7-976d71cc3708
                        fileSize: '366584'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_910e353a-985a-4895-b8a4-6b847f7b30a7.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 2160
                          width: 2160
                        uploadedAt: '2023-12-06T11:49:06.792830'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MjU=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/d965c352-5b20-4e3a-bfe0-8f10459e5094.jpg
                        uploadedBy: null
                        fileName: bd96d2fd-6a55-4977-a23f-5362ad8da319
                        fileSize: '1310166'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_d965c352-5b20-4e3a-bfe0-8f10459e5094.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3144
                          width: 4192
                        uploadedAt: '2023-12-06T11:49:06.061264'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MjQ=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/1bf2e45e-3703-43dd-b99e-f0f88005415c.jpg
                        uploadedBy: null
                        fileName: 9171f53a-0df3-4fa0-a3da-633571b30e8e
                        fileSize: '1494683'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_1bf2e45e-3703-43dd-b99e-f0f88005415c.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3144
                          width: 4192
                        uploadedAt: '2023-12-06T11:49:05.353684'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MjM=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b248c6e6-004f-4dc9-9355-c3e32a01e706.jpg
                        uploadedBy: null
                        fileName: 624d6f54-8dfe-46aa-bbe9-ebe8db84eedb
                        fileSize: '318968'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b248c6e6-004f-4dc9-9355-c3e32a01e706.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3144
                          width: 4192
                        uploadedAt: '2023-12-06T11:49:04.623145'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MjI=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/2e7e3cf0-79d9-4403-8f96-89c4e26513c5.jpg
                        uploadedBy: null
                        fileName: a8abe39b-19a2-4b02-b53c-78676d9074b2
                        fileSize: '993481'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_2e7e3cf0-79d9-4403-8f96-89c4e26513c5.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3144
                          width: 3643
                        uploadedAt: '2023-12-06T11:49:03.893841'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MjE=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/53920a3a-20a4-4bcd-ae1a-43570f9b1d0b.jpg
                        uploadedBy: null
                        fileName: cc842fca-de80-4ff3-97d7-4ba11c1f1061
                        fileSize: '484178'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_53920a3a-20a4-4bcd-ae1a-43570f9b1d0b.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1920
                          width: 1080
                        uploadedAt: '2023-12-06T11:49:03.029109'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MjA=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f48e6ef9-dfcc-4b0b-8d2f-f2fdef8993be.jpg
                        uploadedBy: null
                        fileName: e3ee068d-867a-4866-b304-d7ad8ffbbf83
                        fileSize: '1879575'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f48e6ef9-dfcc-4b0b-8d2f-f2fdef8993be.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 4032
                          width: 3024
                        uploadedAt: '2023-12-06T11:49:02.426044'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTk=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/9e8ba38c-220c-432c-bae2-4f7205b3468c.jpg
                        uploadedBy: null
                        fileName: fff7df60-cdb1-40f2-ad15-2e94089d3b78
                        fileSize: '1575003'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_9e8ba38c-220c-432c-bae2-4f7205b3468c.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3024
                          width: 4032
                        uploadedAt: '2023-12-06T11:49:01.552470'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTg=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/5cd440ed-feef-42f3-a4d9-a748b247d9c1.jpg
                        uploadedBy: null
                        fileName: 9d9f26f5-4f28-4ed6-8d5c-458c0288a5b0
                        fileSize: '1657470'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_5cd440ed-feef-42f3-a4d9-a748b247d9c1.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 4032
                          width: 3024
                        uploadedAt: '2023-12-06T11:49:00.724307'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTc=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/71082d63-7561-4763-b314-a5231983a2ff.jpg
                        uploadedBy: null
                        fileName: c7fe3d56-39a4-4b77-8fe5-1984a31c0e53
                        fileSize: '378419'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_71082d63-7561-4763-b314-a5231983a2ff.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:59.946546'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTY=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/cd4b8199-67b1-42ba-8c08-55780c3e4001.jpg
                        uploadedBy: null
                        fileName: 5082cc86-758f-4e56-8225-47e12b57e813
                        fileSize: '282591'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_cd4b8199-67b1-42ba-8c08-55780c3e4001.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:59.461815'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTU=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f046f63c-ecd9-473a-abda-d47cf074a7d0.jpg
                        uploadedBy: null
                        fileName: a452303e-12bc-4ea2-8395-a99424036cbe
                        fileSize: '335318'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f046f63c-ecd9-473a-abda-d47cf074a7d0.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:58.852016'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTQ=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/aaf681f3-890d-4407-bf5a-1c1919f115b2.jpg
                        uploadedBy: null
                        fileName: 79983baa-f9a3-4626-8a37-6fd73b892e2b
                        fileSize: '440938'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_aaf681f3-890d-4407-bf5a-1c1919f115b2.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:58.283919'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTM=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/98c5e768-8da8-4964-ac7a-96eb55cf50d7.jpg
                        uploadedBy: null
                        fileName: 5aa03377-dfb0-434d-94b6-29b6933a9e4e
                        fileSize: '563862'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_98c5e768-8da8-4964-ac7a-96eb55cf50d7.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:57.680234'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTI=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/ef51ecf2-c010-43b8-9447-08a1d8aedc51.jpg
                        uploadedBy: null
                        fileName: f4bba2af-3cb9-40fe-b601-84ff702ea987
                        fileSize: '573764'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_ef51ecf2-c010-43b8-9447-08a1d8aedc51.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:57.133572'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTE=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b1072b33-4d84-47e8-8888-7b7bebae9bb0.jpg
                        uploadedBy: null
                        fileName: af802979-df73-49cb-b2e9-ba270457f0d7
                        fileSize: '582601'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b1072b33-4d84-47e8-8888-7b7bebae9bb0.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:56.544375'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MTA=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/266cbdc0-3fac-4b56-891f-e6b12e21dac1.jpg
                        uploadedBy: null
                        fileName: 6cd94c35-2e1c-488d-b315-bffa5b774a0b
                        fileSize: '497151'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_266cbdc0-3fac-4b56-891f-e6b12e21dac1.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1080
                          width: 1080
                        uploadedAt: '2023-12-06T11:48:55.922416'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDk=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f1546b09-4a4a-4ed9-96cb-86ea4cbf0908.jpg
                        uploadedBy: null
                        fileName: f009bd88-b6c1-4532-b4ea-b792feed4878
                        fileSize: '829582'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f1546b09-4a4a-4ed9-96cb-86ea4cbf0908.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1599
                          width: 1599
                        uploadedAt: '2023-12-06T11:48:55.238518'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDg=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b58b4b93-aea1-4510-a269-f4e257128597.jpg
                        uploadedBy: null
                        fileName: dc0f7924-d902-40a7-8794-9f17318dd8c9
                        fileSize: '618821'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b58b4b93-aea1-4510-a269-f4e257128597.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1440
                          width: 1440
                        uploadedAt: '2023-12-06T11:48:54.356440'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDc=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f67453e5-9565-4cb0-bb45-0b9ca2c8aed2.jpg
                        uploadedBy: null
                        fileName: d872a936-9f0e-4f64-84bc-0acc3e987a83
                        fileSize: '1544154'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f67453e5-9565-4cb0-bb45-0b9ca2c8aed2.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3144
                          width: 3401
                        uploadedAt: '2023-12-06T11:48:53.608816'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDY=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/02d3f12b-5718-4f20-aebf-4ace1c701881.jpg
                        uploadedBy: null
                        fileName: b014d63e-cf9a-4b53-917a-395a974c3800
                        fileSize: '1405208'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_02d3f12b-5718-4f20-aebf-4ace1c701881.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3144
                          width: 4192
                        uploadedAt: '2023-12-06T11:48:52.815885'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDU=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b3a04d3d-c631-407d-b70a-cb7975ae879e.jpg
                        uploadedBy: null
                        fileName: 0561c93b-a50c-42da-a408-126b86bf4ed6
                        fileSize: '1394506'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b3a04d3d-c631-407d-b70a-cb7975ae879e.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 3144
                          width: 4192
                        uploadedAt: '2023-12-06T11:48:51.992469'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDQ=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/54b1f926-4f6c-4404-b72b-baafa533fe21.jpg
                        uploadedBy: null
                        fileName: 34a2a3ab-4d1d-4850-855b-ca89d39ff0bb
                        fileSize: '1574232'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_54b1f926-4f6c-4404-b72b-baafa533fe21.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 4192
                          width: 3144
                        uploadedAt: '2023-12-06T11:48:51.272334'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDM=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/d23144d8-0d3f-4f97-909a-3a91b16cab0c.jpg
                        uploadedBy: null
                        fileName: b911981b-6a94-4979-8abe-c89a53226a59
                        fileSize: '469757'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_d23144d8-0d3f-4f97-909a-3a91b16cab0c.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 720
                          width: 960
                        uploadedAt: '2023-12-06T11:48:50.474788'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDI=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/c4d61240-ae6c-418c-9d7b-a2c8fdee85ba.jpg
                        uploadedBy: null
                        fileName: fa760e19-3408-47b9-ad5c-8aef2a97e11e
                        fileSize: '365922'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_c4d61240-ae6c-418c-9d7b-a2c8fdee85ba.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 720
                          width: 960
                        uploadedAt: '2023-12-06T11:48:49.876063'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDE=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/bf4a69e6-1a00-4385-9240-edf74ff1f2ea.jpg
                        uploadedBy: null
                        fileName: 2fb10d5c-147d-4ac5-869d-fdd496281bd7
                        fileSize: '1082353'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_bf4a69e6-1a00-4385-9240-edf74ff1f2ea.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 2904
                          width: 2904
                        uploadedAt: '2023-12-06T11:48:49.333250'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA3MDA=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/c21a79f2-f48f-4f95-9049-993fd4a7b3fe.jpg
                        uploadedBy: null
                        fileName: 7604609c-65bf-49a6-bbfa-3ba919eb60ea
                        fileSize: '1256619'
                        fileType: image
                        fileExtension: .jpg
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_c21a79f2-f48f-4f95-9049-993fd4a7b3fe.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 1280
                          width: 1280
                        uploadedAt: '2023-12-06T11:48:48.596824'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA2OTk=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/7d8c51a8-7c38-41aa-9602-6aef19fa8397.png
                        uploadedBy: null
                        fileName: 7e8589ef-74f0-4201-aa80-2582ebeb7b1b
                        fileSize: '36149'
                        fileType: image
                        fileExtension: .png
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_7d8c51a8-7c38-41aa-9602-6aef19fa8397.jpg
                        starred: false
                        category:
                          name: Uncategorised
                          id: null
                        mediaLabels: []
                        fileDimensions:
                          height: 878
                          width: 1532
                        uploadedAt: '2023-12-06T11:48:47.962359'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                      - id: TWVkaWFGaWxlOjQwNTA2OTg=
                        url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/608bdbe4-0b2a-4a63-98b9-c53b081ba71b.png
                        uploadedBy: null
                        fileName: b9a58c9f-6035-45e0-a7f7-e8a30c924678
                        fileSize: '65296'
                        fileType: image
                        fileExtension: .png
                        archived: false
                        accountId: 16154
                        thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_608bdbe4-0b2a-4a63-98b9-c53b081ba71b.jpg
                        starred: false
                        category:
                          name: Cover
                          id: 2
                        mediaLabels: []
                        fileDimensions:
                          height: 374
                          width: 1110
                        uploadedAt: '2023-12-06T11:48:47.274561'
                        locationId: TG9jYXRpb246NzAzNTY1
                        publisherOverride: ''
                '2':
                  summary: When no media Files
                  value:
                    data:
                      mediaFilesOfLocation: []
          headers: {}
          x-apidog-name: Example Response
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                    - Variable "$input" got invalid value {"locationId":"TG9jYXRpb246MTA4NzIxMQ==","photos":[{"photo":"https://pngimg.com/uploads/minus/minus_PNG40.png","type":"NON
                      EXISTENT"}]}; Expected type LocationMediaType at value.photos[0].type.
                required:
                - message
                x-apidog-orders:
                - message
          headers: {}
          x-apidog-name: Invalid input
        x-200:Example Response (Over 30 Photos):
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addLocationPhotos:
                        type: object
                        properties:
                          success:
                            type: boolean
                          errors:
                            type: 'null'
                          photos:
                            type: array
                            items:
                              type: string
                          request:
                            type: object
                            properties:
                              requestId:
                                type: string
                              status:
                                type: string
                            required:
                            - requestId
                            - status
                            x-apidog-orders:
                            - requestId
                            - status
                          clientMutationId:
                            type: 'null'
                        required:
                        - success
                        - errors
                        - photos
                        - request
                        - clientMutationId
                        x-apidog-orders:
                        - success
                        - errors
                        - photos
                        - request
                        - clientMutationId
                    required:
                    - addLocationPhotos
                    x-apidog-orders:
                    - addLocationPhotos
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  addLocationPhotos:
                    success: true
                    errors: null
                    photos: []
                    request:
                      requestId: e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a
                      status: PROCCESSING
                    clientMutationId: null
          headers: {}
          x-apidog-name: Example Response (Over 30 Photos)
      security: []
      x-apidog-folder: Locations
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-23089104-run
  /locations/{locationId}/listings/premium:
    get:
      summary: Get premium listings
      deprecated: false
      description: '<span style="font-size: 14px;">


        This API retrieves all premium listings associated with a specific location.


        **Response Includes:**

        - Sync status – Indicates whether the listing is synced successfully.

        - Display status – Shows whether the listing is live on the platform.

        - Platform details – Includes directories such as Google Maps, Apple Maps, and other listing sites.

        </span>'
      operationId: getPremiumListings
      tags:
      - Listings
      - Listings
      parameters:
      - name: locationId
        in: path
        description: Node ID of the location
        required: true
        example: TG9jYXRpb246MTI0MjE=
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: Premium listings retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      listingsForLocation:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Node ID of the listing
                            databaseId:
                              type: string
                              description: Database ID of the listing
                            site:
                              type: object
                              properties:
                                id:
                                  type: string
                                  description: Node ID of the directory site
                                databaseId:
                                  type: string
                                  description: Database ID of the directory site
                                name:
                                  type: string
                                  description: Name of the directory site
                                url:
                                  type: string
                                  description: URL of the directory site
                                syScore:
                                  type: string
                                  description: Synup score for the directory
                              x-apidog-orders:
                              - id
                              - databaseId
                              - name
                              - url
                              - syScore
                            syncStatus:
                              type: string
                              description: Current sync status of the listing
                              enum:
                              - IN_PROGRESS
                              - SYNCED
                              - FAILED
                              - REQUIRING_ACTION
                              - AVAILABLE
                              - COMPLETED
                              - PENDING_APPROVAL
                            displayStatus:
                              type: string
                              description: Human-readable status message
                              nullable: true
                            actionRequired:
                              type: boolean
                              description: Whether user action is required
                            listingUrl:
                              type: string
                              description: URL of the live listing
                            connectedAccountId:
                              type: string
                              description: gives the connected_account_id its mapped to
                            lastUpdate:
                              type: string
                              description: last updated at date
                            indexStatus:
                              type: boolean
                              description: SOV index status
                            syncIssue:
                              type: string
                              description: error while syncing
                            verfied:
                              type: boolean
                              description: check if this listing is verified
                          x-apidog-orders:
                          - id
                          - databaseId
                          - site
                          - syncStatus
                          - displayStatus
                          - actionRequired
                          - listingUrl
                          - connectedAccountId
                          - lastUpdate
                          - indexStatus
                          - syncIssue
                          - verfied
                          required:
                          - connectedAccountId
                          - lastUpdate
                          - indexStatus
                          - syncIssue
                          - verfied
                    x-apidog-orders:
                    - listingsForLocation
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Listings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13671527-run
  /locations/ranking-sitewise-histogram:
    post:
      summary: Get Rankings Distribution By Time
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API provides the weekly distribution of keyword rankings across four predefined rank buckets
        (1-3, 3-10, 10-20, 20-50) for each site. It returns the number of keywords falling within each
        rank range on specific dates for these sites. This helps track keyword performance trends over
        a time period.

        </span>'
      tags:
      - Rankings
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - fromDate
              - toDate
              - locationIds
              - source
              properties:
                fromDate:
                  type: string
                  format: date
                  description: Date from where data has to be fetched
                  examples:
                  - '2023-03-11'
                toDate:
                  type: string
                  format: date
                  description: Date till where data has to be fetched
                  examples:
                  - '2023-03-15'
                locationIds:
                  type: array
                  description: IDs to fetch data
                  items:
                    type: string
                  examples:
                  - - TG9jYXRpb246NzkwODQ=
                source:
                  type: array
                  description: List of sources
                  items:
                    type: string
                    enum:
                    - Google
                    - Bing
                    - Yahoo
                    - Google Maps
                  examples:
                  - - Google
              x-apidog-orders:
              - fromDate
              - toDate
              - locationIds
              - source
              x-apidog-ignore-properties: []
            example: ''
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      rankingsRollupByKeywordCount:
                        type: array
                        items:
                          type: object
                          properties:
                            site:
                              type: string
                              description: Source name
                              examples:
                              - Google
                            keywordCountByBucket:
                              type: array
                              items:
                                type: object
                                properties:
                                  rankRange:
                                    type: string
                                    description: Rank range bucket
                                    enum:
                                    - rank_from_1_to_3
                                    - rank_from_3_to_10
                                    - rank_from_10_to_20
                                    - rank_from_20_to_50
                                    examples:
                                    - rank_from_1_to_3
                                  dailyKeywordCount:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        rankDate:
                                          type: string
                                          format: date
                                          description: Specific date
                                          examples:
                                          - '2023-03-06'
                                        keywordCount:
                                          type: integer
                                          description: The value for the date
                                          examples:
                                          - 0
                                      x-apidog-orders:
                                      - rankDate
                                      - keywordCount
                                      x-apidog-ignore-properties: []
                                x-apidog-orders:
                                - rankRange
                                - dailyKeywordCount
                                x-apidog-ignore-properties: []
                          x-apidog-orders:
                          - site
                          - keywordCountByBucket
                          x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - rankingsRollupByKeywordCount
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
          headers: {}
          x-apidog-name: Unauthorized
      security: []
      x-apidog-folder: Rankings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695783-run
  /locations/ranking-analytics-timeline:
    post:
      summary: Get Rollup Keyword Performance
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API allows you to fetch ranking analytics data for multiple locations in your account within
        a single API call for a specific period. You can also specify the sources you want to filter the
        results for. The sources include Google maps and Google search.

        </span>'
      tags:
      - Rankings
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - fromDate
              - toDate
              - locationIds
              - source
              properties:
                fromDate:
                  type: string
                  format: date
                  description: Date from where data has to be fetched
                  examples:
                  - '2023-03-11'
                toDate:
                  type: string
                  format: date
                  description: Date till where data has to be fetched
                  examples:
                  - '2023-03-15'
                locationIds:
                  type: array
                  description: IDs to fetch data
                  items:
                    type: string
                  examples:
                  - - TG9jYXRpb246NzkwODQ=
                source:
                  type: array
                  description: List of sources
                  items:
                    type: string
                    enum:
                    - Google
                    - Bing
                    - Yahoo
                    - Google Maps
                  examples:
                  - - Google
              x-apidog-orders:
              - fromDate
              - toDate
              - locationIds
              - source
              x-apidog-ignore-properties: []
            example: ''
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      rankingsRollupByDate:
                        type: array
                        items:
                          type: object
                          properties:
                            siteAverageRanking:
                              type: array
                              items:
                                type: object
                                properties:
                                  site:
                                    type: string
                                    description: Source of rankings
                                    examples:
                                    - Google
                                    enum:
                                    - Google
                                    - Bing
                                    - Yahoo
                                    - Google Maps
                                    x-apidog-enum:
                                    - value: Google
                                      name: ''
                                      description: ''
                                    - value: Bing
                                      name: ''
                                      description: ''
                                    - value: Yahoo
                                      name: ''
                                      description: ''
                                    - value: Google Maps
                                      name: ''
                                      description: ''
                                  averageRankings:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        date:
                                          type: string
                                          format: date
                                          description: Specific date
                                          examples:
                                          - '2023-03-11'
                                        averageRank:
                                          type: integer
                                          description: The value for the date
                                          examples:
                                          - 0
                                      x-apidog-orders:
                                      - date
                                      - averageRank
                                      x-apidog-ignore-properties: []
                                x-apidog-orders:
                                - site
                                - averageRankings
                                x-apidog-ignore-properties: []
                          x-apidog-orders:
                          - siteAverageRanking
                          x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - rankingsRollupByDate
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
          headers: {}
          x-apidog-name: Unauthorized
      security: []
      x-apidog-folder: Rankings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695712-run
  /plan-sites:
    get:
      summary: Get Site Details for Your Plan
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API retrieves all site details associated\
        \ with a specific plan, including:\n\n- Unique identifiers for each site\n- Supported countries\
        \ where the plan is available\n- Site URLs for access and management \n</span>"
      tags:
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved site details for the plan
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      planSites:
                        type: array
                        items:
                          type: object
                          properties:
                            hideAddressSupportedCountries:
                              type: array
                              items:
                                type: string
                              description: Countries where Service Area Business (SAB) is supported
                            id:
                              type: integer
                              description: Unique identifier for the site
                            name:
                              type: string
                              description: Name of the site
                            supportedCountries:
                              type: array
                              items:
                                type: string
                              description: ISO codes of countries where the site is supported
                            url:
                              type: string
                              description: URL of the site
                          required:
                          - hideAddressSupportedCountries
                          - id
                          - name
                          - supportedCountries
                          - url
                          x-apidog-orders:
                          - id
                          - name
                          - url
                          - supportedCountries
                          - hideAddressSupportedCountries
                        description: List of sites associated with the plan
                    required:
                    - planSites
                    x-apidog-orders:
                    - planSites
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  planSites:
                  - hideAddressSupportedCountries: []
                    id: 224
                    name: Thumbtack
                    supportedCountries:
                    - US
                    url: thumbtack.com
                  - hideAddressSupportedCountries:
                    - FR
                    - DE
                    - NL
                    - IE
                    - US
                    - CA
                    - AU
                    - NZ
                    - ES
                    - GB
                    id: 2
                    name: Yelp
                    supportedCountries:
                    - FR
                    - DE
                    - NL
                    - IE
                    - US
                    - CA
                    - AU
                    - NZ
                    - ES
                    - BE
                    - GB
                    - IT
                    - CH
                    - SE
                    - PL
                    - AT
                    url: yelp.com
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized. API key is missing or invalid.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13602957-run
  /sub-categories:
    get:
      summary: Get SubCategories and AdditionalCategories
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves a list of the latest subcategories and additional categories available in the
        system.

        </span>'
      tags:
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved categories.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      subcategories:
                        type: array
                        items:
                          type: object
                          properties:
                            databaseId:
                              type: integer
                              description: Subcategory ID.
                            id:
                              type: string
                              description: Base64 encoded value of subcategory ID.
                            name:
                              type: string
                              description: Name of the subcategory.
                            primary:
                              type: boolean
                              description: If true, it is a subcategory that can be used as a primary
                                category. If false, it is an additional category and cannot be used as
                                a primary category.
                          x-apidog-orders:
                          - databaseId
                          - id
                          - name
                          - primary
                          required:
                          - databaseId
                          - id
                          - name
                          - primary
                    required:
                    - subcategories
                    x-apidog-orders:
                    - subcategories
                required:
                - data
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      subcategories:
                      - databaseId: 639
                        id: U3ViQ2F0ZWdvcnk6NjM5
                        name: 3D Printing
                        primary: true
                '2':
                  summary: Exception
                  value:
                    data: null
                    errors:
                    - message: SY90005:Invalid Token
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized. Invalid or missing API key.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13636558-run
  /locations/{locationId}/voice-assistants:
    get:
      summary: Get voice listings for a location
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves all voice assistant listings associated with a specific location.


        **Available Voice Assistants:**

        - Google Assistant

        - Cortana

        - Alexa

        - Siri

        - Bixby


        **Response Includes:**

        - Sync status – Indicates whether the listing is successfully synced.

        - Connection details – Provides integration status with each voice assistant.

        - Potential issues – Highlights any errors preventing successful sync.

        </span>'
      operationId: getVoiceListings
      tags:
      - Listings
      - Voice Listings
      parameters:
      - name: locationId
        in: path
        description: The unique identifier of the location
        required: true
        example: TG9jYXRpb246MTA2MDY4Mw==
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: Voice listings retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      voiceAssistantsForLocation:
                        type: array
                        items:
                          type: object
                          properties:
                            databaseId:
                              type: string
                              description: Internal database identifier
                            actionRequired:
                              type: boolean
                              description: Indicates if user action is needed
                            connectedAccountId:
                              type: string
                              description: ID of the connected account if available
                              nullable: true
                            errors:
                              type: array
                              items:
                                type: string
                              description: Array of error messages if any
                            voiceIdentifier:
                              type: string
                              enum:
                              - GOOGLE_ASSISTANT
                              - CORTANA
                              - ALEXA
                              - SIRI
                              - BIXBY
                              description: Unique identifier for the voice assistant
                            name:
                              type: string
                              description: Display name of the voice assistant
                            syncStatus:
                              type: string
                              enum:
                              - IN_PROGRESS
                              - COMPLETED
                              - FAILED
                              description: Current sync status
                            syncIssue:
                              type: string
                              description: Description of any sync issues
                              nullable: true
                            __typename:
                              type: string
                              description: GraphQL type name
                          x-apidog-orders:
                          - databaseId
                          - actionRequired
                          - connectedAccountId
                          - errors
                          - voiceIdentifier
                          - name
                          - syncStatus
                          - syncIssue
                          - __typename
                    x-apidog-orders:
                    - voiceAssistantsForLocation
                x-apidog-orders:
                - data
              example:
                data:
                  voiceAssistantsForLocation:
                  - databaseId: '72246903'
                    actionRequired: false
                    connectedAccountId: 2311f31a-ad73-4e2c-a063-6ae4a9d4c705
                    errors: []
                    voiceIdentifier: GOOGLE_ASSISTANT
                    name: Google Assistant
                    syncStatus: IN_PROGRESS
                    syncIssue: null
                    __typename: VoiceAssistant
                  - databaseId: '72246683'
                    actionRequired: false
                    connectedAccountId: null
                    errors: []
                    voiceIdentifier: CORTANA
                    name: Cortana
                    syncStatus: IN_PROGRESS
                    syncIssue: null
                    __typename: VoiceAssistant
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid location ID
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Insufficient permissions to access voice listings
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Listings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13671591-run
  /locations/google-verification-stats:
    get:
      summary: Google verification location stats
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Returns aggregated Google (Google Business Profile) verification status counts across the filtered
        set of locations — for example how many are verified, under review, pending verification, suspended,
        duplicate, or not connected. Use `filterInput`/`selectionType`/`locationIds` to scope the set,
        identical to Filter locations.

        </span>'
      operationId: googleVerificationLocationStats
      tags:
      - Locations
      - Locations
      parameters:
      - name: filterInput
        in: query
        description: JSON-encoded filter object. Defaults to an empty filter (all locations).
        required: false
        example: '{}'
        schema:
          type: string
      - name: selectionType
        in: query
        description: Whether to include all matching locations or an explicit selection.
        required: false
        example: ALL_ITEMS
        schema:
          type: string
          enum:
          - ALL_ITEMS
          - SELECTED_ITEMS
      - name: locationIds
        in: query
        description: Location IDs to include when selectionType is SELECTED_ITEMS.
        required: false
        example: ''
        schema:
          type: array
          items:
            type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      googleVerificationLocationStats:
                        $ref: '#/components/schemas/GoogleVerificationLocationStats'
                    x-apidog-orders:
                    - googleVerificationLocationStats
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051645-run
  /social-post-ideas/holiday-idea-variants:
    get:
      summary: Holiday idea variants
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the generated post-idea variants for a given observance/holiday for a brand. Each item
        is a post idea (see Post idea for the full shape).

        </span>'
      operationId: holidayIdeaVariants
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: observanceName
        in: query
        description: Name of the observance/holiday.
        required: true
        example: Black Friday
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      holidayIdeaVariants:
                        type: array
                        description: Post ideas (see Post idea for the full shape).
                        items:
                          type: object
                          x-apidog-orders: []
                    x-apidog-orders:
                    - holidayIdeaVariants
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140127-run
  /social-post-ideas/idea-job-status:
    get:
      summary: Idea job status
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the async job status for a social post idea (used to poll image generation) — the current
        status and, when ready, the generated image URL.

        </span>'
      operationId: ideaJobStatus
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: ideaId
        in: query
        description: ID of the post idea.
        required: true
        example: 91b2...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ideaJobStatus:
                        $ref: '#/components/schemas/IdeaJobStatus'
                    x-apidog-orders:
                    - ideaJobStatus
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140134-run
  /social-post-ideas/image-credits:
    get:
      summary: Image credits
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the image-generation credit status for a brand (social profile) — monthly limit, used/remaining
        this month, and any add-on credit pool.

        </span>'
      operationId: imageCredits
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      imageCredits:
                        $ref: '#/components/schemas/ImageCredits'
                    x-apidog-orders:
                    - imageCredits
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140138-run
  /social-post-ideas/link-post-idea-to-social-post:
    post:
      summary: Link post idea to social post
      deprecated: false
      description: '<span style="font-size: 14px;">

        Links a generated post idea to a published social post, so the idea is marked as used and tracked
        against the social post.

        </span>'
      operationId: linkPostIdeaToSocialPost
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkPostIdeaToSocialPostRequest'
            example:
              postIdeaId: 91b2...
              socialPostId: 5d7e...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      linkPostIdeaToSocialPost:
                        $ref: '#/components/schemas/LinkPostIdeaToSocialPostResponse'
                    x-apidog-orders:
                    - linkPostIdeaToSocialPost
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140139-run
  /subscriptions:
    get:
      summary: List Active Subscriptions
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves a list of all active subscriptions or tenures associated with your account
        </span>'
      tags:
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsResponse'
              example:
                data:
                  activeSubscriptions:
                  - name: Premium plan - Monthly
                    paymentSubscriptionId: b8b5075f-35ff-4aaf-9580-44271e0dde34
                    planId: premium-1month
                    tenure: Monthly
                  - name: Standard plan - Yearly
                    paymentSubscriptionId: c8b5078h-36ff-4aaf-1380-33281a0eeg34
                    planId: standard-year
                    tenure: Yearly
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13639877-run
  /connected-accounts:
    get:
      summary: List all connected accounts
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API retrieves a paginated list of all connected\
        \ accounts under your account, with support for filtering by publisher type and connection status.\n\
        \nFeatures:\n- Pagination support – Retrieve results in batches for efficient processing.\n- Filtering\
        \ options – Filter connected accounts by:\n    - Publisher type (Google My Business, Facebook,\
        \ etc.)\n    - Connection status (Active, Expired, Disconnected)\n</span>"
      tags:
      - Connected Accounts
      parameters:
      - name: publisher
        in: query
        description: "Type of connected accounts to filter by. Accepted values\n* `FacebookAccount` \n\
          * `GoogleAccount`\n"
        required: false
        example: GoogleAccount
        schema:
          type: string
          enum:
          - FacebookAccount
          - GoogleAccount
      - name: status
        in: query
        description: 'Connection status to filter by.

          * `Connected` - Currently connected accounts

          * `ConnectionIssue` - Accounts with connection issues

          '
        required: false
        example: Connected
        schema:
          type: string
          enum:
          - Connected
          - ConnectionIssue
      - name: page
        in: query
        description: Page number for pagination
        required: false
        example: 1
        schema:
          type: integer
          default: 1
      - name: perPage
        in: query
        description: Number of records per page
        required: false
        example: 20
        schema:
          type: integer
          default: 20
          maximum: 100
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved connected accounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectedAccountsResponse'
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13679586-run
  /folders/flat:
    get:
      summary: List all folders
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API returns a flat list of all active folders accessible to the user.


        Response Includes:

        - Basic folder information (ID, name)

        - Parent folder details (if applicable)

        - Number of locations within each folder

        - Hierarchy level of each folder


        </span>'
      operationId: listFolders
      tags:
      - Organizing locations
      - Folders
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: false
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved folders list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFoldersResponse'
              example:
                data:
                  getUserFolders:
                  - id: 401228fe-8ee9-4914-a08a-db7cda490ec9
                    level: 0
                    locationCount: 2749
                    name: root
                    parentFolderId: null
                    parentFolderName: null
                  - id: 0360d778-1bfb-4795-8c11-b278f3a65970
                    level: 1
                    locationCount: 1
                    name: demo_1
                    parentFolderId: 401228fe-8ee9-4914-a08a-db7cda490ec9
                    parentFolderName: root
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660098-run
  /folders/tree:
    get:
      summary: List all folders under an account in hierarchical structure
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves a complete hierarchical tree of all active folders within an account.


        Response Includes:

        - Folder hierarchy levels (parent and nested subfolders)

        - Location count within each folder

        - Nested subfolder details for a structured view

        </span>'
      tags:
      - Organizing locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved folder tree structure
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      getFolderTree:
                        type: array
                        items:
                          $ref: '#/components/schemas/FolderNode'
                    x-apidog-orders:
                    - getFolderTree
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660114-run
  /tags:
    get:
      summary: List all tags
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves all tags associated with the authenticated account. Tags serve as labels that
        help organize and filter locations.


        **Response Includes:**

        - Tag ID (Unique identifier)

        - Tag Name (Label used for categorization)

        </span>'
      operationId: listAllTags
      tags:
      - Organizing locations
      - Tags
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved list of tags
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      listAllTags:
                        type: array
                        description: Array of tag objects
                        items:
                          type: object
                          required:
                          - id
                          - name
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: Unique identifier for the tag
                              examples:
                              - 2baeca0a-f8df-4971-9c2b-dd5013bdddb3
                            name:
                              type: string
                              description: Display name of the tag
                              examples:
                              - 13january22
                          x-apidog-orders:
                          - id
                          - name
                    x-apidog-orders:
                    - listAllTags
                x-apidog-orders:
                - data
              example:
                data:
                  listAllTags:
                  - id: 2baeca0a-f8df-4971-9c2b-dd5013bdddb3
                    name: 13january22
                  - id: 5a7f936d-83a0-4181-87b5-947f893f391b
                    name: 13janunapproved
                  - id: 0dd48e87-4e50-4a40-90eb-1db60030885b
                    name: 15dec22
                  - id: 0a6e6012-405a-4533-92d0-a75e7f9d4faa
                    name: 18jan
                  - id: e7cea330-5a50-4bcf-a591-828c108e89c4
                    name: 19apr
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized - Authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - User doesn't have permission to access tags
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660325-run
  /connected-accounts/{connectedAccountId}/connection-suggestions:
    get:
      summary: List Connection Suggestions
      deprecated: false
      description: '<span style="font-size: 14px;">


        This API retrieves all connection suggestions for a connected account. These suggestions represent
        potential matches between locations in your account and business profiles on Google My Business
        or Facebook Pages.


        **Behavior:**

        - Identifies locations in your account that closely match profiles on Google or Facebook.

        - Uses criteria like business name, address, and phone number to generate suggestions.

        - Helps streamline the linking process between your locations and external listings.

        </span>'
      operationId: listConnectionSuggestions
      tags:
      - Connected Accounts
      parameters:
      - name: connectedAccountId
        in: path
        description: ID of the connected account
        required: true
        example: ''
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        description: Page number for pagination. Defaults to 1.
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: perPage
        in: query
        description: Number of records per page. Defaults to 20.
        required: false
        schema:
          type: integer
          default: 20
          maximum: 500
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved connection suggestions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionSuggestionsResponse'
              example:
                data:
                  connectionSuggestionsForAccount:
                    pageInfo:
                      hasNextPage: false
                      hasPreviousPage: false
                      totalPages: 1
                      totalRecords: 2
                    records:
                    - accountEmail: abc@synup.com
                      accountType: GMB
                      connectedAccountId: bc818dc7-1576-4e50-a69d-c69d22103588
                      locationId: '73415'
                      locationInfo:
                        city: Lincoln
                        countryIso: US
                        countryName: United States
                        name: Stg - 24 Aug - with Store code
                        phone: '3125270491'
                        postalCode: '68502'
                        stateIso: NE
                        stateName: Nebraska
                        storeCode: update store code and address 123
                        street: 3201 South St, 17 cross#778
                        street1: null
                      matchedDataDatabaseId: 0d5e306f-0da0-46e3-929f-fd3c67ccd8cc
                      suggestedLocationInfo:
                        liveLink: null
                        locationInfo:
                          city: Lincoln
                          country: US
                          name: Stg - 24 Aug - with Store code
                          phone: (312) 527-0491
                          postalCode: '68502'
                          state: NE
                          street: '3201 South St, 17 cross, #778'
                        mainAccount: Business 1
                        mainAccountId: null
                        storeCode: null
                        subAccount: null
                        ownerRole: PRIMARY_OWNER
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13687215-run
  /connected-accounts/{connectedAccountId}/folders:
    get:
      summary: List folders under a Google account
      deprecated: false
      description: '<span style="font-size: 14px;">

        List all the folders in Google My Business for a given connected account.

        </span>


        '
      tags:
      - Connected Accounts
      parameters:
      - name: connectedAccountId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: folderName
        in: query
        description: 'Optional. Filter folders by name. If provided, returns only folders that match this
          name. Folders are also known as groups in GMB.

          eg: Downtown'
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: false
        example: application/json
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      getFoldersUnderGoogleAccount:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Name of the folder
                            locationCount:
                              type: integer
                              description: 'Number of locations in the folder

                                '
                            folderId:
                              type: string
                              description: 'Unique identifier for the folder in Google My Business (e.g.
                                "accounts/103301192460668915768")

                                '
                          required:
                          - name
                          - locationCount
                          - folderId
                          x-apidog-orders:
                          - name
                          - locationCount
                          - folderId
                    required:
                    - getFoldersUnderGoogleAccount
                    x-apidog-orders:
                    - getFoldersUnderGoogleAccount
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  getFoldersUnderGoogleAccount:
                  - name: Main Branch
                    locationCount: 5
                    folderId: accounts/103301192460668915768
                  - name: Downtown
                    locationCount: 3
                    folderId: accounts/1154433325552997863009
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19190292-run
  /reviewDetails:
    get:
      summary: List Interactions by IDs
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves multiple interactions using their unique identifiers in a single request.


        **Behavior:**

        - Supports batch retrieval for efficiency.

        - Ensures only valid interaction IDs return data.

        - Returns full interaction details, including content, platform, timestamp, and response status.


        </span>'
      operationId: listInteractionsByIds
      tags:
      - Reviews
      - Interactions
      parameters:
      - name: interactionIds
        in: query
        description: 'Array of interaction IDs to fetch.


          Must be URL encoded array of quoted UUIDs in square brackets.

          Example: `[%2258765b87-48b6-4bb5-88fa-62500842a383%22%2C%20%2280d22b99-3c57-4e50-90ca-6f38a7d43e50%22]`

          '
        required: true
        example:
        - 58765b87-48b6-4bb5-88fa-62500842a383
        - 80d22b99-3c57-4e50-90ca-6f38a7d43e50
        schema:
          type: array
          items:
            type: string
            format: uuid
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      interactionDetails:
                        type: object
                        properties:
                          interactions:
                            type: array
                            items:
                              $ref: '#/components/schemas/Interaction'
                        x-apidog-orders:
                        - interactions
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - interactionDetails
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
              example:
                data:
                  interactionDetails:
                    interactions: []
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932710-run
  /locations/{locationId}/keywords:
    get:
      summary: List Keywords
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves all keywords associated with a specific location.


        **Behavior:**

        - Returns a complete list of keywords linked to the location.

        - Includes unique keyword IDs and names.


        </span>'
      operationId: listKeywords
      tags:
      - Rankings
      - Keywords
      parameters:
      - name: locationId
        in: path
        description: Base64 encoded ID of the location to fetch keywords for
        required: true
        example: TG9jYXRpb246MjE5MjMx
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication. Must be prefixed with 'API '
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved keywords
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      keywordsByLocationId:
                        type: array
                        description: List of keywords associated with the location. Returns empty array
                          if no keywords exist.
                        items:
                          $ref: '#/components/schemas/Keyword'
                    x-apidog-orders:
                    - keywordsByLocationId
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
              examples:
                '1':
                  summary: Response with keywords
                  value:
                    data:
                      keywordsByLocationId:
                      - id: S2V5d29yZDoxOTM2ODAx
                        name: road paving
                      - id: S2V5d29yZDoxOTM2Nzk5
                        name: road building1
                '2':
                  summary: Response with no keywords
                  value:
                    data:
                      keywordsByLocationId: []
                '3':
                  summary: Invalid location Id
                  value:
                    data:
                      keywordsByLocationId: null
                    errors:
                    - message: 'SY90002: Invalid Id'
                '4':
                  summary: Invalid token
                  value:
                    data:
                      keywordsByLocationId: null
                    errors:
                    - message: 'SY90001: Not authorized to access this resource'
          headers: {}
          x-apidog-name: OK
        '400':
          description: Invalid location ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                data:
                  keywordsByLocationId: null
                errors:
                - message: 'SY90002: Invalid Id'
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                data:
                  keywordsByLocationId: null
                errors:
                - message: 'SY90001: Not authorized to access this resource'
          headers: {}
          x-apidog-name: Unauthorized
      security: []
      x-apidog-folder: Rankings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13695476-run
  /location-connections:
    get:
      summary: List location connections
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API returns a paginated list of your locations\
        \ paired with each publisher (source), along with whether that location is connected, not connected,\
        \ or has a connection issue for that publisher. It is the direct API equivalent of the <strong>Location\
        \ Connections</strong> page.\n\nFeatures:\n- Pagination support – retrieve results in batches\
        \ for efficient processing.\n- Filtering options – filter location connections by:\n    - Source\
        \ / publisher (`source`)\n    - Location id (`locationId`)\n    - Location name / address / phone\
        \ (`locationName`)\n    - Connection status (`status`)\n- Sorting – order by location info, publisher\
        \ account email, or publisher type. </span>"
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: source
        in: query
        description: 'Publisher (source) to filter by. Accepted values

          * `GoogleAccount`

          * `FacebookAccount`

          * `AppleAccount`

          * `YelpAccount`

          * `TripadvisorAccount`

          '
        required: false
        example: GoogleAccount
        schema:
          type: string
          enum:
          - GoogleAccount
          - FacebookAccount
          - AppleAccount
          - YelpAccount
          - TripadvisorAccount
      - name: locationId
        in: query
        description: Filter by one or more location ids. Accepts a raw numeric location id (e.g. `279169`)
          or a comma-separated list (e.g. `279169,279170`). Base64-encoded ids (`Location:<id>`) are also
          accepted.
        required: false
        example: '279169'
        schema:
          type: string
      - name: locationName
        in: query
        description: Free-text search across the location name, address, and phone number.
        required: false
        example: Aikido
        schema:
          type: string
      - name: status
        in: query
        description: 'Connection status to filter by.

          * `Connected` - location is connected to the source

          * `NotConnected` - location is not connected to the source

          * `ConnectionIssue` - location has a connection issue for the source

          '
        required: false
        example: NotConnected
        schema:
          type: string
          enum:
          - Connected
          - NotConnected
          - ConnectionIssue
      - name: sortField
        in: query
        description: 'Field to sort the results by.

          * `location_info`

          * `account_mail`

          * `account_type`

          '
        required: false
        example: location_info
        schema:
          type: string
          enum:
          - location_info
          - account_mail
          - account_type
      - name: sortOrder
        in: query
        description: 'Sort order. Only applied when `sortField` is provided.

          * `Ascending`

          * `Descending`

          '
        required: false
        example: Ascending
        schema:
          type: string
          enum:
          - Ascending
          - Descending
          default: Ascending
      - name: page
        in: query
        description: Page number for pagination
        required: false
        example: 1
        schema:
          type: integer
          default: 1
      - name: perPage
        in: query
        description: Number of records per page
        required: false
        example: 20
        schema:
          type: integer
          default: 20
          maximum: 100
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved location connections
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationConnectionsResponse'
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40947471-run
  /tags/locations:
    get:
      summary: List locations by tags
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves **locations associated with specified tags **and supports **pagination** for
        efficient data retrieval.


        **Features:**

        - Supports cursor-based pagination for navigating large datasets.

        - Allows filtering by archived/unarchived locations.

        - Returns detailed location information, including business details and metadata.

        </span>'
      operationId: getLocationsByTags
      tags:
      - Organizing locations
      - Tags
      - Locations
      parameters:
      - name: tags
        in: query
        description: Array of tag names to filter locations by
        required: true
        example:
        - justfortest
        schema:
          type: array
          items:
            type: string
      - name: archived
        in: query
        description: 'Filter for archived status:

          * If omitted - returns all locations

          * If false - returns only unarchived locations

          * If true - returns only archived locations

          '
        required: false
        schema:
          type: boolean
      - name: after
        in: query
        description: Cursor for pagination - fetch records after this cursor
        required: false
        schema:
          type: string
      - name: before
        in: query
        description: Cursor for pagination - fetch records before this cursor
        required: false
        schema:
          type: string
      - name: first
        in: query
        description: Number of records to fetch from the beginning
        required: false
        schema:
          type: integer
          minimum: 1
      - name: last
        in: query
        description: Number of records to fetch from the end
        required: false
        schema:
          type: integer
          minimum: 1
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved locations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      searchLocationsByTag:
                        type: object
                        properties:
                          edges:
                            type: array
                            description: Array of location edges containing cursor and node data
                            items:
                              type: object
                              properties:
                                cursor:
                                  type: string
                                  description: Pagination cursor for this location
                                node:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      description: Unique identifier for the location
                                    name:
                                      type: string
                                      description: Name of the location
                                  x-apidog-orders:
                                  - id
                                  - name
                              x-apidog-orders:
                              - cursor
                              - node
                          pageInfo:
                            type: object
                            description: Pagination metadata
                            properties:
                              hasNextPage:
                                type: boolean
                                description: Indicates if there are more results after this page
                              hasPreviousPage:
                                type: boolean
                                description: Indicates if there are more results before this page
                              total:
                                type: integer
                                description: Total number of locations matching the query
                            x-apidog-orders:
                            - hasNextPage
                            - hasPreviousPage
                            - total
                        x-apidog-orders:
                        - edges
                        - pageInfo
                    x-apidog-orders:
                    - searchLocationsByTag
                x-apidog-orders:
                - data
              example:
                data:
                  searchLocationsByTag:
                    edges:
                    - cursor: TG9jYXRpb246NzMzMzA=
                      node:
                        name: test test
                        id: TG9jYXRpb246NzMzMzA=
                    - cursor: TG9jYXRpb246NzMzMTI=
                      node:
                        name: Bombay Cocktail Bar
                        id: TG9jYXRpb246NzMzMTI=
                    pageInfo:
                      hasNextPage: false
                      hasPreviousPage: false
                      total: 3
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660360-run
  /folder-locations:
    get:
      summary: List locations under a folder
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API retrieves all locations within a specified\
        \ folder and its subfolders.\n    \n**Response Includes:**\n- Business details (name, category,\
        \ address)\n- Contact information (phone, email, website)\n- Metadata (tags, attributes, custom\
        \ fields)\n    \n\n:::info[]\n<span style=\"font-size: 14px;\">\nNote: Either folderId or folderName\
        \ must be provided.\n</span>\n:::\n</span>"
      operationId: getFolderLocations
      tags:
      - Organizing locations
      - Folders
      parameters:
      - name: folderName
        in: query
        description: Name of the folder to fetch locations from
        required: false
        example: franchise
        schema:
          type: string
      - name: folderId
        in: query
        description: Unique identifier of the folder
        required: false
        example: 67049f29-3bc6-4e82-875b-02159b4b1fea
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved locations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      getLocationsForFolder:
                        type: array
                        items:
                          type: object
                          properties: {}
                          x-apidog-orders:
                          - 01JK3S0YX6D61ASSK4JN9PSGT4
                          x-apidog-refs:
                            01JK3S0YX6D61ASSK4JN9PSGT4:
                              type: object
                              properties: {}
                          x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - getLocationsForFolder
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
        '403':
          description: Unauthorized - insufficient permissions to access folder
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Folder not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660305-run
  /locations-by-ids:
    get:
      summary: List particular locations
      deprecated: false
      description: "<br>\n<span style=\"font-size: 14px;\">\nThis API retrieves **detailed information**\
        \ for one or more **specified location IDs**. \n\nIt provides comprehensive data about each location,\
        \ including its name, address, contact details, business hours, categories, nedia and other relevant\
        \ attributes. \nIt support for both active and archived locations.\n</span>"
      operationId: getLocationsByIds
      tags:
      - Locations
      parameters:
      - name: ids
        in: query
        description: 'Array of location IDs in JSON string format.


          '
        required: true
        example:
        - '["TG9jYXRpb246MQ==", "TG9jYXRpb246Mg=="]'
        schema:
          type: array
          items:
            type: string
          uniqueItems: true
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      getLocationsByIds:
                        type: array
                        items:
                          type: object
                          properties:
                            accountId:
                              type: integer
                            addOns:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                x-apidog-orders:
                                - id
                                - name
                            additionalCategoryIds:
                              type: array
                              items:
                                type: integer
                            additionalCategoryNames:
                              type: array
                              items:
                                type: string
                            additionalInfo:
                              type: 'null'
                            additionalPhones:
                              type: array
                              items:
                                type: string
                            approved:
                              type: string
                            archivalScheduledAt:
                              type: 'null'
                            archived:
                              type: boolean
                            archivedAt:
                              type: 'null'
                            bizUrl:
                              type: string
                            bizUrlUtm:
                              type: boolean
                            bookingUrl:
                              type: 'null'
                            businessHours:
                              type: array
                              items:
                                type: object
                                properties:
                                  day:
                                    type: string
                                  slots:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        end:
                                          type: string
                                        start:
                                          type: string
                                      required:
                                      - end
                                      - start
                                      x-apidog-orders:
                                      - end
                                      - start
                                    nullable: true
                                  specialDate:
                                    type: 'null'
                                  type:
                                    type: string
                                required:
                                - day
                                - slots
                                - specialDate
                                - type
                                x-apidog-orders:
                                - day
                                - slots
                                - specialDate
                                - type
                            cancellationScheduledAt:
                              type: 'null'
                            categoryId:
                              type: integer
                            city:
                              type: string
                            contentPreferredLanguage:
                              type: string
                            countryCode:
                              type: string
                            countryIso:
                              type: string
                            createErrors:
                              type: array
                              items:
                                type: string
                            createdDate:
                              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
                                required:
                                - archived
                                - enumValues
                                - name
                                - slug
                                - type
                                - value
                                x-apidog-orders:
                                - archived
                                - enumValues
                                - name
                                - slug
                                - type
                                - value
                            databaseId:
                              type: integer
                            description:
                              type: string
                            enabledSiteIds:
                              type: array
                              items:
                                type: string
                            facebookUrl:
                              type: string
                            folderId:
                              type: string
                            folderName:
                              type: string
                            franchise:
                              type: 'null'
                            googleAdsPhone:
                              type: string
                            googleVerificationStatus:
                              type: object
                              properties:
                                message:
                                  type: 'null'
                                status:
                                  type: 'null'
                              required:
                              - message
                              - status
                              x-apidog-orders:
                              - message
                              - status
                            googleplusUrl:
                              type: 'null'
                            hideAddress:
                              type: boolean
                            id:
                              type: string
                            instagramUrl:
                              type: string
                            isRestaurant:
                              type: boolean
                            lastUpdatedDate:
                              type: string
                            latitude:
                              type: string
                            linkedinUrl:
                              type: string
                            locationPhotos:
                              type: array
                              items:
                                type: string
                            longitude:
                              type: string
                            managedServiceSiteBuckets:
                              type: array
                              items:
                                type: string
                            managedServiceSites:
                              type: array
                              items:
                                type: string
                            moreHours:
                              type: array
                              items:
                                type: string
                            name:
                              type: string
                            offeringsUrl:
                              type: 'null'
                            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: 'null'
                            postalCode:
                              type: string
                            publisherAttributes:
                              type: array
                              items:
                                type: string
                            reservationUrl:
                              type: 'null'
                            serviceItems:
                              type: array
                              items:
                                type: string
                            stateIso:
                              type: string
                            stateName:
                              type: string
                            storeId:
                              type: string
                            street:
                              type: string
                            street1:
                              type: 'null'
                            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
                            uid:
                              type: string
                            updatedAt:
                              type: string
                            videos:
                              type: array
                              items:
                                type: string
                            voiceStatus:
                              type: integer
                            yearOfIncorporation:
                              type: integer
                            youtubeUrl:
                              type: 'null'
                            placeActionLinks:
                              type: array
                              items:
                                type: object
                                properties:
                                  placeActionType:
                                    type: string
                                  uri:
                                    type: string
                                  isPreferred:
                                    type: boolean
                                  name:
                                    type: string
                                  submissionStatus:
                                    type: string
                                  submissionMessage:
                                    type: string
                                  lastSubmittedAt:
                                    type: string
                                x-apidog-orders:
                                - placeActionType
                                - uri
                                - isPreferred
                                - name
                                - submissionStatus
                                - submissionMessage
                                - lastSubmittedAt
                                required:
                                - placeActionType
                                - uri
                            discoveredPlaceActionLinks:
                              type: array
                              items:
                                type: object
                                properties:
                                  placeActionType:
                                    type: string
                                  uri:
                                    type: string
                                  isPreferred:
                                    type: string
                                  name:
                                    type: string
                                  providerType:
                                    type: string
                                  isEditable:
                                    type: string
                                x-apidog-orders:
                                - placeActionType
                                - uri
                                - isPreferred
                                - name
                                - providerType
                                - isEditable
                                required:
                                - placeActionType
                                - uri
                                - name
                                - isEditable
                                - providerType
                                - isPreferred
                          x-apidog-orders:
                          - accountId
                          - addOns
                          - additionalCategoryIds
                          - additionalCategoryNames
                          - additionalInfo
                          - additionalPhones
                          - approved
                          - archivalScheduledAt
                          - archived
                          - archivedAt
                          - bizUrl
                          - bizUrlUtm
                          - bookingUrl
                          - businessHours
                          - cancellationScheduledAt
                          - categoryId
                          - city
                          - contentPreferredLanguage
                          - countryCode
                          - countryIso
                          - createErrors
                          - createdDate
                          - customAttributes
                          - databaseId
                          - description
                          - enabledSiteIds
                          - facebookUrl
                          - folderId
                          - folderName
                          - franchise
                          - googleAdsPhone
                          - googleVerificationStatus
                          - googleplusUrl
                          - hideAddress
                          - id
                          - instagramUrl
                          - isRestaurant
                          - lastUpdatedDate
                          - latitude
                          - linkedinUrl
                          - locationPhotos
                          - longitude
                          - managedServiceSiteBuckets
                          - managedServiceSites
                          - moreHours
                          - name
                          - offeringsUrl
                          - ownerEmail
                          - ownerName
                          - package
                          - paymentMethods
                          - phone
                          - pinterestUrl
                          - planId
                          - planName
                          - postalCode
                          - publisherAttributes
                          - reservationUrl
                          - serviceItems
                          - stateIso
                          - stateName
                          - storeId
                          - street
                          - street1
                          - subCategoryId
                          - subCategoryName
                          - tagline
                          - tags
                          - temporarilyClosed
                          - tiktokUrl
                          - toplineMessage
                          - toplineMessageText
                          - twitterUrl
                          - uid
                          - updatedAt
                          - videos
                          - voiceStatus
                          - yearOfIncorporation
                          - youtubeUrl
                          - placeActionLinks
                          - discoveredPlaceActionLinks
                    required:
                    - getLocationsByIds
                    x-apidog-orders:
                    - getLocationsByIds
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  getLocationsByIds:
                  - accountId: 11073
                    addOns:
                    - id: '1'
                      name: Yelp Lite
                    additionalCategoryIds:
                    - 609
                    additionalCategoryNames:
                    - Framing
                    additionalInfo: null
                    additionalPhones:
                    - '6036610058'
                    approved: APPROVED
                    archivalScheduledAt: null
                    archived: false
                    archivedAt: null
                    bizUrl: www.easports222.com
                    bizUrlUtm: false
                    bookingUrl: null
                    businessHours:
                    - day: SUNDAY
                      slots: null
                      specialDate: null
                      type: CLOSED
                    - day: MONDAY
                      slots:
                      - end: 05:00pm
                        start: 09:00am
                      specialDate: null
                      type: OPEN
                    - day: TUESDAY
                      slots:
                      - end: 01:00pm
                        start: 09:00am
                      - end: 05:00pm
                        start: 02:00pm
                      specialDate: null
                      type: OPEN
                    - day: WEDNESDAY
                      slots: null
                      specialDate: null
                      type: OPEN_24x7
                    - day: THURSDAY
                      slots: null
                      specialDate: null
                      type: OPEN_24x7
                    - day: FRIDAY
                      slots: null
                      specialDate: null
                      type: CLOSED
                    - day: SATURDAY
                      slots: null
                      specialDate: null
                      type: CLOSED
                    cancellationScheduledAt: null
                    categoryId: 1
                    city: New York
                    contentPreferredLanguage: ENGLISH
                    countryCode: '1'
                    countryIso: US
                    createErrors: []
                    createdDate: December 15, 2025
                    customAttributes:
                    - archived: false
                      enumValues: []
                      name: Atributo
                      slug: atributo
                      type: STRING
                      value: []
                    - archived: false
                      enumValues: []
                      name: offers_online_appointments
                      slug: offers_online_appointments
                      type: BOOLEAN
                      value:
                      - 'false'
                    - archived: false
                      enumValues: []
                      name: welcomes_lgbtq
                      slug: welcomes_lgbtq
                      type: BOOLEAN
                      value:
                      - 'true'
                    - archived: false
                      enumValues: []
                      name: has wheelchair
                      slug: has_wheelchair
                      type: BOOLEAN
                      value: []
                    - archived: false
                      enumValues: []
                      name: utm
                      slug: utm
                      type: STRING
                      value: []
                    - archived: false
                      enumValues: []
                      name: Slug
                      slug: slug
                      type: STRING
                      value: []
                    - archived: false
                      enumValues: []
                      name: Name
                      slug: name
                      type: STRING
                      value: []
                    - archived: false
                      enumValues: []
                      name: accept digital rupee
                      slug: accept_digital_rupee
                      type: INTEGER
                      value: []
                    - archived: false
                      enumValues: []
                      name: has_onsite_parking
                      slug: has_onsite_parking
                      type: BOOLEAN
                      value: []
                    - archived: false
                      enumValues: []
                      name: Test 23
                      slug: test_23
                      type: STRING
                      value: []
                    - archived: false
                      enumValues: []
                      name: lead_photo_drive
                      slug: lead_photo_drive
                      type: STRING
                      value: []
                    - archived: false
                      enumValues: []
                      name: Test French Locale 4
                      slug: test_french_locale_4
                      type: STRING
                      value: []
                    databaseId: 88350
                    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
                      tempor. This is a sample description which is used to complete the 200 characters.
                      Let us believe this has exceeded the character limit otherwise it is going to be
                      a headache to go and change it again. But still to be on the careful side, I am
                      adding a few more line of characters because of which this is going to work.
                    enabledSiteIds: []
                    facebookUrl: https://www.facebook.com/journeywithanthony/
                    folderId: 57e34303-e9fd-422d-ad39-383849df7ea9
                    folderName: hello12341
                    franchise: null
                    googleAdsPhone: '8289989989'
                    googleVerificationStatus:
                      message: null
                      status: null
                    googleplusUrl: null
                    hideAddress: false
                    id: TG9jYXRpb246ODgzNTA=
                    instagramUrl: https://www.instagram.com/rajinikanth/
                    isRestaurant: false
                    lastUpdatedDate: December 15, 2025
                    latitude: '40.712775'
                    linkedinUrl: https://www.linkedin.com/company/synup/
                    locationPhotos: []
                    longitude: '-74.005973'
                    managedServiceSiteBuckets: []
                    managedServiceSites: []
                    moreHours: []
                    name: Spinka Group
                    offeringsUrl: null
                    ownerEmail: pttqa1+212@gmail.com
                    ownerName: John Doe
                    package: PREMIUM
                    paymentMethods:
                    - VISA
                    - MASTERCARD
                    - AMEX
                    - CASH
                    - CHEQUE
                    - CRYPTO
                    - DINERS_CLUB
                    - DISCOVER
                    - FINANCING
                    - INVOICE
                    - TRAVELERS_CHECK
                    - APPLE_PAY
                    - SAMSUNG_PAY
                    - PAYPAL
                    - ANDROID_PAY
                    phone: '6036610058'
                    pinterestUrl: https://pinterest.com/cozylivin77/
                    planId: 59
                    planName: null
                    postalCode: '60605'
                    publisherAttributes: []
                    reservationUrl: null
                    serviceItems: []
                    stateIso: NY
                    stateName: New York
                    storeId: 995si
                    street: 123 Jump Street
                    street1: null
                    subCategoryId: 20
                    subCategoryName: Pilates
                    tagline: We Exist
                    tags:
                    - all
                    - pk
                    temporarilyClosed: false
                    tiktokUrl: null
                    toplineMessage: null
                    toplineMessageText: null
                    twitterUrl: https://twitter.com/elonmusk
                    uid: 0afc0561-04e0-4e72-b679-318310c1a8f1
                    updatedAt: '2025-12-15T10:06:47.776Z'
                    videos:
                    - https://www.youtube.com/watch?v=QKmrDUJFRkM
                    voiceStatus: 1
                    yearOfIncorporation: 1179
                    youtubeUrl: null
                    placeActionLinks:
                    - placeActionType: FOOD_ORDERING
                      uri: https://order.example.com
                      isPreferred: true
                      name: locations/1944.../placeActionLinks/54ada85bc246058a
                      submissionStatus: success
                      submissionMessage: Already up to date on Google.
                      lastSubmittedAt: '2026-07-08T12:14:36Z'
                    discoveredPlaceActionLinks:
                    - placeActionType: APPOINTMENT
                      uri: https://book.example.com
                      isPreferred: false
                      name: locations/1944.../placeActionLinks/abc123
                      providerType: MERCHANT
                      isEditable: true
          headers: {}
          x-apidog-name: Success response
        '400':
          description: Bad request - Invalid location IDs format
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '404':
          description: One or more location IDs not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13646679-run
  /locations/review-campaigns/{reviewCampaignId}/customers:
    get:
      summary: List review campaign customers
      deprecated: false
      description: '<span style="font-size: 14px;">

        Retrieves a list of customers associated with a specific review campaign, along with their response
        status.


        **Behavior:**

        - Returns customer details, including name, email/phone, and response status.

        - Indicates whether a review was submitted, ignored, or pending.

        - Supports filtering by response type (e.g., responded, not responded).

        </span>'
      operationId: listReviewCampaignCustomers
      tags:
      - Review Campaigns
      parameters:
      - name: reviewCampaignId
        in: path
        description: Review campaign ID to list customers for
        required: true
        example: 3e0d82f7-054e-48cb-ab66-3f75306f1ee6
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewCampaignCustomersResponse'
              example:
                data:
                  reviewCampaignInfo:
                    campaignName: Joe
                    reviewCampaignCustomers:
                    - name: Jack
                      phone: '9876543210'
                      email: jack@domain.com
                      rating: 5
                      response: Great Service provided
                      date: '2018-04-12'
                      followUpSent: 2
                      smsDeliveredAt: '2018-04-04 01:00:12'
                      smsOpenedAt: '2018-04-04 01:00:57'
                      emailDeliveredAt: '2018-04-04 01:00:12'
                      emailLastOpenedAt: '2018-04-04 01:00:57'
                      emailLastClickedAt: '2018-04-04 01:00:57'
                      firstFollowUpAt: '2018-04-07 18:34:06'
                      firstFollowUpDeliveredAt: '2018-04-08 20:34:06'
                      secondFollowUpAt: '2018-04-10 18:34:06'
                      secondFollowUpDeliveredAt: '2018-04-11 18:34:06'
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Review Campaigns
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-14026088-run
  /locations/{locationId}/review-campaigns:
    get:
      summary: List review campaigns
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves a list of review campaigns associated with a specific location.


        **Behavior:**

        - Returns campaign details, including campaign ID, name, status, start date, and delivery method.

        - Supports pagination for large datasets.

        - Allows filtering by campaign status (active, completed, scheduled).



        </span>

        '
      operationId: listReviewCampaigns
      tags:
      - Review Campaigns
      parameters:
      - name: locationId
        in: path
        description: Location ID to list review campaigns for
        required: true
        example: TG9jYXRpb246MTQwMjQ=
        schema:
          type: string
      - name: startDate
        in: query
        description: Start date of a date range to get review campaigns
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: End date of a date range to get review campaigns
        required: false
        schema:
          type: string
          format: date
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewCampaignsResponse'
              example:
                data:
                  listReviewCampaigns:
                    reviewCampaigns:
                    - id: 126dc120-acea-4bcb-8a83-74c80f6f807d
                      locationId: TG9jYXRpb246MTQwMjQ=
                      name: Christmas Sale Feedback
                      screening: false
                      createdAt: '2019-01-21T04:29:49Z'
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Review Campaigns
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-14026077-run
  /api/v4/users/{userId}/resources:
    get:
      summary: List User Resources
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n    \nThis API retrieves a list of all resources\
        \ (folders and locations) associated with a user.\n\nIt includes:\n- Folders the user has access\
        \ to.\n- Locations assigned to the user.\n- Access levels for each resource.\n\n\n</span>"
      tags:
      - User Management
      - User Management
      parameters:
      - name: userId
        in: path
        description: Base64 encoded user ID
        required: true
        example: VXNlcjoxNTUzNjE=
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved user resources
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      listUserResources:
                        type: array
                        items:
                          type: object
                          required:
                          - id
                          - name
                          - __typename
                          properties:
                            id:
                              type: string
                              description: Resource identifier (UUID format for folders, Base64 encoded
                                for locations)
                            name:
                              type: string
                              description: Name of the resource
                            __typename:
                              type: string
                              enum:
                              - Folder
                              - LocationSummary
                              description: Type discriminator for the resource
                          x-apidog-orders:
                          - id
                          - name
                          - __typename
                    x-apidog-orders:
                    - listUserResources
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: default
                  value:
                    data:
                      listUserResources:
                      - id: a5af4f5d-41b6-4a8a-b24f-98741b021b7b
                        name: automation_folder_1212
                        __typename: Folder
                      - id: c1d92c09-8ddd-469e-af96-0eb64a48d647
                        name: automation_folder_133
                        __typename: Folder
                      - id: 67049f29-3bc6-4e82-875b-02159b4b1fea
                        name: root
                        __typename: Folder
                      - id: TG9jYXRpb246NDA5ODE=
                        name: One Tag
                        __typename: LocationSummary
                      - id: TG9jYXRpb246NDI1ODg=
                        name: Hayward Appliances2
                        __typename: LocationSummary
                '2':
                  summary: alternative
                  value:
                    data:
                      listUserResources:
                      - id: 891861cd-9a59-4b42-8a17-3b916b8e4296
                        name: automation_folder_5602
                        __typename: Folder
                      - id: TG9jYXRpb246NDk3MjQ4
                        name: test loc canada
                        __typename: LocationSummary
                      - id: TG9jYXRpb246NDk3Nzk3
                        name: Deckow - Collier
                        __typename: LocationSummary
                      - id: TG9jYXRpb246NDk3MjQ3
                        name: test location australia
                        __typename: LocationSummary
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13994825-run
  /roles:
    get:
      summary: List User Roles
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves a list of all available user roles in the system.


        It includes:


        - Role names (e.g., Admin, Manager, Viewer)

        - Permissions associated with each role

        - Role IDs for assignment and management

        </span>'
      operationId: listUserRoles
      tags:
      - User Management
      - User Roles
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved user roles
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      fetchAccountRoles:
                        type: array
                        items:
                          $ref: '#/components/schemas/UserRole'
                    x-apidog-orders:
                    - fetchAccountRoles
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
              example:
                data:
                  fetchAccountRoles:
                  - id: Q3VzdG9tUm9sZToxODE3NzY=
                    name: Approval
                    createdAt: 2025-01-21 19:05:43 UTC
                    updatedAt: 2025-01-21 19:07:13 UTC
                  - id: Q3VzdG9tUm9sZTo0NDUyMg==
                    name: Admin
                    createdAt: 2020-02-12 07:27:46 UTC
                    updatedAt: 2025-01-22 15:24:13 UTC
                  - id: Q3VzdG9tUm9sZTo0NTI5MQ==
                    name: Corporate Role
                    createdAt: 2020-02-12 07:28:05 UTC
                    updatedAt: 2025-01-15 06:16:29 UTC
                  pagination:
                    $ref: '#/components/schemas/Pagination'
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized - Authentication required
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13933011-run
  /users:
    get:
      summary: List Users
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n    \nThis API retrieves a paginated list of all\
        \ users in the system.\n\n**Pagination:**\n- Uses cursor-based pagination for efficient data retrieval.\n\
        - Returns up to 50 users per request.\n- Includes pageInfo for navigating through results.\n</span>\n"
      operationId: listUsers
      tags:
      - User Management
      - Users
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersResponse'
              example:
                data:
                  users:
                    totalCount: 342
                    pageInfo:
                      hasNextPage: true
                      hasPreviousPage: false
                      total: 50
                      endCursor: VXNlcjoxNDYyNTM=
                    edges:
                    - cursor: VXNlcjoxNjUzNjA=
                      node:
                        id: VXNlcjoxNjUzNjA=
                        email: user@example.com
                        firstName: John
                        lastName: Doe
                        customRole:
                          id: Q3VzdG9tUm9sZTo1OTE5
                          name: District Manager(Read)
                        directCustomer: true
                        createdAt: 2025-02-03 10:25:44 UTC
                        inviteStatus: ACTIVE
          headers: {}
          x-apidog-name: OK
        '401':
          description: Unauthorized - Valid API key required
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions to list users
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932639-run
  /users-by-ids:
    get:
      summary: List Users by ID
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API retrieves user details for one or more specified user IDs in a single request.


        **Behavior:**

        - Supports fetching multiple users by providing a list of user IDs.

        - Returns detailed user information, including role, status, and attributes.

        </span>'
      operationId: listUsersByIds
      tags:
      - User Management
      - Users
      parameters:
      - name: userIds
        in: query
        description: Array of user IDs to fetch details for
        required: true
        schema:
          type: array
          items:
            type: string
          examples:
          - - VXNlcjoxNjUzNjA=
            - VXNlcjoxNjUyMDY=
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved user details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersByIdsResponse'
              example:
                data:
                  usersByIds:
                  - id: VXNlcjoxNjUyMDY=
                    firstName: user
                    lastName: user
                    email: subasrisridhar879+1@gmail.com
                    customRole:
                      id: Q3VzdG9tUm9sZTo0NDUyMg==
                      name: Admin
                    directCustomer: true
                    createdAt: 2025-02-02 06:57:41 UTC
                    inviteStatus: RESEND_INVITE
                    preferences:
                      locale: en-US
                      dateFormat: null
                      timezone: null
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request - Invalid user IDs format
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Valid API key required
          headers: {}
          x-apidog-name: Unauthorized
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932648-run
  /local-post-ideas/active-chat-session:
    get:
      summary: Local active chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the currently active AI post-idea chat session for a location, if one exists. Use this
        to resume an in-progress conversation. Set `excludeSeries` to skip sessions that belong to a content
        series.

        </span>'
      operationId: localActiveChatSession
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: excludeSeries
        in: query
        description: Exclude sessions that belong to a content series.
        required: false
        example: ''
        schema:
          type: boolean
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localActiveChatSession:
                        $ref: '#/components/schemas/LocalChatSession'
                    x-apidog-orders:
                    - localActiveChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052193-run
  /local-post-ideas/calendar:
    get:
      summary: Local calendar
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the content calendar for a location — each day with its scheduled/suggested post ideas.

        </span>'
      operationId: localCalendar
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localCalendar:
                        type: array
                        items:
                          $ref: '#/components/schemas/LocalCalendarDay'
                    x-apidog-orders:
                    - localCalendar
                    x--orders:
                    - localCalendar
                    x--ignore-properties: []
                x-apidog-orders:
                - data
                x--orders:
                - data
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052194-run
  /local-post-ideas/chat-history:
    get:
      summary: Local chat history
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the messages for a given AI post-idea chat session, in sequence. Use `limit` to cap the
        number of messages returned.

        </span>'
      operationId: localChatHistory
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: sessionId
        in: query
        description: Chat session ID.
        required: true
        example: 7f3c1a2e-...
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of messages to return.
        required: false
        example: 50
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localChatHistory:
                        type: array
                        items:
                          $ref: '#/components/schemas/LocalChatMessage'
                    x-apidog-orders:
                    - localChatHistory
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052196-run
  /local-post-ideas/chat-sessions:
    get:
      summary: Local chat sessions
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the AI post-idea chat sessions for a location, most recent first. Use `limit` to cap the
        number of sessions returned.

        </span>'
      operationId: localChatSessions
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of sessions to return.
        required: false
        example: 20
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localChatSessions:
                        type: array
                        items:
                          $ref: '#/components/schemas/LocalChatSession'
                    x-apidog-orders:
                    - localChatSessions
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052241-run
  /local-post-ideas/content-series-detail:
    get:
      summary: Local content series detail
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns a single content series by ID, including its posts, theme, status, and post counts.

        </span>'
      operationId: localContentSeriesDetail
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: seriesId
        in: query
        description: ID of the content series.
        required: true
        example: 3a1f...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localContentSeriesDetail:
                        $ref: '#/components/schemas/LocalContentSeries'
                    x-apidog-orders:
                    - localContentSeriesDetail
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052244-run
  /local-post-ideas/content-series-list:
    get:
      summary: Local content series list
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the content series for a location — multi-post campaigns with a shared theme, including
        post counts and status.

        </span>'
      operationId: localContentSeriesList
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localContentSeriesList:
                        type: array
                        items:
                          $ref: '#/components/schemas/LocalContentSeries'
                    x-apidog-orders:
                    - localContentSeriesList
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052297-run
  /local-post-ideas/extended-config:
    get:
      summary: Local extended config
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the extended generation config for a location — brand tone, target customers, contact/address,
        brand colors and logos, and the services/products/content-rules used to ground post-idea generation.

        </span>'
      operationId: localExtendedConfig
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localExtendedConfig:
                        $ref: '#/components/schemas/ExtendedLocationConfig'
                    x-apidog-orders:
                    - localExtendedConfig
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052300-run
  /local-post-ideas/holiday-idea-variants:
    get:
      summary: Local holiday idea variants
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the generated post-idea variants for a given observance/holiday at a location. Each item
        is a post idea (see Local post idea for the full shape).

        </span>'
      operationId: localHolidayIdeaVariants
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: observanceName
        in: query
        description: Name of the observance/holiday.
        required: true
        example: Mother's Day
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localHolidayIdeaVariants:
                        type: array
                        description: Post ideas (see Local post idea for the full shape).
                        items:
                          type: object
                          x-apidog-orders: []
                    x-apidog-orders:
                    - localHolidayIdeaVariants
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052301-run
  /local-post-ideas/idea-job-status:
    get:
      summary: Local idea job status
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the async job status for a post idea (used to poll image generation) — the current status
        and, when ready, the generated image URL.

        </span>'
      operationId: localIdeaJobStatus
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: ideaId
        in: query
        description: ID of the post idea.
        required: true
        example: 91b2...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localIdeaJobStatus:
                        $ref: '#/components/schemas/LocalIdeaJobStatus'
                    x-apidog-orders:
                    - localIdeaJobStatus
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052552-run
  /local-post-ideas/image-credits:
    get:
      summary: Local image credits
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the image-generation credit status for a location — monthly limit, used/remaining this
        month, and any add-on credit pool.

        </span>'
      operationId: localImageCredits
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localImageCredits:
                        $ref: '#/components/schemas/LocalImageCredits'
                    x-apidog-orders:
                    - localImageCredits
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052720-run
  /local-post-ideas/location-info:
    get:
      summary: Local location info
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the basic location profile used by post-idea generation — name, site URL, categories,
        and contact/address details.

        </span>'
      operationId: localLocationInfo
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localLocationInfo:
                        $ref: '#/components/schemas/LocalLocationInfo'
                    x-apidog-orders:
                    - localLocationInfo
                    x--orders:
                    - localLocationInfo
                    x--ignore-properties: []
                x-apidog-orders:
                - data
                x--orders:
                - data
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052818-run
  /local-post-ideas/observances:
    get:
      summary: Local observances
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the observances (holidays, awareness days, etc.) for a given month, optionally narrowed
        to a specific day of the month.

        </span>'
      operationId: localObservances
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: month
        in: query
        description: Month number (1-12).
        required: true
        example: 5
        schema:
          type: integer
      - name: date
        in: query
        description: Day of the month to narrow to.
        required: false
        example: 0
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localObservances:
                        type: array
                        items:
                          $ref: '#/components/schemas/LocalObservance'
                    x-apidog-orders:
                    - localObservances
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052821-run
  /local-post-ideas/observances-with-ideas:
    get:
      summary: Local observances with ideas
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the observances for a month for a location, each joined with its generated post idea (if
        any) — including whether ideas are ready and the idea''s title/content/image.

        </span>'
      operationId: localObservancesWithIdeas
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: month
        in: query
        description: Month number (1-12).
        required: true
        example: 5
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localObservancesWithIdeas:
                        type: array
                        items:
                          $ref: '#/components/schemas/LocalObservanceWithIdea'
                    x-apidog-orders:
                    - localObservancesWithIdeas
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052823-run
  /local-post-ideas/pipeline-status:
    get:
      summary: Local pipeline status
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the status of the post-idea generation pipeline for a location — current step, steps completed/remaining,
        and any error.

        </span>'
      operationId: localPipelineStatus
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localPipelineStatus:
                        $ref: '#/components/schemas/LocalPipelineStatus'
                    x-apidog-orders:
                    - localPipelineStatus
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052824-run
  /local-post-ideas/post-idea:
    get:
      summary: Local post idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns a single AI post idea by its ID, including its content, image, scheduling, call-to-action,
        and generation metadata.

        </span>'
      operationId: localPostIdea
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: ideaId
        in: query
        description: ID of the post idea.
        required: true
        example: 91b2...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localPostIdea:
                        $ref: '#/components/schemas/LocalPostIdea'
                    x-apidog-orders:
                    - localPostIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40052825-run
  /local-post-ideas/post-idea-counts:
    get:
      summary: Local post idea counts
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns post-idea counts for a location, broken down by bucket: AI- generated (`ai`), user-created
        (`mine`), series (`series`), and the total (`all`).

        </span>'
      operationId: localPostIdeaCounts
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localPostIdeaCounts:
                        $ref: '#/components/schemas/PostIdeaCounts'
                    x-apidog-orders:
                    - localPostIdeaCounts
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053202-run
  /local-post-ideas/post-ideas:
    get:
      summary: Local post ideas
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the AI post ideas for a location. Filter by `bucket` (e.g. idea, calendar, series) and
        `filter` (e.g. ai vs mine), and page with `limit`/`offset`.

        </span>'
      operationId: localPostIdeas
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: bucket
        in: query
        description: Bucket to filter by (e.g. idea, calendar, series). Defaults to idea.
        required: false
        example: ''
        schema:
          type: string
      - name: filter
        in: query
        description: Source filter (e.g. ai or mine).
        required: false
        example: ''
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of ideas to return.
        required: false
        example: 12
        schema:
          type: integer
      - name: offset
        in: query
        description: Number of ideas to skip.
        required: false
        example: 0
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localPostIdeas:
                        type: array
                        items:
                          $ref: '#/components/schemas/LocalPostIdea'
                    x-apidog-orders:
                    - localPostIdeas
                    x--orders:
                    - localPostIdeas
                    x--ignore-properties: []
                x-apidog-orders:
                - data
                x--orders:
                - data
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053207-run
  /local-post-ideas/reference-images:
    get:
      summary: Local reference images
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the available reference image options for a location — images that can be used to ground
        post-idea image generation.

        </span>'
      operationId: localReferenceImages
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localReferenceImages:
                        type: array
                        items:
                          $ref: '#/components/schemas/ReferenceImageOption'
                    x-apidog-orders:
                    - localReferenceImages
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053209-run
  /local-post-ideas/scraped-context:
    get:
      summary: Local scraped context
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the context scraped from the location''s website that grounds post-idea generation — business
        name/description, services, products, pricing, brand colors/logo, tone, and target customers.

        </span>'
      operationId: localScrapedContext
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: locationId
        in: query
        description: Relay-encoded location ID.
        required: true
        example: TG9jYXRpb246MQ==
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      localScrapedContext:
                        $ref: '#/components/schemas/ScrapedLocationContext'
                    x-apidog-orders:
                    - localScrapedContext
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053257-run
  /locations/add-on-count:
    get:
      summary: Location add-on count
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Returns how many locations in the filtered set have the specified add-on enabled vs disabled,
        along with counts for other add-ons in the same product umbrella. Scope the set with `filterInput`/`selectionType`/`locationIds`,
        identical to Filter locations.

        </span>'
      operationId: locationAddOnCount
      tags:
      - Locations
      - Locations
      parameters:
      - name: addOnId
        in: query
        description: ID of the add-on to count enablement for.
        required: true
        example: QWRkT246MTIz
        schema:
          type: string
      - name: filterInput
        in: query
        description: JSON-encoded filter object. Defaults to an empty filter (all locations).
        required: false
        example: '{}'
        schema:
          type: string
      - name: selectionType
        in: query
        description: Whether to include all matching locations or an explicit selection.
        required: false
        example: ALL_ITEMS
        schema:
          type: string
          enum:
          - ALL_ITEMS
          - SELECTED_ITEMS
      - name: locationIds
        in: query
        description: Location IDs to include when selectionType is SELECTED_ITEMS.
        required: false
        example: ''
        schema:
          type: array
          items:
            type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      locationAddOnCount:
                        $ref: '#/components/schemas/LocationAddOnCount'
                    x-apidog-orders:
                    - locationAddOnCount
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051647-run
  /locations/{locationId}/indexing-rate:
    get:
      summary: Location Indexing Rate
      deprecated: false
      description: ''
      tags:
      - Locations
      parameters:
      - name: locationId
        in: path
        description: ''
        required: true
        example: TG9jYXRpb246MTE1NTQxMw==
        schema:
          type: string
      - name: fromDate
        in: query
        description: ''
        required: true
        example: '2019-05-20'
        schema:
          type: string
      - name: toDate
        in: query
        description: ''
        required: true
        example: '2025-10-20'
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API qgl5Ri2YH7x7LA0cufuH8vGd6E0
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Locations
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-21817244-run
  /locations/package-count:
    get:
      summary: Location package count
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        Returns the number of locations in the filtered set by package tier — freemium vs premium. Scope
        the set with `filterInput`/`selectionType`/`locationIds`, identical to Filter locations.

        </span>'
      operationId: locationPackageCount
      tags:
      - Locations
      - Locations
      parameters:
      - name: filterInput
        in: query
        description: JSON-encoded filter object. Defaults to an empty filter (all locations).
        required: false
        example: '{}'
        schema:
          type: string
      - name: selectionType
        in: query
        description: Whether to include all matching locations or an explicit selection.
        required: false
        example: ALL_ITEMS
        schema:
          type: string
          enum:
          - ALL_ITEMS
          - SELECTED_ITEMS
      - name: locationIds
        in: query
        description: Location IDs to include when selectionType is SELECTED_ITEMS.
        required: false
        example: ''
        schema:
          type: array
          items:
            type: string
      - name: archived
        in: query
        description: Filter by archived state (true/false).
        required: false
        example: ''
        schema:
          type: boolean
      - name: approved
        in: query
        description: Filter by approved state (true/false).
        required: false
        example: ''
        schema:
          type: boolean
      - name: archivalScheduledAt
        in: query
        description: Return only locations scheduled for archival.
        required: false
        example: ''
        schema:
          type: boolean
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      locationPackageCount:
                        $ref: '#/components/schemas/LocationPackageCount'
                    x-apidog-orders:
                    - locationPackageCount
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051649-run
  /locations/listings/mark-as-duplicate:
    post:
      summary: Mark listings as duplicates
      deprecated: false
      description: '<span style="font-size: 14px;">


        This API flags one or more listings as duplicates for a specific location.


        **Behavior:**

        - Identifies listings that represent the same business but appear separately across different
        directories.

        - Helps maintain data consistency by marking duplicate entries for review or removal.

        </span>'
      operationId: markAsDuplicate
      tags:
      - Listings
      - Listings
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - locationId
                  - listingItemIds
                  properties:
                    locationId:
                      type: string
                      description: The unique identifier of the location
                    listingItemIds:
                      type: array
                      description: Array of listing IDs to mark as duplicates
                      items:
                        type: string
                  x-apidog-orders:
                  - locationId
                  - listingItemIds
              x-apidog-orders:
              - input
            example:
              input:
                locationId: TG9jYXRpb246MjcyODc2
                listingItemIds:
                - TGlzdGluZ0l0ZW06NDMzODcxMjY=
                - TGlzdGluZ0l0ZW06NDMzODcxMzE=
      responses:
        '200':
          description: Listings marked as duplicates successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      markAsDuplicate:
                        type: object
                        properties:
                          clientMutationId:
                            type: string
                            description: Optional client-provided mutation identifier
                            nullable: true
                          errors:
                            type: array
                            items:
                              type: string
                            description: Array of error messages if any occurred
                            nullable: true
                          success:
                            type: boolean
                            description: Indicates if the operation was successful
                          warnings:
                            type: array
                            items:
                              type: string
                            description: Array of warning messages if any occurred
                            nullable: true
                        x-apidog-orders:
                        - clientMutationId
                        - errors
                        - success
                        - warnings
                    x-apidog-orders:
                    - markAsDuplicate
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      markAsDuplicate:
                        clientMutationId: null
                        errors: null
                        success: true
                        warnings: null
                '2':
                  summary: invalidLocation
                  value:
                    data:
                      markAsDuplicate: null
                    errors:
                    - message: SY90002:Invalid Id
                '3':
                  summary: listingItemNotFound
                  value:
                    data:
                      markAsDuplicate: null
                    errors:
                    - message: SY00002:Listing item ID not found
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Invalid listing IDs provided
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Insufficient permissions to mark listings as duplicates
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Location or listings not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Location or listing items not found
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Listings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13672183-run
  /locations/listings/mark-as-not-duplicate:
    post:
      summary: Mark listings as not duplicates
      deprecated: false
      description: '<span style="font-size: 14px;">


        This API removes the duplicate flag from one or more listings for a specific location.


        **Behavior:**

        - Allows correction of incorrectly flagged duplicates.

        - Ensures that distinct business locations remain separately listed.

        </span>'
      operationId: markAsNotDuplicate
      tags:
      - Listings
      - Listings
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - locationId
                  - listingItemIds
                  properties:
                    locationId:
                      type: string
                      description: The unique identifier of the location
                    listingItemIds:
                      type: array
                      description: Array of listing IDs to mark as not duplicates
                      items:
                        type: string
                  x-apidog-orders:
                  - locationId
                  - listingItemIds
              x-apidog-orders:
              - input
            example:
              input:
                locationId: TG9jYXRpb246MjcyODc2
                listingItemIds:
                - TGlzdGluZ0l0ZW06NDMzODcxMjY=
                - TGlzdGluZ0l0ZW06NDMzODcxMzE=
      responses:
        '200':
          description: Operation completed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      markAsNotDuplicate:
                        type: object
                        properties:
                          clientMutationId:
                            type: string
                            description: Optional client-provided mutation identifier
                            nullable: true
                          errors:
                            type: array
                            items:
                              type: string
                            description: Array of error messages if any occurred
                            nullable: true
                          success:
                            type: boolean
                            description: Indicates if the operation was successful
                          warnings:
                            type: array
                            items:
                              type: string
                            description: Array of warning messages if any occurred
                            nullable: true
                        x-apidog-orders:
                        - clientMutationId
                        - errors
                        - success
                        - warnings
                        nullable: true
                    x-apidog-orders:
                    - markAsNotDuplicate
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: Error message details
                      x-apidog-orders:
                      - message
                    nullable: true
                x-apidog-orders:
                - data
                - errors
              examples:
                '1':
                  summary: success
                  value:
                    data:
                      markAsNotDuplicate:
                        clientMutationId: null
                        errors: null
                        success: true
                        warnings: null
                '2':
                  summary: listingNotFound
                  value:
                    data:
                      markAsNotDuplicate: null
                    errors:
                    - message: SY00002:Listing item ID not found
                '3':
                  summary: invalidLocation
                  value:
                    data:
                      markAsNotDuplicate: null
                    errors:
                    - message: SY90002:Invalid Id
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      markAsNotDuplicate:
                        type: 'null'
                    x-apidog-orders:
                    - markAsNotDuplicate
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                      x-apidog-orders:
                      - message
                x-apidog-orders:
                - data
                - errors
                examples:
                - data:
                    markAsNotDuplicate: null
                  errors:
                  - message: SY90002:Invalid Id
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                      examples:
                      - Insufficient permissions to modify listing status
                x-apidog-orders:
                - errors
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Listings
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13672206-run
  /social-post-ideas/observances:
    get:
      summary: Observances
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the observances (holidays, awareness days, etc.) for a given month, optionally scoped
        to a social profile and narrowed to a specific day. Each item includes whether ideas are ready
        and any generated post idea preview.

        </span>'
      operationId: observances
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: month
        in: query
        description: Month number (1-12).
        required: true
        example: 5
        schema:
          type: integer
      - name: date
        in: query
        description: Day of the month to narrow to.
        required: false
        example: 0
        schema:
          type: integer
      - name: socialProfileId
        in: query
        description: Social profile ID to scope relevance/ideas to.
        required: false
        example: ''
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      observances:
                        type: array
                        items:
                          $ref: '#/components/schemas/Observance'
                    x-apidog-orders:
                    - observances
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140152-run
  /social-post-ideas/observances-with-ideas:
    get:
      summary: Observances with ideas
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the observances for a month for a brand, each joined with its generated post idea (if
        any) — including whether ideas are ready and the idea''s title/content/image.

        </span>'
      operationId: observancesWithIdeas
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: month
        in: query
        description: Month number (1-12).
        required: true
        example: 5
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      observancesWithIdeas:
                        type: array
                        items:
                          $ref: '#/components/schemas/ObservanceWithIdea'
                    x-apidog-orders:
                    - observancesWithIdeas
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140160-run
  /social-post-ideas/pipeline-status:
    get:
      summary: Pipeline status
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the status of the post-idea generation pipeline for a brand (social profile) — current
        step, steps completed/remaining, and any error.

        </span>'
      operationId: pipelineStatus
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      pipelineStatus:
                        $ref: '#/components/schemas/PipelineStatus'
                    x-apidog-orders:
                    - pipelineStatus
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140173-run
  /social-post-ideas/post-idea:
    get:
      summary: Post idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns a single AI social post idea by its ID, including its content, image, scheduling, call-to-action,
        and generation metadata.

        </span>'
      operationId: postIdea
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: ideaId
        in: query
        description: ID of the post idea.
        required: true
        example: 91b2...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      postIdea:
                        $ref: '#/components/schemas/PostIdea'
                    x-apidog-orders:
                    - postIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140182-run
  /social-post-ideas/post-idea-counts:
    get:
      summary: Post idea counts
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns social post-idea counts for a brand, broken down by bucket: AI- generated (`ai`), user-created
        (`mine`), series (`series`), and the total (`all`).

        </span>'
      operationId: postIdeaCounts
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      postIdeaCounts:
                        $ref: '#/components/schemas/PostIdeaCounts'
                    x-apidog-orders:
                    - postIdeaCounts
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140183-run
  /social-post-ideas/post-ideas:
    get:
      summary: Post ideas
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the AI social post ideas for a brand (social profile). Filter by `bucket` (e.g. idea,
        calendar, series) and `filter` (e.g. ai vs mine), and page with `limit`/`offset`.

        </span>'
      operationId: postIdeas
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: bucket
        in: query
        description: Bucket to filter by (e.g. idea, calendar, series).
        required: false
        example: ''
        schema:
          type: string
      - name: filter
        in: query
        description: Source filter (e.g. ai or mine).
        required: false
        example: ''
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of ideas to return.
        required: false
        example: 12
        schema:
          type: integer
      - name: offset
        in: query
        description: Number of ideas to skip.
        required: false
        example: 0
        schema:
          type: integer
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      postIdeas:
                        type: array
                        items:
                          $ref: '#/components/schemas/PostIdea'
                    x-apidog-orders:
                    - postIdeas
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140416-run
  /social-post-ideas/reference-images:
    get:
      summary: Reference images
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the available reference image options for a brand (social profile) — images that can be
        used to ground social post-idea image generation.

        </span>'
      operationId: referenceImages
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      referenceImages:
                        type: array
                        items:
                          $ref: '#/components/schemas/ReferenceImageOption'
                    x-apidog-orders:
                    - referenceImages
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140418-run
  /social-post-ideas/refresh-ideas:
    post:
      summary: Refresh ideas
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates the set of AI social post ideas for a brand. Returns a pipeline ID; supply brand context
        (profile name, site URL, categories, hashtags, intent, content language) to steer generation.

        </span>'
      operationId: refreshIdeas
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshIdeasRequest'
            example:
              socialProfileId: 6f1c2a90-...
              profileName: Acme Co
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      refreshIdeas:
                        $ref: '#/components/schemas/TriggerPipelineResponse'
                    x-apidog-orders:
                    - refreshIdeas
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140425-run
  /local-post-ideas/refresh-ideas:
    post:
      summary: Refresh local ideas
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates the set of AI post ideas for a location. Returns a pipeline ID; poll Local pipeline
        status for progress.

        </span>'
      operationId: refreshLocalIdeas
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshLocalIdeasRequest'
            example:
              locationId: TG9jYXRpb246MQ==
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      refreshLocalIdeas:
                        $ref: '#/components/schemas/LocalTriggerPipelineResponse'
                    x-apidog-orders:
                    - refreshLocalIdeas
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053261-run
  /social-post-ideas/regenerate-idea:
    post:
      summary: Regenerate idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates an entire social post idea — both content and image. Optionally steer with a `topic`
        and a `referenceImageUrl`.

        </span>'
      operationId: regenerateIdea
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateIdeaRequest'
            example:
              ideaId: 91b2...
              topic: summer launch
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regenerateIdea:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - regenerateIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140427-run
  /social-post-ideas/regenerate-idea-content:
    post:
      summary: Regenerate idea content
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates the text content (title/copy) of an existing social post idea, keeping its image.
        Optionally steer with a `topic`.

        </span>'
      operationId: regenerateIdeaContent
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateIdeaContentRequest'
            example:
              ideaId: 91b2...
              topic: summer launch
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regenerateIdeaContent:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - regenerateIdeaContent
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140428-run
  /social-post-ideas/regenerate-idea-image:
    post:
      summary: Regenerate idea image
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates the image of an existing social post idea, keeping its text content. Optionally provide
        a `referenceImageUrl` to ground the new image. Image generation is asynchronous — poll the idea
        job status for the new image URL.

        </span>'
      operationId: regenerateIdeaImage
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateIdeaImageRequest'
            example:
              ideaId: 91b2...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regenerateIdeaImage:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - regenerateIdeaImage
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140435-run
  /local-post-ideas/regenerate-idea:
    post:
      summary: Regenerate local idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates an entire post idea — both content and image. Optionally steer the result with a `topic`.

        </span>'
      operationId: regenerateLocalIdea
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateLocalIdeaRequest'
            example:
              ideaId: 91b2...
              topic: weekend sale
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regenerateLocalIdea:
                        $ref: '#/components/schemas/LocalRegenerateResponse'
                    x-apidog-orders:
                    - regenerateLocalIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053275-run
  /local-post-ideas/regenerate-idea-content:
    post:
      summary: Regenerate local idea content
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates the text content (title/copy) of an existing post idea, keeping its image. Optionally
        steer the result with a `topic`.

        </span>'
      operationId: regenerateLocalIdeaContent
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateLocalIdeaContentRequest'
            example:
              ideaId: 91b2...
              topic: weekend sale
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regenerateLocalIdeaContent:
                        $ref: '#/components/schemas/LocalRegenerateResponse'
                    x-apidog-orders:
                    - regenerateLocalIdeaContent
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053278-run
  /local-post-ideas/regenerate-idea-image:
    post:
      summary: Regenerate local idea image
      deprecated: false
      description: '<span style="font-size: 14px;">

        Regenerates the image of an existing post idea, keeping its text content. Image generation is
        asynchronous — poll the idea (or its job status) for the new image URL.

        </span>'
      operationId: regenerateLocalIdeaImage
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateLocalIdeaImageRequest'
            example:
              ideaId: 91b2...
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regenerateLocalIdeaImage:
                        $ref: '#/components/schemas/LocalRegenerateResponse'
                    x-apidog-orders:
                    - regenerateLocalIdeaImage
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053282-run
  /users/folders/remove:
    post:
      summary: Remove Folders for User
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n    \nThis API removes specific locations associated\
        \ with a user, revoking their access to those locations.\n\nBehavior:\n- Supports removing one\
        \ or multiple locations from a user.\n- Updates the user’s permissions and access scope accordingly.\n\
        </span>"
      tags:
      - User Management
      - User Management
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - userId
                  - folderIds
                  properties:
                    userId:
                      type: string
                      description: Base64 encoded user ID
                    folderIds:
                      type: array
                      items:
                        type: string
                        format: uuid
                      description: Array of folder UUIDs to remove for the user
                  x-apidog-orders:
                  - userId
                  - folderIds
              x-apidog-orders:
              - input
            example:
              input:
                userId: VXNlcjoxMDAyOA==
                folderIds:
                - c1d92c09-8ddd-469e-af96-0eb64a48d647
                - a5af4f5d-41b6-4a8a-b24f-98741b021b7b
      responses:
        '200':
          description: Successfully removed folders for user
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      removeFoldersForUser:
                        type: object
                        properties:
                          status:
                            type: array
                            items:
                              type: object
                              properties:
                                errors:
                                  type: array
                                  items:
                                    type: string
                                  description: Array of error messages if any
                                  nullable: true
                                folderId:
                                  type: string
                                  format: uuid
                                  description: UUID of the folder being removed
                                success:
                                  type: boolean
                                  description: Whether the folder was successfully removed
                              x-apidog-orders:
                              - errors
                              - folderId
                              - success
                        x-apidog-orders:
                        - status
                    x-apidog-orders:
                    - removeFoldersForUser
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: default
                  value:
                    data:
                      removeFoldersForUser:
                        status:
                        - errors: null
                          folderId: c1d92c09-8ddd-469e-af96-0eb64a48d647
                          success: true
                        - errors: null
                          folderId: a5af4f5d-41b6-4a8a-b24f-98741b021b7b
                          success: true
                '2':
                  summary: alternative
                  value:
                    data:
                      removeFoldersForUser:
                        status:
                        - errors: null
                          folderId: 07011529-c5bf-4808-b4f2-32d026e9bd56
                          success: true
                        - errors: null
                          folderId: 09464e8f-0fe9-45d3-8d9c-867badbdfaea
                          success: true
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13997706-run
  /locations/tags/remove:
    post:
      summary: Remove location from a tag
      deprecated: false
      description: '<span style="font-size: 14px;">


        Removes the association between a location and a specified tag. This operation:

        - Only removes the association, it does not delete the tag itself

        - Does not affect other locations that may be associated with the same tag

        - Returns success even if the location was not previously associated with the tag

        </span>'
      operationId: removeLocationFromTag
      tags:
      - Organizing locations
      - Tags
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - locationId
                  - tag
                  properties:
                    locationId:
                      type: string
                      description: Unique identifier of the location to remove from the tag
                      examples:
                      - TG9jYXRpb246MTY4NjA=
                    tag:
                      type: string
                      description: Name of the tag to remove the location from
                      examples:
                      - Old
                  x-apidog-orders:
                  - locationId
                  - tag
              x-apidog-orders:
              - input
            example: ''
      responses:
        '200':
          description: Operation result
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      removeTag:
                        type: object
                        properties:
                          clientMutationId:
                            type: null
                            description: Optional client-provided mutation identifier
                          errors:
                            type: array
                            description: Array of errors if any occurred during the operation
                            items:
                              type: object
                              properties:
                                code:
                                  type: string
                                  description: Error code
                                message:
                                  type: string
                                  description: Human-readable error message
                              x-apidog-orders:
                              - code
                              - message
                          success:
                            type: boolean
                            description: Indicates if the removal operation was successful
                          tag:
                            type: object
                            description: Details of the tag from which the location was removed
                            properties:
                              id:
                                type: string
                                format: uuid
                                description: Unique identifier of the tag
                                examples:
                                - 8e1ddaa4-6230-4b29-8107-6ad1b7b33fca
                              name:
                                type: string
                                description: Name of the tag
                                examples:
                                - Old
                            x-apidog-orders:
                            - id
                            - name
                        x-apidog-orders:
                        - clientMutationId
                        - errors
                        - success
                        - tag
                    x-apidog-orders:
                    - removeTag
                x-apidog-orders:
                - data
              example:
                data:
                  removeTag:
                    clientMutationId: null
                    errors: []
                    success: true
                    tag:
                      id: 8e1ddaa4-6230-4b29-8107-6ad1b7b33fca
                      name: Old
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - Invalid location ID or tag name
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Forbidden
        '404':
          description: Location or tag not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660509-run
  /users/locations/remove:
    post:
      summary: Remove Locations for User
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API removes specific locations associated with a user, revoking their access to those locations.


        **Behavior:**

        - Supports removing one or multiple locations from a user.

        - Updates the user’s permissions and access scope accordingly.

        </span>

        '
      tags:
      - User Management
      - User Management
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - userId
                  - locationIds
                  properties:
                    userId:
                      type: string
                      description: Base64 encoded user ID
                    locationIds:
                      type: array
                      items:
                        type: string
                        description: Base64 encoded location IDs
                  x-apidog-orders:
                  - userId
                  - locationIds
              x-apidog-orders:
              - input
            example:
              input:
                userId: VXNlcjoxMDA1Mw==
                locationIds:
                - TG9jYXRpb246NTE1MzA=
                - TG9jYXRpb246NTE1MjY=
      responses:
        '200':
          description: Successfully removed locations for user
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      removeLocationsForUser:
                        type: object
                        properties:
                          status:
                            type: array
                            items:
                              type: object
                              properties:
                                errors:
                                  type: array
                                  items:
                                    type: string
                                  description: Array of error messages if any
                                  nullable: true
                                locationId:
                                  type: string
                                  description: Base64 encoded location ID that was removed
                                success:
                                  type: boolean
                                  description: Whether the location was successfully removed
                              x-apidog-orders:
                              - errors
                              - locationId
                              - success
                        x-apidog-orders:
                        - status
                    x-apidog-orders:
                    - removeLocationsForUser
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: default
                  value:
                    data:
                      removeLocationsForUser:
                        status:
                        - errors: null
                          locationId: TG9jYXRpb246NTE1MzA=
                          success: true
                        - errors: null
                          locationId: TG9jYXRpb246NTE1MjY=
                          success: true
                '2':
                  summary: alternative
                  value:
                    data:
                      removeLocationsForUser:
                        status:
                        - errors: null
                          locationId: TG9jYXRpb246MTE3NjE5NQ==
                          success: true
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13998778-run
  /locations/folders/remove:
    post:
      summary: Remove locations from a folder
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API removes specified locations from their current folder.


        **Behavior:**

        - A location can belong to only one folder at a time.

        - Only the locationIds need to be provided, as the system automatically identifies their current
        folder.

        - If a location is removed, it will no longer be associated with any folder unless reassigned.

        </span>

        '
      tags:
      - Organizing locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - locationIds
                  properties:
                    locationIds:
                      type: array
                      items:
                        type: string
                      description: Array of location IDs to remove from their folders
                  x-apidog-orders:
                  - locationIds
              x-apidog-orders:
              - input
            example:
              input:
                locationIds:
                - TG9jYXRpb246MTY4NDY=
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      deleteLocationsFromFolder:
                        type: object
                        properties:
                          clientMutationId:
                            type: null
                          errors:
                            type: null
                          locations:
                            type: array
                            items:
                              type: string
                          success:
                            type: boolean
                        x-apidog-orders:
                        - clientMutationId
                        - errors
                        - locations
                        - success
                    x-apidog-orders:
                    - deleteLocationsFromFolder
                x-apidog-orders:
                - data
              example:
                data:
                  deleteLocationsFromFolder:
                    clientMutationId: null
                    errors: null
                    locations:
                    - bG9jYXRpb25zOjE2OTQx
                    success: true
                errors: []
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660249-run
  /locations/folders/rename:
    post:
      summary: Rename a folder
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API updates the name of an existing folder\
        \ to a new name.\n\n\n   \n\n \n**Important Notes:**\n- The new folder name must be unique within\
        \ your account.\n- Root folders cannot be renamed.\n- The folder being renamed must exist in your\
        \ account.\n- Special characters in the new name will be converted to underscores (_).\n\n</span>"
      tags:
      - Organizing locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - name
                  - oldName
                  properties:
                    name:
                      type: string
                      description: The new name for the folder
                      minLength: 1
                      examples:
                      - Acme New
                    oldName:
                      type: string
                      description: The current name of the folder to be renamed
                      minLength: 1
                      examples:
                      - Acme
                  x-apidog-orders:
                  - name
                  - oldName
              x-apidog-orders:
              - input
            example: ''
      responses:
        '200':
          description: Successfully renamed the folder
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      renameFolder:
                        type: object
                        properties:
                          errors:
                            type: array
                            description: Array of error messages if the operation failed
                            items:
                              type: string
                            nullable: true
                          folder:
                            type: object
                            properties:
                              accountId:
                                type: integer
                                description: ID of the account that owns the folder
                                examples:
                                - 10072
                              archived:
                                type: boolean
                                description: Indicates if the folder is archived
                                examples:
                                - false
                              id:
                                type: string
                                format: uuid
                                description: Unique identifier of the folder
                                examples:
                                - 0e4cc56e-45f8-4058-a713-ead264fa9318
                              name:
                                type: string
                                description: The new name of the folder
                                examples:
                                - Acme_New
                              root:
                                type: boolean
                                description: Indicates if this is a root folder
                                examples:
                                - false
                            required:
                            - accountId
                            - archived
                            - id
                            - name
                            - root
                            x-apidog-orders:
                            - accountId
                            - archived
                            - id
                            - name
                            - root
                        x-apidog-orders:
                        - errors
                        - folder
                    x-apidog-orders:
                    - renameFolder
                x-apidog-orders:
                - data
              example:
                data:
                  renameFolder:
                    clientMutationId: null
                    errors: null
                    folder:
                      accountId: 16154
                      archived: false
                      createdAt: 2025-02-02 15:27:00 UTC
                      id: 098ba54d-3659-46fa-9c17-4af4329ce421
                      locationCount: null
                      name: 2feb2025855pm_2
                      root: false
                    success: true
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad request - invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Bad Request
        '404':
          description: Folder not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Record Not Found
        '409':
          description: New folder name already exists
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: '409'
      security: []
      x-apidog-folder: Organizing locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13660162-run
  /connected-accounts/connect-apple/renew:
    post:
      summary: Renew connect link for Apple
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates a link to **re-authorize** an Apple Business Connect connection whose OAuth token has
        expired or been revoked. Provide either a `locationId` or a `connectedAccountId` to identify the
        connection to renew. Redirect the user to the returned `url`; the link is valid for 1 day.


        **Apple OAuth link variants:**

        - **Connect link for Apple** — connect a single location.

        - **Bulk connect link for Apple** — connect multiple locations.

        - **Renew connect link for Apple** — re-authorize an existing connection (this endpoint).

        </span>'
      operationId: renewConnectLinkForApple
      tags:
      - Connected Accounts
      - Connected Accounts
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppleRenewOauthRequest'
            example:
              input:
                locationId: TG9jYXRpb246MQ==
                successUrl: https://app.synup.com/apple/success
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      renewConnectLinkForApple:
                        $ref: '#/components/schemas/AppleRenewOauthPayload'
                    x-apidog-orders:
                    - renewConnectLinkForApple
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051602-run
  /locations/reviews/respond:
    post:
      summary: Respond to an Interaction
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\n  This API posts a response to a specific interaction\
        \ on the respective partner site (e.g., Google, Facebook, Yelp).\n    \n    **Behavior:**\n- The\
        \ response is posted directly to the platform where the interaction originated.\n- Some platforms\
        \ may have moderation policies that affect response visibility.\n- Supports text-based responses;\
        \ some platforms may allow limited formatting.\n- Ensures responses comply with platform-specific\
        \ guidelines.\n    \n</span>"
      operationId: respondToInteraction
      tags:
      - Reviews
      - Interactions
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - interactionId
              - responseContent
              properties:
                interactionId:
                  type: string
                  format: uuid
                  description: ID of the interaction to respond to
                responseContent:
                  type: string
                  description: Response text content
              x-apidog-orders:
              - interactionId
              - responseContent
              x-apidog-ignore-properties: []
            example:
              interactionId: 2090753a-ece6-4837-8336-8494ad308523
              responseContent: This is a sample response
      responses:
        '200':
          description: Response successfully posted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      respondToInteraction:
                        type: object
                        properties:
                          interaction:
                            $ref: '#/components/schemas/ResponseInteraction'
                        x-apidog-orders:
                        - interaction
                        x-apidog-ignore-properties: []
                    x-apidog-orders:
                    - respondToInteraction
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
              example:
                data:
                  respondToInteraction:
                    interaction:
                      interactionId: 7495f5f5-05c3-41f7-a498-1f9cde0d4693
                      source: facebook.com
                      content: This is a sample response
                      authorName: null
                      authorAvatar: null
                      authorUrl: null
                      date: '2019-01-21T05:26:30.687556+00:00'
                      interactionStatus: Created
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13932713-run
  /rollup_interactions:
    get:
      summary: Rollup Review API
      deprecated: false
      description: ''
      tags:
      - Reviews
      parameters:
      - name: tag
        in: query
        description: ''
        required: true
        example: all
        schema:
          type: string
      - name: first
        in: query
        description: ''
        required: true
        example: '20'
        schema:
          type: string
      - name: ratingFilters
        in: query
        description: ''
        required: true
        example: '[]'
        schema:
          type: string
      - name: categories
        in: query
        description: ''
        required: true
        example: '[]'
        schema:
          type: string
      - name: responseStatus
        in: query
        description: ''
        required: true
        example: '[]'
        schema:
          type: string
      - name: siteUrls
        in: query
        description: ''
        required: true
        example: '[]'
        schema:
          type: string
      - name: sortOrder
        in: query
        description: ''
        required: true
        example: NEWEST_FIRST
        schema:
          type: string
      - name: searchString
        in: query
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: startDate
        in: query
        description: ''
        required: true
        example: 'null'
        schema:
          type: string
      - name: endDate
        in: query
        description: ''
        required: true
        example: 'null'
        schema:
          type: string
      - name: before
        in: query
        description: ''
        required: true
        example: 'null'
        schema:
          type: string
      - name: after
        in: query
        description: ''
        required: true
        example: 'null'
        schema:
          type: string
      - name: last
        in: query
        description: ''
        required: true
        example: 'null'
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API nQWIQkSj_nLpgzeSXtSjNVCxhVU
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          text/plain:
            schema:
              type: string
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Reviews
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-20430521-run
  /local-post-ideas/schedule-series:
    post:
      summary: Schedule local series
      deprecated: false
      description: '<span style="font-size: 14px;">

        Schedules a content series'' posts starting from a given date. Returns the scheduled posts.

        </span>'
      operationId: scheduleLocalSeries
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleLocalSeriesRequest'
            example:
              seriesId: 3a1f...
              startDate: '2026-05-01'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      scheduleLocalSeries:
                        $ref: '#/components/schemas/LocalScheduleSeriesResponse'
                    x-apidog-orders:
                    - scheduleLocalSeries
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053284-run
  /social-post-ideas/schedule-series:
    post:
      summary: Schedule series
      deprecated: false
      description: '<span style="font-size: 14px;">

        Schedules a content series'' posts starting from a given date. Returns the scheduled posts.

        </span>'
      operationId: scheduleSeries
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleSeriesRequest'
            example:
              seriesId: 3a1f...
              startDate: '2026-05-01'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      scheduleSeries:
                        $ref: '#/components/schemas/ScheduleSeriesResponse'
                    x-apidog-orders:
                    - scheduleSeries
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140440-run
  /social-post-ideas/scrape-brand:
    post:
      summary: Scrape brand
      deprecated: false
      description: '<span style="font-size: 14px;">

        Triggers a scrape of the brand''s website to refresh the context used for social post-idea generation.
        Provide the `siteUrl` to scrape; `trigger` optionally records what initiated the scrape.

        </span>'
      operationId: scrapeBrand
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScrapeBrandRequest'
            example:
              socialProfileId: 6f1c2a90-...
              siteUrl: https://example.com
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      scrapeBrand:
                        $ref: '#/components/schemas/MutationResponse'
                    x-apidog-orders:
                    - scrapeBrand
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140472-run
  /local-post-ideas/scrape-location:
    post:
      summary: Scrape location
      deprecated: false
      description: '<span style="font-size: 14px;">

        Triggers a scrape of the location''s website to refresh the context used for post-idea generation.
        Provide the `siteUrl` to scrape; `trigger` optionally records what initiated the scrape.

        </span>'
      operationId: scrapeLocation
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScrapeLocationRequest'
            example:
              locationId: TG9jYXRpb246MQ==
              siteUrl: https://example.com
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      scrapeLocation:
                        $ref: '#/components/schemas/LocalMutationResponse'
                    x-apidog-orders:
                    - scrapeLocation
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053286-run
  /social-post-ideas/scraped-brand-context:
    get:
      summary: Scraped brand context
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the context scraped from the brand''s website that grounds social post-idea generation
        — business name/description, services, products, pricing, brand colors/logo, tone, and target
        customers.

        </span>'
      operationId: scrapedBrandContext
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      scrapedBrandContext:
                        $ref: '#/components/schemas/ScrapedBrandContext'
                    x-apidog-orders:
                    - scrapedBrandContext
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140475-run
  /locations/search:
    get:
      summary: Search locations
      deprecated: false
      description: '<br>

        <span style="font-size: 14px;">


        This API returns a list of locations that match a given keyword. The search can be performed on
        the following fields:


        - Location Name

        - Street Address

        - Store ID


        If no specific fields are provided, the API will search across all available fields by default.

        </span>'
      operationId: searchLocations
      tags:
      - Locations
      parameters:
      - name: query
        in: query
        description: Search keyword
        required: true
        example: test
        schema:
          type: string
      - name: fields
        in: query
        description: 'Specific fields to search against. If not provided, searches across all fields.

          '
        required: false
        example:
        - store_id
        schema:
          type: array
          items:
            type: string
      - name: first
        in: query
        description: Number of records to fetch from the most recent ones (i.e., from the end). Defaults
          to 50 if not provided.
        required: false
        example: 50
        schema:
          type: integer
      - name: last
        in: query
        description: Number of records to fetch from the earliest ones (i.e., from the beginning).
        required: false
        example: 50
        schema:
          type: integer
      - name: after
        in: query
        description: Cursor to fetch records after
        required: false
        schema:
          type: string
      - name: before
        in: query
        description: Cursor to fetch records before
        required: false
        schema:
          type: string
      - name: archived
        in: query
        description: 'Filter locations archived true/false '
        required: false
        example: 'false'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      searchLocations:
                        type: object
                        properties:
                          edges:
                            type: array
                            items:
                              type: object
                              properties:
                                cursor:
                                  type: string
                                node:
                                  type: object
                                  properties:
                                    accountId:
                                      type: integer
                                    addOns:
                                      type: array
                                      items:
                                        type: string
                                    additionalCategoryIds:
                                      type: array
                                      items:
                                        type: integer
                                    additionalCategoryNames:
                                      type: array
                                      items:
                                        type: string
                                    additionalInfo:
                                      type: 'null'
                                    additionalPhones:
                                      type: array
                                      items:
                                        type: string
                                    approved:
                                      type: string
                                    archivalScheduledAt:
                                      type: 'null'
                                    archived:
                                      type: boolean
                                    archivedAt:
                                      type: 'null'
                                    bizUrl:
                                      type: 'null'
                                    bizUrlUtm:
                                      type: boolean
                                    bookingUrl:
                                      type: 'null'
                                    businessHours:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          day:
                                            type: string
                                          slots:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                end:
                                                  type: string
                                                start:
                                                  type: string
                                              required:
                                              - end
                                              - start
                                              x-apidog-orders:
                                              - end
                                              - start
                                          specialDate:
                                            type: 'null'
                                          type:
                                            type: string
                                        required:
                                        - day
                                        - slots
                                        - specialDate
                                        - type
                                        x-apidog-orders:
                                        - day
                                        - slots
                                        - specialDate
                                        - type
                                    cancellationScheduledAt:
                                      type: 'null'
                                    categoryId:
                                      type: integer
                                    city:
                                      type: string
                                    contentPreferredLanguage:
                                      type: string
                                    countryCode:
                                      type: string
                                    countryIso:
                                      type: string
                                    createErrors:
                                      type: array
                                      items:
                                        type: string
                                    createdDate:
                                      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
                                        required:
                                        - archived
                                        - enumValues
                                        - name
                                        - slug
                                        - type
                                        - value
                                        x-apidog-orders:
                                        - archived
                                        - enumValues
                                        - name
                                        - slug
                                        - type
                                        - value
                                    databaseId:
                                      type: integer
                                    description:
                                      type: string
                                    enabledSiteIds:
                                      type: array
                                      items:
                                        type: string
                                    facebookUrl:
                                      type: string
                                      nullable: true
                                    folderId:
                                      type: string
                                    folderName:
                                      type: string
                                    franchise:
                                      type: boolean
                                    googleAdsPhone:
                                      type: string
                                      nullable: true
                                    googleVerificationStatus:
                                      type: object
                                      properties:
                                        message:
                                          type: 'null'
                                        status:
                                          type: string
                                      required:
                                      - message
                                      - status
                                      x-apidog-orders:
                                      - message
                                      - status
                                    googleplusUrl:
                                      type: 'null'
                                    hideAddress:
                                      type: boolean
                                    id:
                                      type: string
                                    instagramUrl:
                                      type: 'null'
                                    isRestaurant:
                                      type: boolean
                                    lastUpdatedDate:
                                      type: string
                                    latitude:
                                      type: string
                                    linkedinUrl:
                                      type: string
                                      nullable: true
                                    locationPhotos:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          databaseId:
                                            type: integer
                                          fileSize:
                                            type: integer
                                          id:
                                            type: string
                                          name:
                                            type: string
                                          starred:
                                            type: boolean
                                          thumbnailUrl:
                                            type: string
                                          type:
                                            type: string
                                          url:
                                            type: string
                                        required:
                                        - databaseId
                                        - fileSize
                                        - id
                                        - name
                                        - starred
                                        - thumbnailUrl
                                        - type
                                        - url
                                        x-apidog-orders:
                                        - databaseId
                                        - fileSize
                                        - id
                                        - name
                                        - starred
                                        - thumbnailUrl
                                        - type
                                        - url
                                    longitude:
                                      type: string
                                    managedServiceSiteBuckets:
                                      type: array
                                      items:
                                        type: string
                                    managedServiceSites:
                                      type: array
                                      items:
                                        type: string
                                    moreHours:
                                      type: array
                                      items:
                                        type: string
                                    name:
                                      type: string
                                    offeringsUrl:
                                      type: 'null'
                                    ownerEmail:
                                      type: string
                                      nullable: true
                                    ownerName:
                                      type: string
                                      nullable: true
                                    package:
                                      type: string
                                    paymentMethods:
                                      type: array
                                      items:
                                        type: string
                                    phone:
                                      type: string
                                    pinterestUrl:
                                      type: 'null'
                                    planId:
                                      type: integer
                                    planName:
                                      type: string
                                    postalCode:
                                      type: string
                                    publisherAttributes:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          attributeName:
                                            type: string
                                          publisherName:
                                            type: string
                                          value:
                                            type: array
                                            items:
                                              type: string
                                        x-apidog-orders:
                                        - attributeName
                                        - publisherName
                                        - value
                                    reservationUrl:
                                      type: 'null'
                                    serviceItems:
                                      type: array
                                      items:
                                        type: string
                                    stateIso:
                                      type: string
                                    stateName:
                                      type: string
                                    storeId:
                                      type: string
                                    street:
                                      type: string
                                    street1:
                                      type: string
                                    subCategoryId:
                                      type: integer
                                    subCategoryName:
                                      type: string
                                    tagline:
                                      type: string
                                      nullable: true
                                    tags:
                                      type: array
                                      items:
                                        type: string
                                    temporarilyClosed:
                                      type: boolean
                                    tiktokUrl:
                                      type: 'null'
                                    toplineMessage:
                                      type: 'null'
                                    toplineMessageText:
                                      type: 'null'
                                    twitterUrl:
                                      type: string
                                      nullable: true
                                    uid:
                                      type: string
                                    updatedAt:
                                      type: string
                                    videos:
                                      type: array
                                      items:
                                        type: string
                                    voiceStatus:
                                      type: integer
                                    yearOfIncorporation:
                                      type: integer
                                      nullable: true
                                    youtubeUrl:
                                      type: 'null'
                                  required:
                                  - accountId
                                  - addOns
                                  - additionalCategoryIds
                                  - additionalCategoryNames
                                  - additionalInfo
                                  - additionalPhones
                                  - approved
                                  - archivalScheduledAt
                                  - archived
                                  - archivedAt
                                  - bizUrl
                                  - bizUrlUtm
                                  - bookingUrl
                                  - businessHours
                                  - cancellationScheduledAt
                                  - categoryId
                                  - city
                                  - contentPreferredLanguage
                                  - countryCode
                                  - countryIso
                                  - createErrors
                                  - createdDate
                                  - customAttributes
                                  - databaseId
                                  - description
                                  - enabledSiteIds
                                  - facebookUrl
                                  - folderId
                                  - folderName
                                  - franchise
                                  - googleAdsPhone
                                  - googleVerificationStatus
                                  - googleplusUrl
                                  - hideAddress
                                  - id
                                  - instagramUrl
                                  - isRestaurant
                                  - lastUpdatedDate
                                  - latitude
                                  - linkedinUrl
                                  - locationPhotos
                                  - longitude
                                  - managedServiceSiteBuckets
                                  - managedServiceSites
                                  - moreHours
                                  - name
                                  - offeringsUrl
                                  - ownerEmail
                                  - ownerName
                                  - package
                                  - paymentMethods
                                  - phone
                                  - pinterestUrl
                                  - planId
                                  - planName
                                  - postalCode
                                  - publisherAttributes
                                  - reservationUrl
                                  - serviceItems
                                  - stateIso
                                  - stateName
                                  - storeId
                                  - street
                                  - street1
                                  - subCategoryId
                                  - subCategoryName
                                  - tagline
                                  - tags
                                  - temporarilyClosed
                                  - tiktokUrl
                                  - toplineMessage
                                  - toplineMessageText
                                  - twitterUrl
                                  - uid
                                  - updatedAt
                                  - videos
                                  - voiceStatus
                                  - yearOfIncorporation
                                  - youtubeUrl
                                  x-apidog-orders:
                                  - accountId
                                  - addOns
                                  - additionalCategoryIds
                                  - additionalCategoryNames
                                  - additionalInfo
                                  - additionalPhones
                                  - approved
                                  - archivalScheduledAt
                                  - archived
                                  - archivedAt
                                  - bizUrl
                                  - bizUrlUtm
                                  - bookingUrl
                                  - businessHours
                                  - cancellationScheduledAt
                                  - categoryId
                                  - city
                                  - contentPreferredLanguage
                                  - countryCode
                                  - countryIso
                                  - createErrors
                                  - createdDate
                                  - customAttributes
                                  - databaseId
                                  - description
                                  - enabledSiteIds
                                  - facebookUrl
                                  - folderId
                                  - folderName
                                  - franchise
                                  - googleAdsPhone
                                  - googleVerificationStatus
                                  - googleplusUrl
                                  - hideAddress
                                  - id
                                  - instagramUrl
                                  - isRestaurant
                                  - lastUpdatedDate
                                  - latitude
                                  - linkedinUrl
                                  - locationPhotos
                                  - longitude
                                  - managedServiceSiteBuckets
                                  - managedServiceSites
                                  - moreHours
                                  - name
                                  - offeringsUrl
                                  - ownerEmail
                                  - ownerName
                                  - package
                                  - paymentMethods
                                  - phone
                                  - pinterestUrl
                                  - planId
                                  - planName
                                  - postalCode
                                  - publisherAttributes
                                  - reservationUrl
                                  - serviceItems
                                  - stateIso
                                  - stateName
                                  - storeId
                                  - street
                                  - street1
                                  - subCategoryId
                                  - subCategoryName
                                  - tagline
                                  - tags
                                  - temporarilyClosed
                                  - tiktokUrl
                                  - toplineMessage
                                  - toplineMessageText
                                  - twitterUrl
                                  - uid
                                  - updatedAt
                                  - videos
                                  - voiceStatus
                                  - yearOfIncorporation
                                  - youtubeUrl
                              required:
                              - cursor
                              - node
                              x-apidog-orders:
                              - cursor
                              - node
                          pageInfo:
                            type: object
                            properties:
                              endCursor:
                                type: string
                              hasNextPage:
                                type: boolean
                              hasPreviousPage:
                                type: boolean
                              total:
                                type: integer
                            required:
                            - endCursor
                            - hasNextPage
                            - hasPreviousPage
                            - total
                            x-apidog-orders:
                            - endCursor
                            - hasNextPage
                            - hasPreviousPage
                            - total
                        required:
                        - edges
                        - pageInfo
                        x-apidog-orders:
                        - edges
                        - pageInfo
                    required:
                    - searchLocations
                    x-apidog-orders:
                    - searchLocations
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  searchLocations:
                    edges:
                    - cursor: TG9jYXRpb246NTI3NDY5
                      node:
                        accountId: 16154
                        addOns: []
                        additionalCategoryIds: []
                        additionalCategoryNames: []
                        additionalInfo: null
                        additionalPhones: []
                        approved: NOT_APPROVED
                        archivalScheduledAt: null
                        archived: false
                        archivedAt: null
                        bizUrl: null
                        bizUrlUtm: false
                        bookingUrl: null
                        businessHours: []
                        cancellationScheduledAt: null
                        categoryId: 15
                        city: Sacramento
                        contentPreferredLanguage: ENGLISH
                        countryCode: '1'
                        countryIso: US
                        createErrors: []
                        createdDate: February 23, 2021
                        customAttributes:
                        - archived: false
                          enumValues: []
                          name: ABC
                          slug: abc
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: NJL
                          slug: njl
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: ZZZ
                          slug: zzz
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ALL
                          slug: all
                          type: STRING
                          value:
                          - ss
                        - archived: false
                          enumValues:
                          - gulab jamun
                          - rasgulla
                          - ras malai
                          - jalebi
                          name: Dessets
                          slug: dessets
                          type: ENUM
                          value:
                          - gulab jamun
                        - archived: false
                          enumValues: []
                          name: Attrs
                          slug: attrs
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Attrs2
                          slug: attrs2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Toll-free Number
                          slug: toll-free_number
                          type: INTEGER
                          value:
                          - '80044637'
                        - archived: false
                          enumValues: []
                          name: amenities
                          slug: amenities
                          type: ARRAY
                          value:
                          - wifi
                          - wheelchair
                          - welcoming ceremony
                        - archived: false
                          enumValues: []
                          name: amenities02
                          slug: amenities02
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Amenities-check
                          slug: amenities-check
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues:
                          - Atr1
                          - atr2
                          - atr3
                          name: Prod_Attribute
                          slug: prod_attribute
                          type: ENUM
                          value:
                          - Atr1
                        - archived: false
                          enumValues: []
                          name: wifi available
                          slug: wifi_available
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: QQQQQQQ
                          slug: qqqqqqq
                          type: INTEGER
                          value:
                          - '123'
                        - archived: false
                          enumValues: []
                          name: int02
                          slug: int02
                          type: INTEGER
                          value: []
                        - archived: false
                          enumValues: []
                          name: Tasty
                          slug: tasty
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: dhdop
                          slug: dhdop
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Abstract
                          slug: abstract
                          type: ARRAY
                          value:
                          - abs1
                          - abs2
                          - abs3
                        - archived: false
                          enumValues: []
                          name: Senior Hours Required?
                          slug: senior_hours_required?
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: kafka_check_attribute
                          slug: kafka_check_attribute
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues: []
                          name: Parking
                          slug: parking
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: googlePlaceId
                          slug: googleplaceid
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: hoursComments
                          slug: hourscomments
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: isOpen
                          slug: isopen
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: has_bicycle_rack?
                          slug: has_bicycle_rack?
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues:
                          - one
                          - two
                          name: quick
                          slug: quick
                          type: ENUM
                          value:
                          - one
                        - archived: false
                          enumValues: []
                          name: instagramUrl
                          slug: instagramurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingFireEvent
                          slug: analyticstrackingfireevent
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: placeholderText
                          slug: placeholdertext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues:
                          - FRND
                          - MENMENMEN
                          - BARNEY
                          name: TV
                          slug: tv
                          type: ENUM
                          value:
                          - FRND
                        - archived: false
                          enumValues: []
                          name: notificationEmails
                          slug: notificationemails
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: joinUrl
                          slug: joinurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: account_att
                          slug: account_att
                          type: ARRAY
                          value:
                          - '1'
                          - '2'
                          - '4'
                          - '3'
                        - archived: false
                          enumValues: []
                          name: Post v2
                          slug: post_v2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: testingthetest
                          slug: testingthetest
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: int0
                          slug: int0
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: url_appointment
                          slug: url_appointment
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Slug
                          slug: slug
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: New Name
                          slug: new_name
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: test200
                          slug: test200
                          type: STRING
                          value:
                          - test test
                        - archived: false
                          enumValues: []
                          name: Name
                          slug: name
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Test Department '
                          slug: test_department_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Fresh Fish Section '
                          slug: fresh_fish_section_
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Test 28 11 22
                          slug: test_28_11_22
                          type: STRING
                          value:
                          - Test 28
                        - archived: false
                          enumValues: []
                          name: blablacar
                          slug: blablacar
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: requires temperature check customers
                          slug: requires_temperature_check_customers
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Custom Tee Point
                          slug: custom_tee_point
                          type: STRING
                          value:
                          - tess
                        - archived: false
                          enumValues: []
                          name: appointment_required
                          slug: appointment_required
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: requires masks customers
                          slug: requires_masks_customers
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: is black owned
                          slug: is_black_owned
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: BewAttribute
                          slug: bewattribute
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Pets 2 '
                          slug: pets_2_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: test214122
                          slug: test214122
                          type: STRING
                          value:
                          - test2
                        - archived: false
                          enumValues: []
                          name: Test123
                          slug: test123
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ohiiiignore
                          slug: ohiiiignore
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: yesnotest
                          slug: yesnotest
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: account_leve_test_for_ext
                          slug: account_leve_test_for_ext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Custom location ID
                          slug: custom_location_id
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Account Attr
                          slug: account_attr
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues:
                          - b
                          - a
                          - c
                          name: enum01
                          slug: enum01
                          type: ENUM
                          value:
                          - a
                        - archived: false
                          enumValues: []
                          name: Paneer Speciality
                          slug: paneer_speciality
                          type: STRING
                          value:
                          - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg
                        - archived: false
                          enumValues: []
                          name: welcomes_lgbtq
                          slug: welcomes_lgbtq
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Lgbtq+ friendly
                          slug: lgbtq+_friendly
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingScript
                          slug: analyticstrackingscript
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: test-os-attr3
                          slug: test-os-attr3
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: lead_photo_drive
                          slug: lead_photo_drive
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: parcel
                          slug: parcel
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: test-os-attr1
                          slug: test-os-attr1
                          type: INTEGER
                          value: []
                        - archived: false
                          enumValues: []
                          name: global-attr-2
                          slug: global-attr-2
                          type: STRING
                          value:
                          - 'testing '
                        - archived: false
                          enumValues: []
                          name: bollean03
                          slug: bollean03
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: global-attr-1
                          slug: global-attr-1
                          type: STRING
                          value:
                          - '11111'
                        - archived: false
                          enumValues: []
                          name: KAM
                          slug: kam
                          type: STRING
                          value:
                          - default text
                        databaseId: 527469
                        description: About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business About The
                          Business About The Business About The Business About The Business
                        enabledSiteIds: []
                        facebookUrl: null
                        folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9
                        folderName: root
                        franchise: false
                        googleAdsPhone: null
                        googleVerificationStatus:
                          message: null
                          status: NOT_CONNECTED
                        googleplusUrl: null
                        hideAddress: false
                        id: TG9jYXRpb246NTI3NDY5
                        instagramUrl: null
                        isRestaurant: true
                        lastUpdatedDate: December 13, 2025
                        latitude: '38.5934167'
                        linkedinUrl: null
                        locationPhotos: []
                        longitude: '-121.4015013'
                        managedServiceSiteBuckets: []
                        managedServiceSites: []
                        moreHours: []
                        name: TEST
                        offeringsUrl: null
                        ownerEmail: null
                        ownerName: null
                        package: PREMIUM
                        paymentMethods: []
                        phone: '2003004000'
                        pinterestUrl: null
                        planId: 191
                        planName: Local Basic Monthly
                        postalCode: '95825'
                        publisherAttributes: []
                        reservationUrl: null
                        serviceItems: []
                        stateIso: AZ
                        stateName: Arizona
                        storeId: TEST
                        street: Fulton Ave
                        street1: '2330'
                        subCategoryId: 641
                        subCategoryName: Absinthe Bars
                        tagline: null
                        tags:
                        - all
                        temporarilyClosed: false
                        tiktokUrl: null
                        toplineMessage: null
                        toplineMessageText: null
                        twitterUrl: null
                        uid: 46e975b4-0e11-40fa-b949-43d84a1fa7c0
                        updatedAt: '2025-12-13T16:56:58.979Z'
                        videos: []
                        voiceStatus: 1
                        yearOfIncorporation: null
                        youtubeUrl: null
                    - cursor: TG9jYXRpb246NzEyMzAx
                      node:
                        accountId: 16154
                        addOns: []
                        additionalCategoryIds:
                        - 1943
                        - 1904
                        additionalCategoryNames:
                        - Bookkeeping Service
                        - Certified Public Accountants
                        additionalInfo: null
                        additionalPhones: []
                        approved: APPROVED
                        archivalScheduledAt: null
                        archived: false
                        archivedAt: null
                        bizUrl: null
                        bizUrlUtm: false
                        bookingUrl: null
                        businessHours:
                        - day: SUNDAY
                          slots:
                          - end: 05:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: MONDAY
                          slots:
                          - end: 05:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: TUESDAY
                          slots:
                          - end: 05:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: WEDNESDAY
                          slots:
                          - end: 05:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: THURSDAY
                          slots:
                          - end: 05:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: FRIDAY
                          slots:
                          - end: 09:30pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        - day: SATURDAY
                          slots:
                          - end: 05:00pm
                            start: 09:00am
                          specialDate: null
                          type: OPEN
                        cancellationScheduledAt: null
                        categoryId: 13
                        city: Ranchi
                        contentPreferredLanguage: ENGLISH
                        countryCode: '91'
                        countryIso: IN
                        createErrors: []
                        createdDate: March 29, 2022
                        customAttributes:
                        - archived: false
                          enumValues: []
                          name: ABC
                          slug: abc
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: NJL
                          slug: njl
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: ZZZ
                          slug: zzz
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ALL
                          slug: all
                          type: STRING
                          value:
                          - ss
                        - archived: false
                          enumValues:
                          - gulab jamun
                          - rasgulla
                          - ras malai
                          - jalebi
                          name: Dessets
                          slug: dessets
                          type: ENUM
                          value:
                          - gulab jamun
                        - archived: false
                          enumValues: []
                          name: Attrs
                          slug: attrs
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Attrs2
                          slug: attrs2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Toll-free Number
                          slug: toll-free_number
                          type: INTEGER
                          value:
                          - '80044637'
                        - archived: false
                          enumValues: []
                          name: amenities
                          slug: amenities
                          type: ARRAY
                          value:
                          - wifi
                          - wheelchair
                          - welcoming ceremony
                        - archived: false
                          enumValues: []
                          name: amenities02
                          slug: amenities02
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Amenities-check
                          slug: amenities-check
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues:
                          - Atr1
                          - atr2
                          - atr3
                          name: Prod_Attribute
                          slug: prod_attribute
                          type: ENUM
                          value:
                          - Atr1
                        - archived: false
                          enumValues: []
                          name: wifi available
                          slug: wifi_available
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: QQQQQQQ
                          slug: qqqqqqq
                          type: INTEGER
                          value:
                          - '123'
                        - archived: false
                          enumValues: []
                          name: int02
                          slug: int02
                          type: INTEGER
                          value: []
                        - archived: false
                          enumValues: []
                          name: Tasty
                          slug: tasty
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: dhdop
                          slug: dhdop
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Abstract
                          slug: abstract
                          type: ARRAY
                          value:
                          - abs1
                          - abs2
                          - abs3
                        - archived: false
                          enumValues: []
                          name: Senior Hours Required?
                          slug: senior_hours_required?
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: kafka_check_attribute
                          slug: kafka_check_attribute
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues: []
                          name: Parking
                          slug: parking
                          type: BOOLEAN
                          value:
                          - 'false'
                        - archived: false
                          enumValues: []
                          name: googlePlaceId
                          slug: googleplaceid
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: hoursComments
                          slug: hourscomments
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: isOpen
                          slug: isopen
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: has_bicycle_rack?
                          slug: has_bicycle_rack?
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues:
                          - one
                          - two
                          name: quick
                          slug: quick
                          type: ENUM
                          value:
                          - one
                        - archived: false
                          enumValues: []
                          name: instagramUrl
                          slug: instagramurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingFireEvent
                          slug: analyticstrackingfireevent
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: placeholderText
                          slug: placeholdertext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues:
                          - FRND
                          - MENMENMEN
                          - BARNEY
                          name: TV
                          slug: tv
                          type: ENUM
                          value:
                          - FRND
                        - archived: false
                          enumValues: []
                          name: notificationEmails
                          slug: notificationemails
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: joinUrl
                          slug: joinurl
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: account_att
                          slug: account_att
                          type: ARRAY
                          value:
                          - '1'
                          - '2'
                          - '4'
                          - '3'
                        - archived: false
                          enumValues: []
                          name: Post v2
                          slug: post_v2
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: testingthetest
                          slug: testingthetest
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: Test Attribute
                          slug: test_attribute
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: int0
                          slug: int0
                          type: INTEGER
                          value:
                          - '0'
                        - archived: false
                          enumValues: []
                          name: url_appointment
                          slug: url_appointment
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Slug
                          slug: slug
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: New Name
                          slug: new_name
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: test200
                          slug: test200
                          type: STRING
                          value:
                          - test test
                        - archived: false
                          enumValues: []
                          name: Name
                          slug: name
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Test Department '
                          slug: test_department_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Fresh Fish Section '
                          slug: fresh_fish_section_
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Test 28 11 22
                          slug: test_28_11_22
                          type: STRING
                          value:
                          - Test 28
                        - archived: false
                          enumValues: []
                          name: blablacar
                          slug: blablacar
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: requires temperature check customers
                          slug: requires_temperature_check_customers
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Custom Tee Point
                          slug: custom_tee_point
                          type: STRING
                          value:
                          - tess
                        - archived: false
                          enumValues: []
                          name: appointment_required
                          slug: appointment_required
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: requires masks customers
                          slug: requires_masks_customers
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: is black owned
                          slug: is_black_owned
                          type: BOOLEAN
                          value: []
                        - archived: false
                          enumValues: []
                          name: BewAttribute
                          slug: bewattribute
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: 'Pets 2 '
                          slug: pets_2_
                          type: ARRAY
                          value: []
                        - archived: false
                          enumValues: []
                          name: test214122
                          slug: test214122
                          type: STRING
                          value:
                          - test2
                        - archived: false
                          enumValues: []
                          name: Test123
                          slug: test123
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: ohiiiignore
                          slug: ohiiiignore
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: yesnotest
                          slug: yesnotest
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: account_leve_test_for_ext
                          slug: account_leve_test_for_ext
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Custom location ID
                          slug: custom_location_id
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: Account Attr
                          slug: account_attr
                          type: ARRAY
                          value:
                          - one
                          - two
                          - three
                        - archived: false
                          enumValues:
                          - b
                          - a
                          - c
                          name: enum01
                          slug: enum01
                          type: ENUM
                          value:
                          - a
                        - archived: false
                          enumValues: []
                          name: Paneer Speciality
                          slug: paneer_speciality
                          type: STRING
                          value:
                          - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg
                        - archived: false
                          enumValues: []
                          name: welcomes_lgbtq
                          slug: welcomes_lgbtq
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: Lgbtq+ friendly
                          slug: lgbtq+_friendly
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: analyticsTrackingScript
                          slug: analyticstrackingscript
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: test-os-attr3
                          slug: test-os-attr3
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: lead_photo_drive
                          slug: lead_photo_drive
                          type: STRING
                          value: []
                        - archived: false
                          enumValues: []
                          name: parcel
                          slug: parcel
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: test-os-attr1
                          slug: test-os-attr1
                          type: INTEGER
                          value: []
                        - archived: false
                          enumValues: []
                          name: global-attr-2
                          slug: global-attr-2
                          type: STRING
                          value:
                          - 'testing '
                        - archived: false
                          enumValues: []
                          name: bollean03
                          slug: bollean03
                          type: BOOLEAN
                          value:
                          - 'true'
                        - archived: false
                          enumValues: []
                          name: global-attr-1
                          slug: global-attr-1
                          type: STRING
                          value:
                          - '11111'
                        - archived: false
                          enumValues: []
                          name: KAM
                          slug: kam
                          type: STRING
                          value:
                          - default text
                        databaseId: 712301
                        description: We're taking strict measures to ensure that we secure the highest
                          quality of safety assurance. While we have resumed services we're operating
                          with a limited team. Thanks for your patience, as it may take longer than usual
                          to connect with us.
                        enabledSiteIds: []
                        facebookUrl: ''
                        folderId: be3603fb-0f2b-4821-829f-187c74af94f1
                        folderName: sanity32
                        franchise: false
                        googleAdsPhone: '9804011221'
                        googleVerificationStatus:
                          message: null
                          status: NOT_CONNECTED
                        googleplusUrl: null
                        hideAddress: false
                        id: TG9jYXRpb246NzEyMzAx
                        instagramUrl: null
                        isRestaurant: false
                        lastUpdatedDate: December 13, 2025
                        latitude: '23.0620179'
                        linkedinUrl: ''
                        locationPhotos:
                        - databaseId: 2675502
                          fileSize: 112456
                          id: TWVkaWFGaWxlOjI2NzU1MDI=
                          name: 75f5d498-2b00-455b-9061-5a0ce5c1ade2.jpg
                          starred: false
                          thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/61ad13a4-014d-43de-a994-214a4978ebd5.jpg
                          type: ADDITIONAL
                          url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/61ad13a4-014d-43de-a994-214a4978ebd5.jpg
                        - databaseId: 3162494
                          fileSize: 28449
                          id: TWVkaWFGaWxlOjMxNjI0OTQ=
                          name: Found_faces
                          starred: false
                          thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/e939ba52-1625-40a0-817a-79b759e10b5c.jpg
                          type: LOGO
                          url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/e939ba52-1625-40a0-817a-79b759e10b5c.jpg
                        - databaseId: 14165890
                          fileSize: 62140
                          id: TWVkaWFGaWxlOjE0MTY1ODkw
                          name: Screenshot_2025-07-17_at_9.00.07 PM.png
                          starred: false
                          thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/70b2b948b071e12cfd298916316b3732/d487dab1-609f-481e-9f12-f59713208364.png
                          type: ADDITIONAL
                          url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/70b2b948b071e12cfd298916316b3732/d487dab1-609f-481e-9f12-f59713208364.png
                        - databaseId: 3460831
                          fileSize: 87871
                          id: TWVkaWFGaWxlOjM0NjA4MzE=
                          name: insta_5_-16
                          starred: false
                          thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/33ef7986-96ed-47f3-9242-f8ee2a1d44c0.jpg
                          type: COVER
                          url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/33ef7986-96ed-47f3-9242-f8ee2a1d44c0.jpg
                        longitude: '84.9594127'
                        managedServiceSiteBuckets: []
                        managedServiceSites: []
                        moreHours: []
                        name: ZEwxc
                        offeringsUrl: null
                        ownerEmail: akshay@synup.com
                        ownerName: ''
                        package: PREMIUM
                        paymentMethods:
                        - VISA
                        - MASTERCARD
                        - APPLE_PAY
                        - PAYPAL
                        - ANDROID_PAY
                        phone: '1234567890'
                        pinterestUrl: null
                        planId: 86
                        planName: V2 Premium Slow + Fast Sites
                        postalCode: '835234'
                        publisherAttributes:
                        - attributeName: Additional categories
                          publisherName: GOOGLE
                          value:
                          - gcid:food_and_beverage_exporter
                        reservationUrl: null
                        serviceItems: []
                        stateIso: JH
                        stateName: Jharkhand
                        storeId: Aksh-test
                        street: House No 5, VILL Tapkara, PO-Mahugaon, PS, near paddy procurement godown,
                          Lapung
                        street1: ''
                        subCategoryId: 618
                        subCategoryName: Restaurant Supplies
                        tagline: ''
                        tags:
                        - all
                        - india
                        - bulk_adding
                        - abc
                        - sachit_test
                        - helloworld
                        - '20'
                        - teston30622
                        - adding
                        - 20bulkedit
                        - all380
                        - customdomain12
                        - space tag
                        - photos
                        - jrew01
                        temporarilyClosed: false
                        tiktokUrl: null
                        toplineMessage: null
                        toplineMessageText: null
                        twitterUrl: ''
                        uid: 03b78ddf-13af-40c9-b9a8-ffd2262304d5
                        updatedAt: '2025-12-13T17:00:50.670Z'
                        videos: []
                        voiceStatus: 3
                        yearOfIncorporation: 1990
                        youtubeUrl: null
                    pageInfo:
                      endCursor: TG9jYXRpb246NzEyMzAx
                      hasNextPage: true
                      hasPreviousPage: true
                      total: 22
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13651538-run
  /social-post-ideas/send-chat-message:
    post:
      summary: Send chat message
      deprecated: false
      description: '<span style="font-size: 14px;">

        Sends a message to an AI post-idea chat session and returns the assistant''s reply. The response
        may include a generated post idea card (`postCard`), follow-up action chips, and a series plan
        when relevant. Optionally attach `referenceImageUrls` for image-grounded generation.

        </span>'
      operationId: sendChatMessage
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendChatMessageRequest'
            example:
              sessionId: 7f3c1a2e-...
              message: Give me a post idea for our product launch
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      sendChatMessage:
                        $ref: '#/components/schemas/ChatMessageResponse'
                    x-apidog-orders:
                    - sendChatMessage
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140476-run
  /local-post-ideas/send-chat-message:
    post:
      summary: Send local chat message
      deprecated: false
      description: '<span style="font-size: 14px;">

        Sends a message to an AI post-idea chat session and returns the assistant''s reply. The response
        may include a generated post idea card (`postCard`), follow-up action chips, and a series plan
        when relevant. Optionally attach `referenceImageUrls` for image-grounded generation.

        </span>'
      operationId: sendLocalChatMessage
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendLocalChatMessageRequest'
            example:
              sessionId: 7f3c1a2e-...
              message: Give me a post idea for our weekend sale
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      sendLocalChatMessage:
                        $ref: '#/components/schemas/LocalChatMessageResponse'
                    x-apidog-orders:
                    - sendLocalChatMessage
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053287-run
  /social-post-ideas/series-posts:
    get:
      summary: Series posts
      deprecated: false
      description: '<span style="font-size: 14px;">

        Returns the posts belonging to a content series. Each item is a post idea (see Post idea for the
        full shape).

        </span>'
      operationId: seriesPosts
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: socialProfileId
        in: query
        description: Social profile ID.
        required: true
        example: 6f1c2a90-...
        schema:
          type: string
      - name: seriesId
        in: query
        description: ID of the content series.
        required: true
        example: 3a1f...
        schema:
          type: string
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      seriesPosts:
                        type: array
                        description: Posts in the series (see Post idea for the full shape).
                        items:
                          type: object
                          x-apidog-orders: []
                    x-apidog-orders:
                    - seriesPosts
                x-apidog-orders:
                - data
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140477-run
  /social-post-ideas/set-brand-image-credits:
    post:
      summary: Set brand image credits
      deprecated: false
      description: '<span style="font-size: 14px;">

        Sets the monthly image-generation credit limit for a brand (social profile) and whether image-credit
        metering is active.

        </span>'
      operationId: setBrandImageCredits
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetBrandImageCreditsRequest'
            example:
              socialProfileId: 6f1c2a90-...
              monthlyLimit: 100
              isActive: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      setBrandImageCredits:
                        $ref: '#/components/schemas/MutationResponse'
                    x-apidog-orders:
                    - setBrandImageCredits
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140480-run
  /local-post-ideas/set-location-image-credits:
    post:
      summary: Set location image credits
      deprecated: false
      description: '<span style="font-size: 14px;">

        Sets the monthly image-generation credit limit for a location and whether image-credit metering
        is active. Returns the updated credit status.

        </span>'
      operationId: setLocationImageCredits
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetLocationImageCreditsRequest'
            example:
              locationId: TG9jYXRpb246MQ==
              monthlyLimit: 100
              isActive: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      setLocationImageCredits:
                        $ref: '#/components/schemas/LocalImageCredits'
                    x-apidog-orders:
                    - setLocationImageCredits
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053288-run
  /social-post-ideas/start-chat-session:
    post:
      summary: Start chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Starts a new AI post-idea chat session for a brand (social profile). Optionally seed with an `intent`,
        a `mode`, and a subject (`subjectType`/`subjectId`) to anchor the conversation.

        </span>'
      operationId: startChatSession
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartChatSessionRequest'
            example:
              socialProfileId: 6f1c2a90-...
              mode: fast
              intent: idea
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      startChatSession:
                        $ref: '#/components/schemas/ChatSessionResponse'
                    x-apidog-orders:
                    - startChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140483-run
  /local-post-ideas/start-chat-session:
    post:
      summary: Start local chat session
      deprecated: false
      description: '<span style="font-size: 14px;">

        Starts a new AI post-idea chat session for a location. Optionally seed the session with an `intent`,
        a `mode` (e.g. fast), and a subject (`subjectType`/`subjectId`) to anchor the conversation to
        an existing idea or series.

        </span>'
      operationId: startLocalChatSession
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartLocalChatSessionRequest'
            example:
              locationId: TG9jYXRpb246MQ==
              mode: fast
              intent: idea
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      startLocalChatSession:
                        $ref: '#/components/schemas/LocalChatSessionResponse'
                    x-apidog-orders:
                    - startLocalChatSession
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053319-run
  /locations/photos/star:
    post:
      summary: Star/Unstar Location Photos
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API allows you to star or unstar photo(s)\
        \ for a specific location. A starred photo highlights its importance and increases its visibility\
        \ in certain displays.\n    \n:::caution[]\n<span style=\"font-size: 14px;\">\nA location can\
        \ have a maximum of 4 starred images. Attempting to star additional photos will result in an error.\n\
        Only additional photo types can be starred or unstarred. The logo and cover image cannot be starred.\
        \ \n</span>\n:::\n\nFor more details, refer to [Manage photos for your location](https://developer.synup.com/doc-833258.md).\
        \ \n\n</span>"
      operationId: starUnstarLocationPhotos
      tags:
      - Locations
      - Locations
      - Photos
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - locationId
                  - photoIds
                  - starred
                  properties:
                    locationId:
                      type: string
                      description: ID of the location containing the photos
                      examples:
                      - TG9jYXRpb246NTIxMzI0
                    photoIds:
                      type: array
                      description: 'List of Photo IDs to be starred/unstarred, which can found from query
                        locations

                        '
                      items:
                        type: string
                      examples:
                      - - TWVkaWFGaWxlOjg4MjY5Nw==
                        - TWVkaWFGaWxlOjg4MjY5OA==
                    starred:
                      type: boolean
                      description: true to star; false to unstar
                  x-apidog-orders:
                  - locationId
                  - photoIds
                  - starred
              x-apidog-orders:
              - input
            example:
              input:
                locationId: TG9jYXRpb246MTA4NzIxMQ==
                photoIds:
                - TWVkaWFGaWxlOjU2MzgyMDU=
                starred: true
      responses:
        '200':
          description: The response will provide details of the photos that were processed, whether successfully
            starred or unstarred. If any errors occur, the response will include error information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      starUnstarLocationPhotos:
                        type: object
                        properties:
                          success:
                            type: boolean
                          error:
                            type: 'null'
                          photos:
                            type: array
                            items:
                              type: object
                              properties:
                                databaseId:
                                  type: integer
                                fileSize:
                                  type: integer
                                id:
                                  type: string
                                name:
                                  type: string
                                starred:
                                  type: boolean
                                thumbnailUrl:
                                  type: string
                                type:
                                  type: string
                                url:
                                  type: string
                                publisherOverride:
                                  type: string
                              x-apidog-orders:
                              - databaseId
                              - fileSize
                              - id
                              - name
                              - starred
                              - thumbnailUrl
                              - type
                              - url
                              - publisherOverride
                        required:
                        - success
                        - error
                        - photos
                        x-apidog-orders:
                        - success
                        - error
                        - photos
                    required:
                    - starUnstarLocationPhotos
                    x-apidog-orders:
                    - starUnstarLocationPhotos
                required:
                - data
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      starUnstarLocationPhotos:
                        success: true
                        error: null
                        photos:
                        - databaseId: 5638205
                          fileSize: 95636
                          id: TWVkaWFGaWxlOjU2MzgyMDU=
                          name: 090f5748-2f84-405e-bd04-6cd42dad2496
                          starred: true
                          thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_7c7fdefb-c50d-4478-8b8e-957011444445.jpg
                          type: ADDITIONAL
                          url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/7c7fdefb-c50d-4478-8b8e-957011444445.jpg
                          publisherOverride: ''
                '2':
                  summary: Exception
                  value:
                    data:
                      starUnstarLocationPhotos:
                        success: false
                        error:
                          message: 'SY15013: Only additional photo types can be starred or unstarred'
                          contextInfo:
                          - key: null
                            value: null
                          code: SY15013
                        photos: []
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642393-run
  /local-post-ideas/suggest-posts-for-date:
    post:
      summary: Suggest local posts for date
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates suggested post ideas for a location on a specific date. Returns the generated ideas
        and a count.

        </span>'
      operationId: suggestLocalPostsForDate
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestLocalPostsForDateRequest'
            example:
              locationId: TG9jYXRpb246MQ==
              date: '2026-05-01'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      suggestLocalPostsForDate:
                        $ref: '#/components/schemas/LocalGenerateIdeasResponse'
                    x-apidog-orders:
                    - suggestLocalPostsForDate
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053321-run
  /social-post-ideas/suggest-posts-for-date:
    post:
      summary: Suggest posts for date
      deprecated: false
      description: '<span style="font-size: 14px;">

        Generates suggested social post ideas for a brand on a specific date. Returns the generated ideas
        and a pipeline ID.

        </span>'
      operationId: suggestPostsForDate
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestPostsForDateRequest'
            example:
              socialProfileId: 6f1c2a90-...
              date: '2026-05-01'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      suggestPostsForDate:
                        $ref: '#/components/schemas/GenerateIdeasResponse'
                    x-apidog-orders:
                    - suggestPostsForDate
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140486-run
  /social-post-ideas/switch-chat-mode:
    post:
      summary: Switch chat mode
      deprecated: false
      description: '<span style="font-size: 14px;">

        Switches the generation mode of an existing AI post-idea chat session.

        </span>'
      operationId: switchChatMode
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwitchChatModeRequest'
            example:
              sessionId: 7f3c1a2e-...
              mode: thorough
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      switchChatMode:
                        $ref: '#/components/schemas/ChatSessionResponse'
                    x-apidog-orders:
                    - switchChatMode
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140796-run
  /local-post-ideas/switch-chat-mode:
    post:
      summary: Switch local chat mode
      deprecated: false
      description: '<span style="font-size: 14px;">

        Switches the generation mode of an existing AI post-idea chat session (for example between a fast
        and a more thorough mode).

        </span>'
      operationId: switchLocalChatMode
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwitchLocalChatModeRequest'
            example:
              sessionId: 7f3c1a2e-...
              mode: thorough
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      switchLocalChatMode:
                        $ref: '#/components/schemas/LocalMutationResponse'
                    x-apidog-orders:
                    - switchLocalChatMode
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053323-run
  /api/v4/automations/temporary-close-location-with-reopening-date:
    post:
      summary: Temporary Close Location with a reopening date
      deprecated: false
      description: '<span style="font-size: 14px;">

        Temporary close a location with a reopening date.

        Note : Ensure your account has automation part of your subscriptions. This functionality is supported
        only for Google and Facebook Listings.

        </span>


        '
      tags:
      - Automations
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    name:
                      type: string
                    startDate:
                      type: string
                    startTime:
                      type: string
                    endDate:
                      type: string
                    locationId:
                      type: string
                  required:
                  - name
                  - startDate
                  - startTime
                  - endDate
                  - locationId
                  x-apidog-orders:
                  - name
                  - startDate
                  - startTime
                  - endDate
                  - locationId
              required:
              - input
              x-apidog-orders:
              - input
            example:
              input:
                name: Automation to temporary close a Location
                startDate: '2025-02-25'
                startTime: '10:59:51'
                endDate: '2025-02-28'
                locationId: '85006'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      createFlowFromRecipe:
                        type: object
                        properties:
                          success:
                            type: boolean
                          flow:
                            type: object
                            properties:
                              id:
                                type: string
                            required:
                            - id
                            x-apidog-orders:
                            - id
                        required:
                        - success
                        - flow
                        x-apidog-orders:
                        - success
                        - flow
                    required:
                    - createFlowFromRecipe
                    x-apidog-orders:
                    - createFlowFromRecipe
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  createFlowFromRecipe:
                    success: true
                    flow:
                      id: 52d903f2-6736-4012-930d-ec5872a690b3
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Automations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-19519030-run
  /local-post-ideas/trigger-pipeline:
    post:
      summary: Trigger local pipeline
      deprecated: false
      description: '<span style="font-size: 14px;">

        Triggers the full post-idea generation pipeline for a location. Returns a pipeline ID; poll Local
        pipeline status for progress.

        </span>'
      operationId: triggerLocalPipeline
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerLocalPipelineRequest'
            example:
              locationId: TG9jYXRpb246MQ==
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      triggerLocalPipeline:
                        $ref: '#/components/schemas/LocalTriggerPipelineResponse'
                    x-apidog-orders:
                    - triggerLocalPipeline
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053325-run
  /connected-accounts/trigger-matches:
    post:
      summary: Trigger New Matches
      deprecated: false
      description: "<span style=\"font-size: 14px;\">\nThis API fetches all locations from connected Google\
        \ My Business and Facebook Page profiles and attempts to match them with locations in your account.\n\
        \    \n**Behavior:**\n- Supports batch processing – multiple connected accounts can be processed\
        \ in a single request.\n- Matches locations based on business name, address, and other identifying\
        \ attributes.\n- Helps ensure consistency between external platforms and your account.\n</span>\n"
      tags:
      - Connected Accounts
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerMatchesRequest'
            example:
              input:
                connectedAccountIds:
                - 6eb312f7-df32-4d76-ad8a-26bcfeab601e
                - 7eb3q2f7-df34-4dt6-hd88-269cfoal6m1b
      responses:
        '200':
          description: Match triggering process initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerMatchesResponse'
              examples:
                '1':
                  summary: All accounts processed successfully
                  value:
                    data:
                      connectedAccountsTriggerMatches:
                        success: true
                '2':
                  summary: Some accounts failed to process
                  value:
                    data:
                      connectedAccountsTriggerMatches:
                        success: false
                        failedIds:
                        - 7eb3q2f7-df34-4dt6-hd88-269cfoal6m1b
          headers: {}
          x-apidog-name: OK
        '400':
          description: Invalid request - Missing or invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
      security: []
      x-apidog-folder: Connected Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13679897-run
  /social-post-ideas/trigger-pipeline:
    post:
      summary: Trigger pipeline
      deprecated: false
      description: '<span style="font-size: 14px;">

        Triggers the full social post-idea generation pipeline for a brand. Returns a pipeline ID; supply
        brand context (profile name, site URL, categories, hashtags, intent, content language) to steer
        generation.

        </span>'
      operationId: triggerPipeline
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerPipelineRequest'
            example:
              socialProfileId: 6f1c2a90-...
              profileName: Acme Co
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      triggerPipeline:
                        $ref: '#/components/schemas/TriggerPipelineResponse'
                    x-apidog-orders:
                    - triggerPipeline
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140799-run
  /users/update:
    post:
      summary: Update a User
      deprecated: false
      description: '<span style="font-size: 14px;">

        This API updates specific parameters associated with a user.


        Behavior:

        - Allows modifying user attributes such as name, email, or role.

        - It supports updating permissions and access settings.

        - Ensures only editable fields can be modified.



        </span>'
      tags:
      - User Management
      - User Management
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: false
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  required:
                  - id
                  - firstName
                  - roleId
                  properties:
                    id:
                      type: string
                      description: Base64 encoded user ID
                    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
                    roleId:
                      type: string
                      description: Base64 encoded role ID
                    phone:
                      type: string
                      description: User's phone number
                    archived:
                      type: boolean
                      description: User's archive status
                    directCustomer:
                      type: boolean
                      description: Whether the user is a direct customer
                  x-apidog-orders:
                  - id
                  - roleId
                  - firstName
                  - lastName
                  - email
                  - phone
                  - archived
                  - directCustomer
              x-apidog-orders:
              - input
            example:
              input:
                id: VXNlcjo5OTY0
                email: pttqa1+4186@gmail.com
                roleId: Q3VzdG9tUm9sZToxNzc4Mw==
                firstName: pttqa1+4187
                lastName: ''
                phone: ''
                archived: false
                directCustomer: true
      responses:
        '200':
          description: Successfully updated user
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      updateUser:
                        type: object
                        properties:
                          success:
                            type: boolean
                          errors:
                            type: array
                            items:
                              type: string
                          user:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Base64 encoded user ID
                              createdAt:
                                type: string
                                format: date-time
                              directCustomer:
                                type: boolean
                              email:
                                type: string
                                format: email
                              firstName:
                                type: string
                              lastName:
                                type: string
                              inviteStatus:
                                type: string
                                enum:
                                - RESEND_INVITE
                                - INVITE_SENT
                              customRole:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                x-apidog-orders:
                                - id
                                - name
                              accountId:
                                type: string
                              preferences:
                                type: object
                                properties:
                                  locale:
                                    type: string
                                  dateFormat:
                                    type: string
                                    nullable: true
                                  timezone:
                                    type: string
                                    nullable: true
                                  columnOrder:
                                    type: string
                                    nullable: true
                                x-apidog-orders:
                                - locale
                                - dateFormat
                                - timezone
                                - columnOrder
                            x-apidog-orders:
                            - id
                            - createdAt
                            - directCustomer
                            - email
                            - firstName
                            - lastName
                            - inviteStatus
                            - customRole
                            - accountId
                            - preferences
                        x-apidog-orders:
                        - success
                        - errors
                        - user
                    x-apidog-orders:
                    - updateUser
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: default
                  value:
                    data:
                      updateUser:
                        success: true
                        errors: []
                        user:
                          id: VXNlcjo5OTY0
                          createdAt: 2019-12-24 00:00:00 UTC
                          directCustomer: true
                          email: pttqa1+4187@gmail.com
                          firstName: pttqa1+4187
                          lastName: ''
                          inviteStatus: RESEND_INVITE
                          customRole:
                            id: Q3VzdG9tUm9sZToxNzc4Mw==
                            name: Manager
                          accountId: QWNjb3VudDoxMTA3Mw==
                '2':
                  summary: alternative
                  value:
                    data:
                      updateUser:
                        success: true
                        errors: []
                        user:
                          id: VXNlcjoxNjY4ODM=
                          createdAt: 2025-02-12 06:29:27 UTC
                          directCustomer: true
                          email: ritesh+000543@synup.com
                          firstName: pttqa1+4187
                          lastName: ''
                          inviteStatus: RESEND_INVITE
                          customRole:
                            id: Q3VzdG9tUm9sZTo1OTE5
                            name: District Manager(Read)
                          accountId: QWNjb3VudDoxNjE1NA==
                          preferences:
                            locale: en-US
                            dateFormat: null
                            timezone: null
                            columnOrder: null
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: User Management
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13997390-run
  /locations/update:
    post:
      summary: Update  business location
      deprecated: false
      description: '<span style="font-size: 14px;">


        ## Update Location


        This API allows you to modify the attributes of an existing location within your account. It enables
        businesses to keep their location data up to date by updating key details such as address, contact
        information, business hours, categories, and other metadata.


        :::info []

        <span style="font-size: 14px;">

        **Processing Time for Location Updates**

        Updates to location attributes including `enabledSiteIds` or `submissionDisabledSiteIds`, are
        processed asynchronously before they are accurately reflected across all publishers and within
        the system. Allow this time for updates to be reflected accurately.

        </span>

        :::

        </span>'
      operationId: createLocation
      tags:
      - Locations
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier in Base64 encoded format. Must be in the format `Location:<Location
                        ID>`
                    name:
                      type: string
                      description: Name of the business
                    archived:
                      type: boolean
                      description: Indicates if the location is archived. Read-only.
                      readOnly: true
                    archivedAt:
                      type: string
                      format: date-time
                      description: Timestamp when the location was archived. Read-only.
                      readOnly: true
                      nullable: true
                    billingPeriod:
                      type: string
                      description: Billing cycle period. Read-only.
                      readOnly: true
                      nullable: true
                    bizUrl:
                      type: string
                      description: URL of the business website
                    bookingUrl:
                      type: 'null'
                      description: URL for booking appointments. Applicable only for Food industry businesses
                    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: `<HH>:<MM>am` OR `<HH>:<MM>pm` '
                                end:
                                  type: string
                                  description: 'Closing time. Valid formats: `<HH>:<MM>am` OR `<HH>:<MM>pm` '
                              x-apidog-orders:
                              - start
                              - end
                              title: ''
                              x-apidog-ignore-properties: []
                            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:
                        - day
                        - slots
                        - type
                        x-apidog-ignore-properties: []
                    city:
                      type: string
                      description: City where the business is located
                    countryIso:
                      type: string
                      description: Country ISO code. Refer to the Places API for valid ISOs.
                    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-apidog-ignore-properties: []
                    description:
                      type: string
                      description: Detailed description of the business
                    facebookUrl:
                      type: string
                      description: URL of the business's Facebook page
                    googleAdsPhone:
                      type: string
                      description: Google Ads-specific phone number
                    hideAddress:
                      type: boolean
                      description: Set to true if location is a Service Area Business
                    instagramUrl:
                      type: string
                      description: URL of the business's Instagram page
                    linkedinUrl:
                      type: string
                      description: URL of the business's LinkedIn page
                    offeringsUrl:
                      type: 'null'
                      description: URL for listing business offerings. Applicable only for food industry
                        businesses
                    ownerEmail:
                      type: string
                      description: Email of the business owner
                    ownerName:
                      type: string
                      description: Name of the business owner
                    paymentMethods:
                      type: array
                      items:
                        type: string
                      description: Accepted payment methods ("VISA", "MASTERCARD", "AMEX", "CASH", "CHEQUE",
                        "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING", "INVOICE", "TRAVELERS_CHECK",
                        "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL", "ANDROID_PAY" )
                    phone:
                      type: string
                      description: "- Must follow the international **E.164 format**. [Ref here.](https://www.twilio.com/docs/glossary/what-e164)\n\
                        - Do not include the `+` sign or country code.\n- Remove parentheses and special\
                        \ characters.\n- Example:\n  - **Incorrect**: `(123)-456-7890`, `+1-123-456-7890`\n\
                        \  - **Correct**: `1234567890`"
                    additionalPhones:
                      type: array
                      items:
                        type: string
                      description: Additional contact phone numbers
                    pinterestUrl:
                      type: string
                      description: URL of the business's Pinterest page
                    postalCode:
                      type: string
                      description: Postal code of the business location
                    reservationUrl:
                      type: 'null'
                      description: URL for making reservations. Applicable only for restaurant only businesses.
                    serviceItems:
                      type: array
                      items:
                        type: string
                    stateIso:
                      type: string
                      description: State ISO code. Refer to the Places API for valid ISOs.
                    storeId:
                      type: 'null'
                      description: Unique store identifier. Must be unique across all locations.
                    street:
                      type: string
                      description: Street address of the business
                    street1:
                      type: string
                      description: Additional street address information
                    subCategoryId:
                      type: integer
                      description: 'ID of the subcategory the business belongs to '
                    additionalCategoryIds:
                      type: array
                      items:
                        type: string
                      description: Additional category IDs for the business
                    tagline:
                      type: string
                      description: Tagline of the business
                    tags:
                      type: array
                      items:
                        type: string
                    temporarilyClosed:
                      type: boolean
                      description: Set to true if the location's business hours should be marked as closed
                    tiktokUrl:
                      type: 'null'
                      description: URL of the business's TikTok page
                    twitterUrl:
                      type: string
                      description: URL of the business's Twitter page
                    videos:
                      type: array
                      items:
                        type: string
                      description: List of valid video URLs
                    yearOfIncorporation:
                      type: integer
                      description: Year the business was established
                    youtubeUrl:
                      type: 'null'
                      description: URL of the business's YouTube page
                    enabledSiteIds:
                      type: array
                      description: List of site IDs where the business details should be published
                      items:
                        type: integer
                    submissionDisabledSiteIds:
                      type: array
                      description: List of site IDs where the business details should not be published
                      items:
                        type: integer
                    placeActionLinks:
                      type: array
                      items:
                        type: object
                        properties:
                          placeActionType:
                            type: string
                            enum:
                            - APPOINTMENT
                            - ONLINE_APPOINTMENT
                            - DINING_RESERVATION
                            - FOOD_ORDERING
                            - FOOD_DELIVERY
                            - FOOD_TAKEOUT
                            x-apidog-enum:
                            - value: APPOINTMENT
                              name: ''
                              description: ''
                            - value: ONLINE_APPOINTMENT
                              name: ''
                              description: ''
                            - value: DINING_RESERVATION
                              name: ''
                              description: ''
                            - value: FOOD_ORDERING
                              name: ''
                              description: ''
                            - value: FOOD_DELIVERY
                              name: ''
                              description: ''
                            - value: FOOD_TAKEOUT
                              name: ''
                              description: ''
                            description: One of the valid types.
                          isPreferred:
                            type: boolean
                            description: Marks this link preferred for its type. At most one preferred
                              per type.
                          uri:
                            type: string
                            description: Destination URL.
                          name:
                            type: string
                            description: The link's identifier, returned by the read endpoints once the
                              link has synced to Google. Optional on write — include it (when available)
                              to target a specific saved link most accurately.
                          action:
                            type: string
                            description: add (default) or delete (for deleting saved uri)
                        x-apidog-orders:
                        - placeActionType
                        - isPreferred
                        - uri
                        - name
                        - action
                        required:
                        - placeActionType
                        - isPreferred
                        - uri
                        x-apidog-ignore-properties: []
                  required:
                  - id
                  - placeActionLinks
                  x-apidog-orders:
                  - id
                  - name
                  - archived
                  - archivedAt
                  - billingPeriod
                  - bizUrl
                  - bookingUrl
                  - 01JJYTM5NADNB62HTXK88E2KE0
                  - city
                  - countryIso
                  - customAttributes
                  - description
                  - facebookUrl
                  - googleAdsPhone
                  - hideAddress
                  - instagramUrl
                  - linkedinUrl
                  - offeringsUrl
                  - ownerEmail
                  - ownerName
                  - paymentMethods
                  - phone
                  - additionalPhones
                  - pinterestUrl
                  - postalCode
                  - reservationUrl
                  - serviceItems
                  - stateIso
                  - storeId
                  - street
                  - street1
                  - subCategoryId
                  - additionalCategoryIds
                  - tagline
                  - tags
                  - temporarilyClosed
                  - tiktokUrl
                  - twitterUrl
                  - videos
                  - yearOfIncorporation
                  - youtubeUrl
                  - enabledSiteIds
                  - submissionDisabledSiteIds
                  - placeActionLinks
                  x-apidog-refs:
                    01JJYTM5NADNB62HTXK88E2KE0:
                      $ref: '#/components/schemas/Business%20hours'
                  x-apidog-ignore-properties:
                  - businessHours
              required:
              - input
              x-apidog-orders:
              - input
              x-apidog-ignore-properties: []
            example:
              input:
                id: TG9jYXRpb246MTE4MjcxOA==
                name: Greenleaf Bakery 2
                businessHours:
                - day: SUNDAY
                  slots: null
                  specialDate: null
                  type: CLOSED
                - day: MONDAY
                  slots:
                  - end: 12:00pm
                    start: 08:00am
                  - end: 06:00pm
                    start: 01:00pm
                  specialDate: null
                  type: OPEN
                - day: TUESDAY
                  slots:
                  - end: 06:00pm
                    start: 08:00am
                  specialDate: null
                  type: OPEN
                - day: WEDNESDAY
                  slots:
                  - end: 06:00pm
                    start: 08:00am
                  specialDate: null
                  type: OPEN
                - day: THURSDAY
                  slots:
                  - end: 06:00pm
                    start: 08:00am
                  specialDate: null
                  type: OPEN
                - day: FRIDAY
                  slots:
                  - end: 06:00pm
                    start: 08:00am
                  specialDate: null
                  type: OPEN
                - day: SATURDAY
                  slots:
                  - end: 04:00pm
                    start: 08:00am
                  specialDate: null
                  type: OPEN
                - day: SPECIAL
                  slots:
                  - end: 04:00pm
                    start: 08:00am
                  specialDate: '2025-07-12'
                  type: OPEN
                placeActionLinks:
                - placeActionType: FOOD_ORDERING
                  uri: https://order.example.com
                  name: <link-name-if-synced>
                  action: delete
                - placeActionType: FOOD_ORDERING
                  uri: https://new-order.example.com
                  isPreferred: true
                  action: add
                - placeActionType: FOOD_ORDERING
                  uri: https://ordering.sample_discovered_url.com
                  isPreferred: false
                  action: add
      responses:
        '200':
          description: Location created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      updateLocation:
                        type: object
                        properties:
                          clientMutationId:
                            type: 'null'
                          errors:
                            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
                                    x-apidog-ignore-properties: []
                                message:
                                  type: string
                              x-apidog-orders:
                              - code
                              - contextInfo
                              - message
                              x-apidog-ignore-properties: []
                            description: Errors encountered during the location creation process, if any.
                              Null if no errors.
                            nullable: true
                          location:
                            type: object
                            properties:
                              accountId:
                                type: integer
                                description: Unique identifier of the account associated with the location.
                              additionalCategoryIds:
                                type: array
                                items:
                                  type: string
                                description: List of additional category IDs assigned to the location.
                              additionalInfo:
                                type: 'null'
                                description: Additional information about the location, if applicable.
                              additionalPhones:
                                type: array
                                items:
                                  type: string
                                description: List of additional phone numbers associated with the location.
                              archived:
                                type: boolean
                                description: Indicates whether the location has been archived.
                              archivedAt:
                                type: 'null'
                                description: Timestamp indicating when the location was archived, if applicable.
                              billingPeriod:
                                type: 'null'
                                description: Billing period associated with the location, if applicable.
                              bizUrl:
                                type: string
                                description: URL of the business website.
                              bookingUrl:
                                type: 'null'
                                description: URL for booking appointments with the business.
                              businessHours:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    day:
                                      type: string
                                      description: Day of the week.
                                    slots:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          end:
                                            type: string
                                            description: Closing time of the slot.
                                          start:
                                            type: string
                                            description: Opening time of the slot.
                                        required:
                                        - end
                                        - start
                                        x-apidog-orders:
                                        - end
                                        - start
                                        x-apidog-ignore-properties: []
                                      description: Time slots indicating when the business is open.
                                    specialDate:
                                      type: string
                                      description: Special date for business hours, if applicable.
                                      nullable: true
                                    type:
                                      type: string
                                      description: Type of business hour entry (e.g., OPEN, CLOSED).
                                  required:
                                  - day
                                  - slots
                                  - specialDate
                                  - type
                                  x-apidog-orders:
                                  - day
                                  - slots
                                  - specialDate
                                  - type
                                  x-apidog-ignore-properties: []
                                description: List of business hours for each day of the week.
                              categoryId:
                                type: integer
                                description: ID of the primary category assigned to the business.
                              city:
                                type: string
                                description: City where the business is located.
                              countryIso:
                                type: string
                                description: Country ISO code of the business location.
                              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
                                  required:
                                  - archived
                                  - enumValues
                                  - name
                                  - slug
                                  - type
                                  - value
                                  x-apidog-orders:
                                  - archived
                                  - enumValues
                                  - name
                                  - slug
                                  - type
                                  - value
                                  x-apidog-ignore-properties: []
                              databaseId:
                                type: integer
                                description: Internal id
                              description:
                                type: string
                                description: Detailed description of the business.
                              facebookUrl:
                                type: string
                                description: URL of the business's Facebook page.
                              folderId:
                                type: string
                              folderName:
                                type: string
                              googleAdsPhone:
                                type: string
                              googleplusUrl:
                                type: 'null'
                              hideAddress:
                                type: boolean
                                description: If the location is an SAB
                              id:
                                type: string
                                description: Encoded Location Id in base64 format. Location:<Location
                                  id>
                              instagramUrl:
                                type: string
                                description: URL of the business's Instagram profile.
                              isRestaurant:
                                type: boolean
                              latitude:
                                type: number
                              linkedinUrl:
                                type: string
                                description: URL of the business's LinkedIn profile.
                              locationPhotos:
                                type: array
                                items:
                                  type: string
                              longitude:
                                type: number
                              moreHours:
                                type: array
                                items:
                                  type: string
                                description: 'The time periods during which a location is open for certain
                                  types of business.

                                  Only for Google'
                              name:
                                type: string
                                description: Name of the business.
                              offeringsUrl:
                                type: 'null'
                                description: Menu URL
                              ownerEmail:
                                type: string
                                description: Email of the business owner.
                              ownerName:
                                type: string
                              package:
                                type: string
                              paymentMethods:
                                type: array
                                items:
                                  type: string
                                description: 'Accepted payment methods ("VISA", "MASTERCARD", "AMEX",
                                  "CASH", "CHEQUE", "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING",
                                  "INVOICE", "TRAVELERS_CHECK", "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL",
                                  "ANDROID_PAY" )

                                  '
                              phone:
                                type: string
                                description: Primary contact phone number.
                              pinterestUrl:
                                type: string
                              planId:
                                type: integer
                              planName:
                                type: string
                              postalCode:
                                type: string
                              publisherAttributes:
                                type: array
                                items:
                                  type: string
                              reservationUrl:
                                type: 'null'
                              serviceItems:
                                type: array
                                items:
                                  type: string
                              stateIso:
                                type: string
                                description: State ISO code of the business location.
                              storeId:
                                type: 'null'
                                description: Unique store identifier, if applicable.
                              street:
                                type: string
                                description: Street address of the business.
                              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-apidog-ignore-properties: []
                              subCategoryId:
                                type: integer
                              subCategoryName:
                                type: string
                              tagline:
                                type: string
                              tags:
                                type: array
                                items:
                                  type: string
                              temporarilyClosed:
                                type: boolean
                                description: Indicates whether the business is temporarily closed.
                              tiktokUrl:
                                type: 'null'
                              toplineMessage:
                                type: 'null'
                              toplineMessageText:
                                type: 'null'
                              twitterUrl:
                                type: string
                                description: URL of the business's Twitter profile.
                              videos:
                                type: array
                                items:
                                  type: string
                              yearOfIncorporation:
                                type: integer
                                description: Year in which the business was established.
                              youtubeUrl:
                                type: 'null'
                            required:
                            - accountId
                            - additionalCategoryIds
                            - additionalInfo
                            - additionalPhones
                            - archived
                            - archivedAt
                            - billingPeriod
                            - bizUrl
                            - bookingUrl
                            - businessHours
                            - 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
                            x-apidog-orders:
                            - accountId
                            - additionalCategoryIds
                            - additionalInfo
                            - additionalPhones
                            - archived
                            - archivedAt
                            - billingPeriod
                            - bizUrl
                            - bookingUrl
                            - businessHours
                            - 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
                            description: Details of the created location.
                            x-apidog-ignore-properties: []
                          success:
                            type: boolean
                            description: Indicates whether the location creation was successful.
                          warnings:
                            type: array
                            items:
                              type: string
                            description: List of warnings generated during the request processing, if
                              any.
                          code:
                            type: string
                        required:
                        - clientMutationId
                        - errors
                        - location
                        - success
                        - warnings
                        - code
                        x-apidog-orders:
                        - clientMutationId
                        - errors
                        - location
                        - success
                        - warnings
                        - code
                        description: Encapsulates details about the created location.
                        x-apidog-ignore-properties: []
                    required:
                    - updateLocation
                    x-apidog-orders:
                    - updateLocation
                    description: Contains the response data for the create location request.
                    x-apidog-ignore-properties: []
                required:
                - data
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      updateLocation:
                        clientMutationId: null
                        errors: null
                        location:
                          accountId: 16154
                          additionalCategoryIds: []
                          additionalInfo: null
                          additionalPhones:
                          - (415) 555-5678
                          - (415) 555-9012
                          archived: false
                          archivedAt: null
                          billingPeriod: null
                          bizUrl: https://www.greenleafbakery.com/
                          bookingUrl: null
                          businessHours:
                          - day: SUNDAY
                            slots: null
                            specialDate: null
                            type: CLOSED
                          - day: MONDAY
                            slots:
                            - end: 12:00pm
                              start: 08:00am
                            - end: 06:00pm
                              start: 01:00pm
                            specialDate: null
                            type: OPEN
                          - day: TUESDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: WEDNESDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: THURSDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: FRIDAY
                            slots:
                            - end: 06:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: SATURDAY
                            slots:
                            - end: 04:00pm
                              start: 08:00am
                            specialDate: null
                            type: OPEN
                          - day: SPECIAL
                            slots:
                            - end: 04:00pm
                              start: 08:00am
                            specialDate: '2025-07-12'
                            type: OPEN
                          categoryId: 1
                          city: San Francisco
                          countryIso: US
                          customAttributes:
                          - archived: false
                            enumValues: []
                            name: bollean01
                            slug: bollean01
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: KAM
                            slug: kam
                            type: STRING
                            value:
                            - ''
                          - archived: false
                            enumValues: []
                            name: P_Test01
                            slug: p_test01
                            type: STRING
                            value:
                            - one12
                          - archived: false
                            enumValues: []
                            name: ABC
                            slug: abc
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: NJL
                            slug: njl
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: ZZZ
                            slug: zzz
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: ALL
                            slug: all
                            type: STRING
                            value:
                            - ss
                          - archived: false
                            enumValues:
                            - gulab jamun
                            - rasgulla
                            - ras malai
                            - jalebi
                            name: Dessets
                            slug: dessets
                            type: ENUM
                            value:
                            - gulab jamun
                          - archived: false
                            enumValues: []
                            name: Attrs
                            slug: attrs
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Attrs2
                            slug: attrs2
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Toll-free Number
                            slug: toll-free_number
                            type: INTEGER
                            value:
                            - '80044637'
                          - archived: false
                            enumValues: []
                            name: amenities
                            slug: amenities
                            type: ARRAY
                            value:
                            - wifi
                            - wheelchair
                            - welcoming ceremony
                          - archived: false
                            enumValues: []
                            name: amenities02
                            slug: amenities02
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: Amenities-check
                            slug: amenities-check
                            type: BOOLEAN
                            value:
                            - 'false'
                          - archived: false
                            enumValues:
                            - Atr1
                            - atr2
                            - atr3
                            name: Prod_Attribute
                            slug: prod_attribute
                            type: ENUM
                            value:
                            - Atr1
                          - archived: false
                            enumValues: []
                            name: wifi available
                            slug: wifi_available
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: QQQQQQQ
                            slug: qqqqqqq
                            type: INTEGER
                            value:
                            - '123'
                          - archived: false
                            enumValues: []
                            name: int02
                            slug: int02
                            type: INTEGER
                            value: []
                          - archived: false
                            enumValues: []
                            name: Tasty
                            slug: tasty
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: dhdop
                            slug: dhdop
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Abstract
                            slug: abstract
                            type: ARRAY
                            value:
                            - abs1
                            - abs2
                            - abs3
                          - archived: false
                            enumValues: []
                            name: Senior Hours Required?
                            slug: senior_hours_required?
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: kafka_check_attribute
                            slug: kafka_check_attribute
                            type: ARRAY
                            value:
                            - one
                            - two
                            - three
                          - archived: false
                            enumValues: []
                            name: Parking
                            slug: parking
                            type: BOOLEAN
                            value:
                            - 'false'
                          - archived: false
                            enumValues: []
                            name: googlePlaceId
                            slug: googleplaceid
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: hoursComments
                            slug: hourscomments
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: isOpen
                            slug: isopen
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues: []
                            name: has_bicycle_rack?
                            slug: has_bicycle_rack?
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues:
                            - one
                            - two
                            name: quick
                            slug: quick
                            type: ENUM
                            value:
                            - one
                          - archived: false
                            enumValues: []
                            name: instagramUrl
                            slug: instagramurl
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: analyticsTrackingFireEvent
                            slug: analyticstrackingfireevent
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: placeholderText
                            slug: placeholdertext
                            type: STRING
                            value: []
                          - archived: false
                            enumValues:
                            - FRND
                            - MENMENMEN
                            - BARNEY
                            name: TV
                            slug: tv
                            type: ENUM
                            value:
                            - FRND
                          - archived: false
                            enumValues: []
                            name: notificationEmails
                            slug: notificationemails
                            type: ARRAY
                            value: []
                          - archived: false
                            enumValues: []
                            name: joinUrl
                            slug: joinurl
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: account_att
                            slug: account_att
                            type: ARRAY
                            value:
                            - '1'
                            - '2'
                            - '4'
                            - '3'
                          - archived: false
                            enumValues: []
                            name: Post v2
                            slug: post_v2
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: testingthetest
                            slug: testingthetest
                            type: INTEGER
                            value:
                            - '0'
                          - archived: false
                            enumValues: []
                            name: int0
                            slug: int0
                            type: INTEGER
                            value:
                            - '0'
                          - archived: false
                            enumValues: []
                            name: url_appointment
                            slug: url_appointment
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Slug
                            slug: slug
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: New Name
                            slug: new_name
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: test200
                            slug: test200
                            type: STRING
                            value:
                            - test test
                          - archived: false
                            enumValues: []
                            name: Name
                            slug: name
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: 'Test Department '
                            slug: test_department_
                            type: ARRAY
                            value: []
                          - archived: false
                            enumValues: []
                            name: 'Fresh Fish Section '
                            slug: fresh_fish_section_
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Test 28 11 22
                            slug: test_28_11_22
                            type: STRING
                            value:
                            - Test 28
                          - archived: false
                            enumValues: []
                            name: blablacar
                            slug: blablacar
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: requires temperature check customers
                            slug: requires_temperature_check_customers
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: Custom Tee Point
                            slug: custom_tee_point
                            type: STRING
                            value:
                            - tess
                          - archived: false
                            enumValues: []
                            name: appointment_required
                            slug: appointment_required
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: requires masks customers
                            slug: requires_masks_customers
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues: []
                            name: is black owned
                            slug: is_black_owned
                            type: BOOLEAN
                            value: []
                          - archived: false
                            enumValues: []
                            name: BewAttribute
                            slug: bewattribute
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: 'Pets 2 '
                            slug: pets_2_
                            type: ARRAY
                            value: []
                          - archived: false
                            enumValues: []
                            name: test214122
                            slug: test214122
                            type: STRING
                            value:
                            - test2
                          - archived: false
                            enumValues: []
                            name: Test123
                            slug: test123
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: ohiiiignore
                            slug: ohiiiignore
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: yesnotest
                            slug: yesnotest
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: account_leve_test_for_ext
                            slug: account_leve_test_for_ext
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Custom location ID
                            slug: custom_location_id
                            type: STRING
                            value: []
                          - archived: false
                            enumValues: []
                            name: Account Attr
                            slug: account_attr
                            type: ARRAY
                            value:
                            - one
                            - two
                            - three
                          - archived: false
                            enumValues:
                            - b
                            - a
                            - c
                            name: enum01
                            slug: enum01
                            type: ENUM
                            value:
                            - a
                          - archived: false
                            enumValues: []
                            name: Paneer Speciality
                            slug: paneer_speciality
                            type: STRING
                            value:
                            - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg
                          - archived: false
                            enumValues: []
                            name: welcomes_lgbtq
                            slug: welcomes_lgbtq
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: Lgbtq+ friendly
                            slug: lgbtq+_friendly
                            type: BOOLEAN
                            value:
                            - 'true'
                          - archived: false
                            enumValues: []
                            name: analyticsTrackingScript
                            slug: analyticstrackingscript
                            type: STRING
                            value: []
                          databaseId: 1182718
                          description: Greenleaf Bakery offers a delightful selection of organic and gluten-free
                            baked goods. Our mission is to provide fresh, handmade pastries and cakes
                            crafted with love and the finest ingredients. Visit us for a cozy experience
                            and enjoy our special seasonal treats!
                          facebookUrl: https://www.facebook.com/GreenleafBakery/
                          folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9
                          folderName: root
                          googleAdsPhone: '4155553456'
                          googleplusUrl: null
                          hideAddress: false
                          id: TG9jYXRpb246MTE4MjcxOA==
                          instagramUrl: https://www.instagram.com/greenleafbakery/
                          isRestaurant: false
                          latitude: 37.8273838
                          linkedinUrl: https://www.linkedin.com/company/greenleafbakery
                          locationPhotos: []
                          longitude: -122.3699943
                          moreHours: []
                          name: Greenleaf Bakery 2
                          offeringsUrl: null
                          ownerEmail: info@greenleafbakery.com
                          ownerName: Emma Thompson
                          package: PREMIUM
                          paymentMethods:
                          - VISA
                          - CASH
                          phone: '4155551239'
                          pinterestUrl: https://www.pinterest.com/greenleafbakery/
                          planId: 86
                          planName: V2 Premium Slow + Fast Sites
                          postalCode: '94107'
                          publisherAttributes: []
                          reservationUrl: null
                          serviceItems: []
                          stateIso: CA
                          storeId: null
                          street: 123 Maple Avenue 1
                          street1: Suite 2021
                          subCategory:
                            databaseId: 10
                            id: U3ViQ2F0ZWdvcnk6MTA=
                            name: Climbing
                            primary: true
                          subCategoryId: 10
                          subCategoryName: Climbing
                          tagline: Fresh. Organic. Delicious.
                          tags:
                          - all
                          - uiuu
                          - 110331jan225
                          temporarilyClosed: false
                          tiktokUrl: null
                          toplineMessage: null
                          toplineMessageText: null
                          twitterUrl: https://twitter.com/GreenleafBakery
                          videos: []
                          yearOfIncorporation: 2015
                          youtubeUrl: null
                        success: true
                        warnings: []
                '2':
                  summary: Exception - Missing business_hours
                  value:
                    data:
                      updateLocation:
                        clientMutationId: null
                        errors:
                        - code: SY10031
                          contextInfo:
                          - key: business_hours
                            value: '{"days"=>{"Monday"=>{"type"=>"split", "slots"=>[{"start"=>"08:00am",
                              "end"=>"12:00pm"}, {"start"=>"01:00pm", "end"=>"06:00pm"}]}, "Tuesday"=>{"type"=>"open",
                              "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Wednesday"=>{"type"=>"open",
                              "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Thursday"=>{"type"=>"open",
                              "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Friday"=>{"type"=>"open",
                              "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Saturday"=>{"type"=>"open",
                              "slots"=>[{"start"=>"08:00am", "end"=>"04:00pm"}]}, "2025-07-12"=>{"type"=>"open",
                              "slots"=>[{"start"=>"08:00am", "end"=>"04:00pm"}]}}}'
                          message: All days of the week should be included in the business hours
                        location: null
                        success: false
                        warnings: null
                '3':
                  summary: 'Invalid Business Hours: All Days Required'
                  value:
                    data:
                      updateLocation:
                        clientMutationId: null
                        errors:
                        - code: SY10092
                          contextInfo:
                          - key: business_hours
                            value: '{"days"=>{"Sunday"=>{"type"=>"closed"}}}'
                          message: Operational hours can not be closed for all days of the week
                        location: null
                        success: false
                        warnings: null
                '4':
                  summary: Exception
                  value:
                    errors:
                    - message: Variable "$input" got invalid value {"tenure":"Yearly","id":"TG9jYXRpb246MTE5NTI1OQ==","name":"Greenleaf
                        Bakery 2","businessHours":[{"day":"SUNDAY","slots":null,"specialDate":null,"type":"CLOSED"},{"day":"MONDAY","slots":[{"end":"12:00pm","start":"08:00am"},{"end":"06:00pm","start":"01:00pm"}],"specialDate":null,"type":"OPEN"},{"day":"TUESDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"WEDNESDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"THURSDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"FRIDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"SATURDAY","slots":[{"end":"04:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"SPECIAL","slots":[{"end":"04:00pm","start":"08:00am"}],"specialDate":"2025-07-12","type":"OPEN"}]};
                        Field "tenure" is not defined by type UpdateLocationInput.
          headers: {}
          x-apidog-name: OK
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13640375-run
  /social-post-ideas/update-extended-brand-config:
    post:
      summary: Update extended brand config
      deprecated: false
      description: '<span style="font-size: 14px;">

        Creates or updates the extended generation config for a social profile — brand tone, target customers,
        contact/address, brand colors and logos, and the services/products/content-rules that ground social
        post-idea generation. Only the fields you send are changed. `services`, `products`, and `contentRules`
        are JSON values.

        </span>'
      operationId: updateExtendedBrandConfig
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExtendedBrandConfigRequest'
            example:
              socialProfileId: 6f1c2a90-...
              tone: playful
              targetCustomers: gen-z shoppers
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      updateExtendedBrandConfig:
                        $ref: '#/components/schemas/MutationResponse'
                    x-apidog-orders:
                    - updateExtendedBrandConfig
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140803-run
  /social-post-ideas/update-idea:
    post:
      summary: Update idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Updates an existing social post idea''s editable fields — title, content, status, call-to-action,
        scheduling, bucket, note, and target platforms. Only the fields you send are changed.

        </span>'
      operationId: updateIdea
      tags:
      - Social Post Ideas
      - Social Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIdeaRequest'
            example:
              ideaId: 91b2...
              title: Summer Launch
              status: scheduled
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      updateIdea:
                        $ref: '#/components/schemas/RegenerateResponse'
                    x-apidog-orders:
                    - updateIdea
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Social Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40140804-run
  /local-post-ideas/update-idea:
    post:
      summary: Update local idea
      deprecated: false
      description: '<span style="font-size: 14px;">

        Updates an existing post idea''s editable fields — title, content, status, call-to-action, scheduling,
        bucket, note, and target platforms. Only the fields you send are changed.

        </span>'
      operationId: updateLocalIdea
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocalIdeaRequest'
            example:
              ideaId: 91b2...
              title: Weekend Sale!
              status: scheduled
              scheduledDate: '2026-05-01'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      updateLocalIdea:
                        $ref: '#/components/schemas/LocalRegenerateResponse'
                    x-apidog-orders:
                    - updateLocalIdea
                    x--orders:
                    - updateLocalIdea
                    x--ignore-properties: []
                x-apidog-orders:
                - data
                x--orders:
                - data
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x--orders: []
                x--ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053326-run
  /menus/{menuId}/currency:
    put:
      summary: Update menu currency
      deprecated: false
      description: ''
      tags:
      - Menus
      parameters:
      - name: menuId
        in: path
        description: ''
        required: true
        example: ''
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Authorization
        in: header
        description: ''
        required: true
        example: API VGLYvxxxxxxxxxxxxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  properties:
                    currencyCode:
                      type: string
                  required:
                  - currencyCode
              required:
              - input
            example:
              input:
                currencyCode: us_usd
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Menus
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-33169808-run
  /locations/photos:
    post:
      summary: Upload Photos to a Location
      deprecated: false
      description: "<br>\n<span style=\"font-size: 14px;\">\n\nThis API allows you to add photos to a\
        \ specific location. Photos can be of different types, including logos, cover photos, and additional\
        \ images. \n\n\n:::info[]\n <span style=\"font-size: 14px;\">Each location can only have one logo\
        \ and one cover photo.</span>\n:::\n\nFor more details, refer to [Manage photos for your location](https://developer.synup.com/doc-833258.md).\n\
        \n\n\n\n</span>\n"
      operationId: uploadSingleLocationPhoto
      tags:
      - Locations
      - Locations
      - Photos
      parameters:
      - name: Authorization
        in: header
        description: API key for authentication
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - input
              properties:
                input:
                  type: object
                  required:
                  - locationId
                  - photos
                  properties:
                    locationId:
                      type: string
                      description: The ID of the location for which photos will be added
                      examples:
                      - TG9jYXRpb246MTA4NzIxMQ==
                    photos:
                      type: array
                      items:
                        type: object
                        required:
                        - photo
                        - type
                        properties:
                          photo:
                            type: string
                            format: uri
                            description: URL of the image
                            examples:
                            - https://via.placeholder.com/250?text=LOGO+Placeholder
                            - https://via.placeholder.com/800x400?text=COVER+Placeholder
                            - https://via.placeholder.com/600x400?text=ADDITIONAL+Image
                            x-apidog-mock: '{{$image.url}}'
                          type:
                            type: string
                            description: Type of photo
                            enum:
                            - LOGO
                            - COVER
                            - ADDITIONAL
                            examples:
                            - LOGO
                            - COVER
                            - ADDITIONAL
                            x-apidog-enum:
                            - value: LOGO
                              name: ''
                              description: Business logo image.
                            - value: COVER
                              name: ''
                              description: Main cover photo for the business.
                            - value: ADDITIONAL
                              name: ''
                              description: Additional images of the business.
                            x-apidog-mock: LOGO
                        x-apidog-orders:
                        - photo
                        - type
                  x-apidog-orders:
                  - locationId
                  - photos
              x-apidog-orders:
              - input
            example:
              input:
                locationId: TG9jYXRpb246MTA4NzIxMQ==
                photos:
                - photo: https://via.placeholder.com/250?text=LOGO+Placeholder
                  type: LOGO
                - photo: https://via.placeholder.com/800x400?text=COVER+Placeholder
                  type: COVER
                - photo: https://via.placeholder.com/600x400?text=ADDITIONAL+Image
                  type: ADDITIONAL
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addLocationPhotos:
                        type: object
                        properties:
                          success:
                            type: boolean
                          errors:
                            type: 'null'
                          photos:
                            type: array
                            items:
                              type: object
                              properties:
                                databaseId:
                                  type: integer
                                fileSize:
                                  type: integer
                                id:
                                  type: string
                                name:
                                  type: string
                                starred:
                                  type: 'null'
                                thumbnailUrl:
                                  type: string
                                type:
                                  type: string
                                url:
                                  type: string
                                publisherOverride:
                                  type: string
                              required:
                              - databaseId
                              - fileSize
                              - id
                              - name
                              - starred
                              - thumbnailUrl
                              - type
                              - url
                              - publisherOverride
                              x-apidog-orders:
                              - databaseId
                              - fileSize
                              - id
                              - name
                              - starred
                              - thumbnailUrl
                              - type
                              - url
                              - publisherOverride
                          request:
                            type: object
                            properties:
                              requestId:
                                type: 'null'
                              status:
                                type: 'null'
                            required:
                            - requestId
                            - status
                            x-apidog-orders:
                            - requestId
                            - status
                          clientMutationId:
                            type: 'null'
                        required:
                        - success
                        - errors
                        - photos
                        - request
                        - clientMutationId
                        x-apidog-orders:
                        - success
                        - errors
                        - photos
                        - request
                        - clientMutationId
                    required:
                    - addLocationPhotos
                    x-apidog-orders:
                    - addLocationPhotos
                required:
                - data
                x-apidog-orders:
                - data
              examples:
                '1':
                  summary: Success
                  value:
                    data:
                      addLocationPhotos:
                        success: true
                        errors: null
                        photos:
                        - databaseId: 5878931
                          fileSize: 48796
                          id: TWVkaWFGaWxlOjU4Nzg5MzE=
                          name: 24ac8063-9289-43ef-9324-56627f7e1df1
                          starred: null
                          thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_f47d62a6-fe4a-432d-a20a-db41c4c04d51.jpg
                          type: LOGO
                          url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/f47d62a6-fe4a-432d-a20a-db41c4c04d51.jpg
                          publisherOverride: ''
                        - databaseId: 5878932
                          fileSize: 95636
                          id: TWVkaWFGaWxlOjU4Nzg5MzI=
                          name: dd443241-48e5-43d2-83f6-a7e4bd2bb86f
                          starred: null
                          thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_ef4ffb12-aeb8-41b5-b03f-fbefa8106f79.jpg
                          type: COVER
                          url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/ef4ffb12-aeb8-41b5-b03f-fbefa8106f79.jpg
                          publisherOverride: ''
                        - databaseId: 5878933
                          fileSize: 95636
                          id: TWVkaWFGaWxlOjU4Nzg5MzM=
                          name: a460e19a-24ef-4cab-abb1-f7f0227f1b84
                          starred: null
                          thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_8f734e46-ed72-41e2-8d70-e19b275f23e3.jpg
                          type: ADDITIONAL
                          url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/8f734e46-ed72-41e2-8d70-e19b275f23e3.jpg
                          publisherOverride: ''
                        request:
                          requestId: null
                          status: null
                        clientMutationId: null
                '2':
                  summary: Exception
                  value:
                    data:
                      addLocationPhotos:
                        success: false
                        errors:
                          message: 'SY10067: Logo/Cover image size should be between 10KB and 5MB'
          headers: {}
          x-apidog-name: Example Response
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                    - Variable "$input" got invalid value {"locationId":"TG9jYXRpb246MTA4NzIxMQ==","photos":[{"photo":"https://pngimg.com/uploads/minus/minus_PNG40.png","type":"NON
                      EXISTENT"}]}; Expected type LocationMediaType at value.photos[0].type.
                required:
                - message
                x-apidog-orders:
                - message
          headers: {}
          x-apidog-name: Invalid input
        x-200:Example Response (Over 30 Photos):
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addLocationPhotos:
                        type: object
                        properties:
                          success:
                            type: boolean
                          errors:
                            type: 'null'
                          photos:
                            type: array
                            items:
                              type: string
                          request:
                            type: object
                            properties:
                              requestId:
                                type: string
                              status:
                                type: string
                            required:
                            - requestId
                            - status
                            x-apidog-orders:
                            - requestId
                            - status
                          clientMutationId:
                            type: 'null'
                        required:
                        - success
                        - errors
                        - photos
                        - request
                        - clientMutationId
                        x-apidog-orders:
                        - success
                        - errors
                        - photos
                        - request
                        - clientMutationId
                    required:
                    - addLocationPhotos
                    x-apidog-orders:
                    - addLocationPhotos
                required:
                - data
                x-apidog-orders:
                - data
              example:
                data:
                  addLocationPhotos:
                    success: true
                    errors: null
                    photos: []
                    request:
                      requestId: e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a
                      status: PROCCESSING
                    clientMutationId: null
          headers: {}
          x-apidog-name: Example Response (Over 30 Photos)
      security: []
      x-apidog-folder: Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642280-run
  /local-post-ideas/upsert-extended-location-config:
    post:
      summary: Upsert extended location config
      deprecated: false
      description: '<span style="font-size: 14px;">

        Creates or updates the extended generation config for a location — brand tone, target customers,
        contact/address, brand colors and logos, and the services/products/content-rules that ground post-idea
        generation. Only the fields you send are changed. `services`, `products`, and `contentRules` are
        JSON values.

        </span>'
      operationId: upsertExtendedLocationConfig
      tags:
      - Local Post Ideas
      - Local Post Ideas
      parameters:
      - name: Synup-Version
        in: header
        description: API version date (YYYY-MM-DD).
        required: true
        example: '2026-04-17'
        schema:
          type: string
      - name: Authorization
        in: header
        description: API key for authentication.
        required: true
        example: API T9V35W3xxxxxxxxxxx
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertExtendedLocationConfigRequest'
            example:
              locationId: TG9jYXRpb246MQ==
              tone: friendly
              targetCustomers: families
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      upsertExtendedLocationConfig:
                        $ref: '#/components/schemas/LocalMutationResponse'
                    x-apidog-orders:
                    - upsertExtendedLocationConfig
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Local Post Ideas
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40053377-run
components:
  schemas:
    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: `<HH>:<MM>am` OR `<HH>:<MM>pm` '
                    end:
                      type: string
                      description: 'Closing time. Valid formats: `<HH>:<MM>am` OR `<HH>:<MM>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.

                For GMB accounts: Encode `GmbLocationMatchedData:{matchedDataDatabaseId}`

                For FB accounts: Encode `FbLocationMatchedData:{matchedDataDatabaseId}`

                '
              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.

                    Returns false if any match failed to confirm.

                    '
                failedIds:
                  type: array
                  description: 'List of original (non-encoded) match record IDs that failed to confirm.

                    Only present when some matches fail.

                    '
                  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.

                This is typically a base64 encoded string.

                '
              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.

                    Returns null on successful connection.

                    '
                  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:

            * `CONNECTED_LOCATIONS_ISSUE` - Connected to inaccessible listings

            * `CREDENTIALS_INVALIDATED` - Expired credentials

            '
          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

            Not 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.

                    Returns true if the account was successfully disconnected from the location.

                    '
              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:

            - Street address

            - Postal code

            - City

            - Phone number

            - Business name

            '
        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:

            * CREATED - Response submission created

            * COMPLETED - Response submission completed

            * CONFIRMED - Double confirmation from partner site

            * FAILED - Response submission failed

            '
      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:<id>`)
        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

            include `CONNECTED`, `NOT_CONNECTED`, `CONNECTION_ISSUE`, `EXPIRED`,

            `RENEW`, `MISSING`, `SUSPENDED`, etc.

            '
        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:

            * Created - Initial creation

            * Completed - Posted to partner site

            * Confirmed - Verified on partner site

            * Failed - Response posting failed

            '
      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.

                    Returns false if any account failed to process.

                    '
                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: ''