---
updatedAt: 2025-08-08T23:27:04.000Z
agentTools:
  projectIndex: https://docs.payarc.net/llms.txt
---

# Update (Disable) Webhooks

Use this endpoint to update or disable webhooks.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "payarc-sandbox",
    "version": "1.2.0"
  },
  "servers": [
    {
      "url": "https://testapi.payarc.net"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-default": "YourAPIBearerKey",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/webhooks/{id}": {
      "patch": {
        "summary": "Update (Disable) Webhooks",
        "description": "Use this endpoint to update or disable webhooks.",
        "operationId": "disable-webhooks",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "the encrypted id of the webhook. see the GET end point method",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "Accept",
            "in": "header",
            "description": "Indicates which content types, expressed as MIME types, the client is able to understand.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          },
          {
            "name": "Content-Type",
            "in": "header",
            "description": "Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded",
            "required": true,
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "description": "true/false to enable or disable the web hook"
                  },
                  "event_types": {
                    "type": "array",
                    "description": "Event that will trigger the web hook. One of those values: invoice.created, charge.created, subscription.created, subscription.updated, plan.created, plan.updated, plan.deleted, discount.created, discount.deleted, customer.created, customer.updated, customer.deleted, customer.card.added, customer.card.updated, customer.card.deleted, dispute.created, dispute.updated, refund.created, token.created, charge.captured charge.voided, subscription.cancelled, invoice.charge.success, invoice.charge.failed, dispute.won, dispute.lost, order.created, order.canceled, order.charged, order.charged.failure",
                    "items": {
                      "type": "string"
                    }
                  },
                  "url": {
                    "type": "string",
                    "description": "Url that will be invoked when event occurs"
                  }
                }
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "description": "true/false to enable or disable the web hook"
                  },
                  "event_types": {
                    "type": "array",
                    "description": "Event that will trigger the web hook. One of those values: invoice.created, charge.created, subscription.created, subscription.updated, plan.created, plan.updated, plan.deleted, discount.created, discount.deleted, customer.created, customer.updated, customer.deleted, customer.card.added, customer.card.updated, customer.card.deleted, dispute.created, dispute.updated, refund.created, token.created, charge.captured charge.voided, subscription.cancelled, invoice.charge.success, invoice.charge.failed, dispute.won, dispute.lost, order.created, order.canceled, order.charged, order.charged.failure",
                    "items": {
                      "type": "string"
                    }
                  },
                  "url": {
                    "type": "string",
                    "description": "Url that will be invoked when event occurs"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"data\": {\n    \"object\": \"WebHook\",\n    \"id\": \"A0jnNvqjDDRK34kl\",\n    \"event_types\": [\n      {\n        \"event_type\": \"plan.created\"\n      },\n      {\n        \"event_type\": \"customer.deleted\"\n      }\n    ],\n    \"url\": \"https://testdashboard.payarc.net/api/create-webhook\",\n    \"created_at\": 1726064305,\n    \"updated_at\": 1726064305,\n    \"enabled\": true\n  },\n  \"meta\": {\n    \"include\": [],\n    \"custom\": []\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "object": {
                          "type": "string",
                          "example": "WebHook"
                        },
                        "id": {
                          "type": "string",
                          "example": "A0jnNvqjDDRK34kl"
                        },
                        "event_types": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "event_type": {
                                "type": "string",
                                "example": "plan.created"
                              }
                            }
                          }
                        },
                        "url": {
                          "type": "string",
                          "example": "https://testdashboard.payarc.net/api/create-webhook"
                        },
                        "created_at": {
                          "type": "integer",
                          "example": 1726064305,
                          "default": 0
                        },
                        "updated_at": {
                          "type": "integer",
                          "example": 1726064305,
                          "default": 0
                        },
                        "enabled": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        }
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "include": {
                          "type": "array"
                        },
                        "custom": {
                          "type": "array"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "500",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"message\": \"server error\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "server error"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```