Versions Compared

Version Old Version 1 New Version Current
Changes made by

Giovanni Di Prisco

Diego Foroni

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This API call allows you to delete a specific webhook configuration associated with a request type.

Endpoint

  • URL: /requestType/{id}/webhookConfigurations/{webhookConfigurationId}

  • Method: DELETE

Headers

Ensure you include the following headers in your request:

  • Accept: application/json

  • Content-Type: application/json

  • X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Parameters

  • id (required): The unique identifier for the request type.

  • webhookConfigurationId (required): The unique identifier for the webhook configuration, formatted as a UUID.

Example cURL API call

Code Block
languagejson
curl -X DELETE "https://test.onboarding.namirial.app/api/v2/requestType/YOUR_REQUEST_TYPE_ID/webhook/YOUR_WEBHOOK_CONFIGURATION_ID" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"

Responses

  • 204 No Content

    • Description: The resource was deleted successfully.

  • 400 Bad Request

    • Description: Bad Request described following Problem Details (RFC 9457).

    • Example Response:

      Code Block
      languagejson
      {
  "type": "about:blank",
  "status": 400,
  "title": "Request validation error",
  "detail": "The has a malformed body property.",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463",
  "retryable": false,
  "errors": [
    {
      "detail": "Property 'dummyField' is not defined in the schema and the schema does not allow additional properties.",
      "pointer": "/parameters/dummyField",
      "field": "dummyField",
      "reason": "additionalProperties"
    }
  ]
}

...