patchGuideBlueprintByCollectionByIdWithHttpInfo method

Future<Response> patchGuideBlueprintByCollectionByIdWithHttpInfo(String collection, String id)

Edit — or retire — one item of the brand blueprint

Edits a single item of the brand blueprint by id and saves it as a NEW VERSION, answering the whole blueprint after the edit. collection is one of sections, steps, strategies or templates; anything else is 400, and an id that collection does not hold is 404. This is also the retire lever: {\"enabled\": false} takes an item out of every org's journey without deleting it or its history. SuperAdmin ONLY, like the rest of the authoring plane; a per-org admin is 403. The write is audited. The patch is a SHALLOW merge over the item's own top-level keys — a key you send replaces that key whole, a key you omit is left alone — and id is dropped from the patch before it is applied, so an edit can never rekey an item. That is why the body has no declarable shape: its keys are the patched item's, not this route's. Fail-closed on the WHOLE document, not just the item: the blueprint is re-validated after the merge, so a patch that would dangle a dependency, break the step DAG or empty the journey is 422 and nothing is saved. An empty patch is 400 and one over 16 MiB is 413.

Note: This method returns the HTTP Response.

Parameters:

• String collection (required):

• String id (required):

Implementation

Future<Response> patchGuideBlueprintByCollectionByIdWithHttpInfo(String collection, String id,) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/guide/blueprint/{collection}/{id}'
    .replaceAll('{collection}', collection)
    .replaceAll('{id}', id);

  // ignore: prefer_final_locals
  Object? postBody;

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

  const contentTypes = <String>[];


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