deleteByAppId method

Future<DynamiteResponse<WebhooksDeleteByAppIdResponseApplicationJson, void>> deleteByAppId({ required String appid, bool? oCSAPIRequest, })

Remove all existing webhook registration mapped to an AppAPI app id.

This endpoint requires admin access.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• appid id of the app, as in the EX-APP-ID for creation.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Integer number of registrations deleted
• 400: Bad request
• 403: Insufficient permissions

See:

• $deleteByAppId_Request for the request send by this method.
• $deleteByAppId_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<WebhooksDeleteByAppIdResponseApplicationJson, void>> deleteByAppId({
  required String appid,
  bool? oCSAPIRequest,
}) async {
  final _request = $deleteByAppId_Request(
    appid: appid,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $deleteByAppId_Serializer();
  return _i1.ResponseConverter<WebhooksDeleteByAppIdResponseApplicationJson, void>(_serializer).convert(_response);
}