putCommerceSubscriberBySubscriberidWithHttpInfo method

Future<Response> putCommerceSubscriberBySubscriberidWithHttpInfo(
  1. String subscriberid
)

Replace a subscriber outright

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. This is a true REPLACEMENT, not a merge: the stored row's key is preserved, but the body is decoded onto a FRESH entity, so every field the body omits is written back as its ZERO value. Patch is the verb for changing part of a row. The id is resolved inside the caller org's own namespace and an absent one is 404 before anything is written; a body that fails to decode is 400. Answers the stored result. Any valid access token reaches it. The token must also carry Admin, or ReadSubscriber and WriteSubscriber together.

Note: This method returns the HTTP Response.

Parameters:

  • String subscriberid (required):

Implementation

Future<Response> putCommerceSubscriberBySubscriberidWithHttpInfo(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,
    'PUT',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}