deleteCommerceSubscriberBySubscriberidWithHttpInfo method

Future<Response> deleteCommerceSubscriberBySubscriberidWithHttpInfo(
  1. String subscriberid
)

Delete a subscriber, keeping a recoverable copy

A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata. Writing one FIRES A WEBHOOK: subscriber.created on create and subscriber.updated on replace or patch, emitted BEFORE the write is known to have succeeded and carrying the row as sent, so the payload holds the raw email rather than the normalized one that gets stored. Removes the addressed row and answers 204 with no body. Before the live row goes it is written once more under a deleted tombstone kind, so a deletion leaves a recoverable copy rather than destroying the record outright — and a tombstone that cannot be written fails the call with 500 before anything is removed. The id is resolved inside the caller org's own namespace, so an absent or foreign id is 404. Any valid access token reaches it. The token must also carry Admin or WriteSubscriber.

Note: This method returns the HTTP Response.

Parameters:

  • String subscriberid (required):

Implementation

Future<Response> deleteCommerceSubscriberBySubscriberidWithHttpInfo(String subscriberid,) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/commerce/subscriber/{subscriberid}'
    .replaceAll('{subscriberid}', subscriberid);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'DELETE',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}