Partially update a webhook

PATCH

/api/v1/partnership/webhooks/{id}/

const url = 'https://public.api.barestho.com/api/v1/partnership/webhooks/example/';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"url":"https://example.com","name":"example","is_enabled":true,"last_use_at":"2026-04-15T12:00:00Z","last_response_status_code":1,"last_response":{"additionalProperty":"example"},"subscribed_events":{"additionalProperty":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://public.api.barestho.com/api/v1/partnership/webhooks/example/ \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "name": "example", "is_enabled": true, "last_use_at": "2026-04-15T12:00:00Z", "last_response_status_code": 1, "last_response": { "additionalProperty": "example" }, "subscribed_events": { "additionalProperty": "example" } }'

Partially updates a webhook configuration. Only the fields included in the request body are modified. Useful for toggling is_enabled or updating the subscribed_events map without resending the full object.

Authorizations

basicAuth

Parameters

Path Parameters

required

string

The unique identifier of the webhook to partially update.

Request Body

Partial representation of a webhook used for PATCH requests. All fields are optional; only the fields present in the request body will be updated.

object

Unique numeric identifier for the webhook. Read-only; cannot be modified.

integer

created_at

ISO 8601 timestamp of webhook creation. Read-only.

string format: date-time

updated_at

ISO 8601 timestamp of the last webhook modification. Read-only.

string format: date-time

url

Updated target URL for event delivery. Must be a valid URI. Maximum 500 characters.

string format: uri

<= 500 characters

name

Updated human-readable label. Set to null to remove the label.

string

nullable <= 125 characters

is_enabled

Set to false to pause deliveries, or true to resume them.

boolean

last_use_at

ISO 8601 timestamp of the last delivery attempt. Managed by the server.

string format: date-time

nullable

last_response_status_code

HTTP status code from the most recent delivery response. Managed by the server.

integer

nullable <= 32767

last_response

Response body from the most recent delivery. Managed by the server.

object

key

additional properties

subscribed_events

Updated event subscription map. Replaces the existing subscription configuration entirely when provided.

object

key

additional properties

Example ^generated

{
  "url": "https://example.com",
  "name": "example",
  "is_enabled": true,
  "last_use_at": "2026-04-15T12:00:00Z",
  "last_response_status_code": 1,
  "last_response": {
    "additionalProperty": "example"
  },
  "subscribed_events": {
    "additionalProperty": "example"
  }
}

Partial representation of a webhook used for PATCH requests. All fields are optional; only the fields present in the request body will be updated.

object

Unique numeric identifier for the webhook. Read-only; cannot be modified.

integer

created_at

ISO 8601 timestamp of webhook creation. Read-only.

string format: date-time

updated_at

ISO 8601 timestamp of the last webhook modification. Read-only.

string format: date-time

url

Updated target URL for event delivery. Must be a valid URI. Maximum 500 characters.

string format: uri

<= 500 characters

name

Updated human-readable label. Set to null to remove the label.

string

nullable <= 125 characters

is_enabled

Set to false to pause deliveries, or true to resume them.

boolean

last_use_at

ISO 8601 timestamp of the last delivery attempt. Managed by the server.

string format: date-time

nullable

last_response_status_code

HTTP status code from the most recent delivery response. Managed by the server.

integer

nullable <= 32767

last_response

Response body from the most recent delivery. Managed by the server.

object

key

additional properties

subscribed_events

Updated event subscription map. Replaces the existing subscription configuration entirely when provided.

object

key

additional properties

Example ^generated

url=https%3A%2F%2Fexample.com&name=example&is_enabled=true&last_use_at=2026-04-15T12%3A00%3A00Z&last_response_status_code=1&additionalProperty=example&additionalProperty=example

Partial representation of a webhook used for PATCH requests. All fields are optional; only the fields present in the request body will be updated.

object

Unique numeric identifier for the webhook. Read-only; cannot be modified.

integer

created_at

ISO 8601 timestamp of webhook creation. Read-only.

string format: date-time

updated_at

ISO 8601 timestamp of the last webhook modification. Read-only.

string format: date-time

url

Updated target URL for event delivery. Must be a valid URI. Maximum 500 characters.

string format: uri

<= 500 characters

name

Updated human-readable label. Set to null to remove the label.

string

nullable <= 125 characters

is_enabled

Set to false to pause deliveries, or true to resume them.

boolean

last_use_at

ISO 8601 timestamp of the last delivery attempt. Managed by the server.

string format: date-time

nullable

last_response_status_code

HTTP status code from the most recent delivery response. Managed by the server.

integer

nullable <= 32767

last_response

Response body from the most recent delivery. Managed by the server.

object

key

additional properties

subscribed_events

Updated event subscription map. Replaces the existing subscription configuration entirely when provided.

object

key

additional properties

Responses

200

The webhook object after the partial update.

application/json

Partial representation of a webhook used for PATCH requests. All fields are optional; only the fields present in the request body will be updated.

object

Unique numeric identifier for the webhook. Read-only; cannot be modified.

integer

created_at

ISO 8601 timestamp of webhook creation. Read-only.

string format: date-time

updated_at

ISO 8601 timestamp of the last webhook modification. Read-only.

string format: date-time

url

Updated target URL for event delivery. Must be a valid URI. Maximum 500 characters.

string format: uri

<= 500 characters

name

Updated human-readable label. Set to null to remove the label.

string

nullable <= 125 characters

is_enabled

Set to false to pause deliveries, or true to resume them.

boolean

last_use_at

ISO 8601 timestamp of the last delivery attempt. Managed by the server.

string format: date-time

nullable

last_response_status_code

HTTP status code from the most recent delivery response. Managed by the server.

integer

nullable <= 32767

last_response

Response body from the most recent delivery. Managed by the server.

object

key

additional properties

subscribed_events

Updated event subscription map. Replaces the existing subscription configuration entirely when provided.

object

key

additional properties

Example ^generated

{
  "url": "https://example.com",
  "name": "example",
  "is_enabled": true,
  "last_use_at": "2026-04-15T12:00:00Z",
  "last_response_status_code": 1,
  "last_response": {
    "additionalProperty": "example"
  },
  "subscribed_events": {
    "additionalProperty": "example"
  }
}

Partially update a webhook

Authorizations

Parameters

Path Parameters

Request Body

Example generated

Example generated

Responses

200

Example generated

Example ^generated

Example ^generated

Example ^generated