---
updatedAt: 2026-08-24T07:13:36.000Z
agentTools:
  projectIndex: https://docs.paymongo.com/llms.txt
---

# Update a touchpoint

Updates a touchpoint's display name within a scope.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "contact": {
      "name": "Payment Channels"
    },
    "description": "Orders API owns the full lifecycle of dine-in orders for the PayMongo Dine\npayment channel: creation, split/group payments, billing, fulfillment\ntracking, cancellation, and CSV export. It also manages the merchant\ncatalog (locations, touchpoints, categories, and items). Merchants\nintegrate via secret-key Basic Auth; internal services consume\npost-payment events through SQS.\n",
    "title": "Orders",
    "version": "1.0.0",
    "summary": "Dine-in order management, catalog, split payments, and post-payment lifecycle for PayMongo Dine.",
    "license": {
      "name": "PayMongo Internal",
      "identifier": "LicenseRef-PayMongo-Internal"
    },
    "x-paymongo-service-slug": "orders-api",
    "x-paymongo-service-tier": "tier-2",
    "x-paymongo-owner-slack": "#orders-api-channel",
    "x-paymongo-repo": "https://github.com/paymongo/orders-api",
    "x-paymongo-data-classification": "public"
  },
  "servers": [
    {
      "url": "https://orders-api.paymongo.com",
      "description": "Production"
    },
    {
      "url": "https://orders-api.paymongo-uat.com",
      "description": "UAT"
    },
    {
      "url": "https://orders-api.paymongo-stg.com",
      "description": "Staging"
    }
  ],
  "tags": [
    {
      "name": "Catalog",
      "description": "Merchant catalog management: locations, touchpoints, categories, and menu items."
    }
  ],
  "paths": {
    "/v1/touchpoints/{touchpoint_code}": {
      "patch": {
        "description": "Updates a touchpoint's display name within a scope.",
        "operationId": "update_touchpoint",
        "parameters": [
          {
            "description": "Touchpoint code",
            "example": "table-01",
            "in": "path",
            "name": "touchpoint_code",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Scope to a location (omit for the org root)",
            "example": "bgc-branch",
            "in": "query",
            "name": "location_slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateTouchpointRequestDTO"
              }
            }
          },
          "description": "Touchpoint fields to update",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ResponseRootDTO"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/TouchpointResponseDTO"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestErrorResponseRootDTO"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedErrorResponseRootDTO"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundErrorResponseRootDTO"
                }
              }
            }
          },
          "default": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseRootDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "BasicAuth": []
          }
        ],
        "summary": "Update a touchpoint",
        "tags": [
          "Catalog"
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Merchant secret-key authentication. Pass the PayMongo secret key (sk_live_* or sk_test_*) as the Basic Auth username with an empty password."
      }
    },
    "schemas": {
      "BadRequestErrorResponseRootDTO": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "invalid_request_body",
                  "type": "string"
                },
                "detail": {
                  "example": "The request body is malformed or failed validation.",
                  "type": "string"
                },
                "source": {
                  "properties": {
                    "pointer": {
                      "example": "/data/attributes/items",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "NotFoundErrorResponseRootDTO": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "not_found",
                  "type": "string"
                },
                "detail": {
                  "example": "The requested resource was not found.",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "TouchpointResponseDTO": {
        "properties": {
          "created_at": {
            "example": "2026-06-24 07:55:00+00:00",
            "type": "string"
          },
          "display_name": {
            "example": "Table 1",
            "type": "string"
          },
          "id": {
            "example": "tp_abc123",
            "type": "string"
          },
          "is_deleted": {
            "example": false,
            "type": "boolean"
          },
          "livemode": {
            "example": true,
            "type": "boolean"
          },
          "location_slug": {
            "description": "null for org-level touchpoints",
            "example": "bgc-branch",
            "type": "string"
          },
          "qr_target_url": {
            "example": "https://orders.paymongo.com/t/table-01",
            "type": "string"
          },
          "touchpoint_code": {
            "example": "table-01",
            "type": "string"
          },
          "updated_at": {
            "example": "2026-06-24 07:55:00+00:00",
            "type": "string"
          }
        },
        "type": "object"
      },
      "UnauthorizedErrorResponseRootDTO": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "code": {
                  "example": "unauthorized",
                  "type": "string"
                },
                "detail": {
                  "example": "Authentication is required or the provided credentials are invalid.",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "UpdateTouchpointRequestDTO": {
        "properties": {
          "display_name": {
            "example": "Table 1",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorDetail": {
        "description": "Details about a specific error",
        "properties": {
          "code": {
            "description": "Code is an application-specific error code, expressed as a string value.",
            "example": "invalid_request_body",
            "type": "string"
          },
          "detail": {
            "description": "Detail is a human-readable explanation specific to this occurrence of the problem.",
            "example": "Explanation of error code for this case",
            "type": "string"
          },
          "source": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Source"
              }
            ],
            "description": "Source is an object containing references to the primary source of the error"
          }
        },
        "type": "object"
      },
      "ErrorResponseRootDTO": {
        "description": "Standard error response containing one or more errors",
        "properties": {
          "errors": {
            "description": "Error objects MUST be returned as an array keyed by `errors` in the top level of a JSON:API document.",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "ResponseRootDTO": {
        "description": "Standard response containing data and its metadata if any",
        "properties": {
          "data": {},
          "has_more": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "Source": {
        "description": "Source of the error, providing context like JSON Pointer or query parameter",
        "properties": {
          "header": {
            "description": "Header indicates the name of a single request header which caused the error.",
            "example": "X-Header-Name",
            "type": "string"
          },
          "parameter": {
            "description": "Parameter indicates which URI query parameter caused the error.",
            "example": "field_name",
            "type": "string"
          },
          "pointer": {
            "description": "Pointer is a \"JSON Pointer\" [RFC6901] to the value in the request document that caused the error.",
            "example": "/data/customers/0/attributes/name",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```