Google Business Profile Business Profile Mybusinessplaceactions Locations API

The Business Profile Mybusinessplaceactions Locations API from Google Business Profile — 2 operation(s) for business profile mybusinessplaceactions locations.

GitHub OpenAPI

Operations 5

PATCH /v1/locations/{locationsId}/placeActionLinks/{placeActionLinksId} Patch placeActionLinks #
DELETE /v1/locations/{locationsId}/placeActionLinks/{placeActionLinksId} Delete placeActionLinks #
GET /v1/locations/{locationsId}/placeActionLinks/{placeActionLinksId} Get placeActionLinks #
GET /v1/locations/{locationsId}/placeActionLinks List placeActionLinks #
POST /v1/locations/{locationsId}/placeActionLinks Create placeActionLinks #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/google-business-profile:google-business-profile-mybusinessplaceactions-locations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-business-profile-mybusinessplaceactions-locations-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: My Business Place Actions API Locations API
  version: v1
  description: Generated from Google's published Discovery document for My Business Place Actions API (mybusinessplaceactions
    v1, revision 20261110). 5 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
externalDocs:
  url: https://developers.google.com/my-business/
servers:
- url: https://mybusinessplaceactions.googleapis.com
paths:
  /v1/locations/{locationsId}/placeActionLinks/{placeActionLinksId}:
    patch:
      operationId: mybusinessplaceactions.locations.placeActionLinks.patch
      summary: Patch placeActionLinks
      description: Updates the specified place action link and returns it.
      parameters:
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      - name: placeActionLinksId
        in: path
        required: true
        description: Resource name segment (placeActionLinksId).
        schema:
          type: string
      - name: updateMask
        in: query
        required: false
        description: Required. The specific fields to update. The only editable fields are `uri`, `place_action_type`, `is_preferred`
          and `is_disabled`. If the updated link already exists at the same location with the same `place_action_type` and
          `uri`, fails with an `ALREADY_EXISTS` error.
        schema:
          type: string
          format: google-fieldmask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaceActionLink'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaceActionLink'
        4XX:
          content: &id001
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id001
          description: Error response (google.rpc.Status)
      security:
      - apiKey: []
      tags:
      - Locations
    delete:
      operationId: mybusinessplaceactions.locations.placeActionLinks.delete
      summary: Delete placeActionLinks
      description: Deletes a place action link from the specified location.
      parameters:
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      - name: placeActionLinksId
        in: path
        required: true
        description: Resource name segment (placeActionLinksId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
        4XX:
          content: &id002
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id002
          description: Error response (google.rpc.Status)
      security:
      - apiKey: []
      tags:
      - Locations
    get:
      operationId: mybusinessplaceactions.locations.placeActionLinks.get
      summary: Get placeActionLinks
      description: Gets the specified place action link.
      parameters:
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      - name: placeActionLinksId
        in: path
        required: true
        description: Resource name segment (placeActionLinksId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaceActionLink'
        4XX:
          content: &id003
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id003
          description: Error response (google.rpc.Status)
      security:
      - apiKey: []
      tags:
      - Locations
  /v1/locations/{locationsId}/placeActionLinks:
    get:
      operationId: mybusinessplaceactions.locations.placeActionLinks.list
      summary: List placeActionLinks
      description: Lists the place action links for the specified location.
      parameters:
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      - name: filter
        in: query
        required: false
        description: 'Optional. A filter constraining the place action links to return. The response includes entries that
          match the filter. We support only the following filter: 1. place_action_type=XYZ where XYZ is a valid PlaceActionType.'
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        description: Optional. How many place action links to return per page. Default of 10. The minimum is 1.
        schema:
          type: integer
          format: int32
      - name: pageToken
        in: query
        required: false
        description: Optional. If specified, returns the next page of place action links.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPlaceActionLinksResponse'
        4XX:
          content: &id004
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id004
          description: Error response (google.rpc.Status)
      security:
      - apiKey: []
      tags:
      - Locations
    post:
      operationId: mybusinessplaceactions.locations.placeActionLinks.create
      summary: Create placeActionLinks
      description: Creates a place action link associated with the specified location, and returns it. The request is considered
        duplicate if the `parent`, `place_action_link.uri` and `place_action_link.place_action_type` are the same as a previous
        request.
      parameters:
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaceActionLink'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaceActionLink'
        4XX:
          content: &id005
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id005
          description: Error response (google.rpc.Status)
      security:
      - apiKey: []
      tags:
      - Locations
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
  schemas:
    Empty:
      properties: {}
      description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
        A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc
        Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }'
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    ListPlaceActionLinksResponse:
      description: Response message for PlaceActions.ListPlaceActionLinks.
      type: object
      properties:
        placeActionLinks:
          items:
            $ref: '#/components/schemas/PlaceActionLink'
          description: The returned list of place action links.
          type: array
        nextPageToken:
          description: If there are more place action links than the requested page size, then this field is populated with
            a token to fetch the next page of results.
          type: string
    PlaceActionLink:
      description: Represents a place action link and its attributes.
      type: object
      properties:
        createTime:
          readOnly: true
          type: string
          format: google-datetime
          description: Output only. The time when the place action link was created.
        isDisabled:
          type: boolean
          description: Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled.
            If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`.
            If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to
            it.
        isPreferred:
          type: boolean
          description: Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred
            per place action type at a location. If a future request marks a different link as preferred for the same place
            action type, then the current preferred link (if any exists) will lose its preference.
        placeActionType:
          enum:
          - PLACE_ACTION_TYPE_UNSPECIFIED
          - APPOINTMENT
          - ONLINE_APPOINTMENT
          - DINING_RESERVATION
          - FOOD_ORDERING
          - FOOD_DELIVERY
          - FOOD_TAKEOUT
          - SHOP_ONLINE
          - SOLOPRENEUR_APPOINTMENT
          description: Required. The type of place action that can be performed using this link.
          type: string
        uri:
          description: Required. The link uri. The same uri can be reused for different action types across different locations.
            However, only one place action link is allowed for each unique combination of (uri, place action type, location).
          type: string
        isEditable:
          type: boolean
          description: Output only. Indicates whether this link can be edited by the client.
          readOnly: true
        updateTime:
          description: Output only. The time when the place action link was last modified.
          format: google-datetime
          type: string
          readOnly: true
        providerType:
          enum:
          - PROVIDER_TYPE_UNSPECIFIED
          - MERCHANT
          - AGGREGATOR_3P
          type: string
          readOnly: true
          description: Output only. Specifies the provider type.
        name:
          type: string
          description: Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`.
            The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating
            and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id`
            will be assigned by the server on successful creation of a new link and returned as part of the response.
x-provenance:
  method: harvested
  publisher: Google
  source: https://mybusinessplaceactions.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261110)