Patch Extension

PATCH/contributors/{contributorId}/extensions/{extensionId}/

API version

v2

Request method

PATCH

Operation ID

extension-patch-extension

---

Request

• contributorIdstring

  required
• extensionIdstring (uuid)

  required

Responses

Format

application/json

Description

The extension has been patched.

Schema documentation

• assetsarray of object

  required
  • Array[

    The following assets are the media that are associated with the extension and will be shown in extension details page.

  • *object

    The following assets are the media that are associated with the extension and will be shown in extension details page.

    • assetTypestring (one of: image, video)

      required
    • fileNamestring

      required
    • idstring (uuid)

      required

      The asset ID and reference ID to its file. Retrieve the file with this id on `/v2/files/{id}

    • indexinteger (≥ 0)

      required
  ]

backendComponentsobject

• extensionAddedToContextobject
  • urlstring (≥ 1 characters)

    required
• extensionInstanceRemovedFromContextobject
  • urlstring (≥ 1 characters)

    required
• extensionInstanceSecretRotatedobject
  • urlstring (≥ 1 characters)

    required
• extensionInstanceUpdatedobject
  • urlstring (≥ 1 characters)

    required

blockedboolean

contextstring (one of: project, customer)

contributorIdstring

required

deprecationobject

The Extension is deprecated by the contributor and will expire at the given date.

• deprecatedAtstring (date-time)

  required
• notestring
• successorIdstring (uuid)

  The ID of the successor extension.

descriptionstring

detailedDescriptionsobject

A detailed description of the capabilities of the extension.

• deobject

  required

  Language specific descriptions in various formats.

  • markdownstring (≥ 1 characters)

    required
  • plainstring (≥ 1 characters)
• enobject

  Language specific descriptions in various formats.

  • markdownstring (≥ 1 characters)

    required
  • plainstring (≥ 1 characters)

disabledboolean

externalFrontendsarray of object

• Array[
• *object
  • namestring

    required
  • urlstring

    required
]

frontendComponentsarray of object

• Array[
• *object
  • namestring

    required
  • urlstring

    required
]

frontendFragmentsobject

• *

functionalboolean

required

idstring (uuid)

required

logoRefIdstring (uuid)

This is the FileId of the Logo. Retrieve the file with this id on /v2/files/{logoRefId}.

namestring

required

publishedboolean

required

requestedChangesobject

• contextstring (one of: project, customer)
• scopesarray of string
  • Array[
  • *string
  ]

webhookUrlsobject

• extensionAddedToContextobject

  required
  • urlstring (≥ 1 characters)

    required
• extensionInstanceRemovedFromContextobject

  required
  • urlstring (≥ 1 characters)

    required
• extensionInstanceSecretRotatedobject

  required
  • urlstring (≥ 1 characters)

    required
• extensionInstanceUpdatedobject

  required
  • urlstring (≥ 1 characters)

    required

scopesarray of string

• Array[
• *string
]

secretsarray of object

required

• Array[
• *object
  • secretIdstring (uuid)

    required
  • usableUntilstring (date-time)
]

statestring (one of: enabled, blocked, disabled)

deprecated

statisticsobject

required

• amountOfInstancesinteger (≥ 0)

  The amout of instances for this extension. Accurate for the Contributor. Publicly rounded to the next lower hundred.

subTitleobject

A few words to promote your Extension.

• destring (≤ 40 characters)

  required
• enstring (≤ 40 characters)

supportobject

• emailstring
• phonestring

tagsarray of string

• Array[
• *string
]

verificationRequestedboolean

required

verifiedboolean

required

webhookUrlsobject

• extensionAddedToContextobject

  required
  • urlstring (≥ 1 characters)

    required
• extensionInstanceRemovedFromContextobject

  required
  • urlstring (≥ 1 characters)

    required
• extensionInstanceSecretRotatedobject

  required
  • urlstring (≥ 1 characters)

    required
• extensionInstanceUpdatedobject

  required
  • urlstring (≥ 1 characters)

    required

Example

{
  "assets": [
    {
      "assetType": "image",
      "fileName": "myFile.png",
      "id": "f0f86186-0a5a-45b2-aa33-502777496347",
      "index": 123
    }
  ],
  "backendComponents": {
    "extensionAddedToContext": {
      "url": "string"
    },
    "extensionInstanceRemovedFromContext": {
      "url": "string"
    },
    "extensionInstanceSecretRotated": {
      "url": "string"
    },
    "extensionInstanceUpdated": {
      "url": "string"
    }
  },
  "blocked": true,
  "context": "project",
  "contributorId": "string",
  "deprecation": {
    "deprecatedAt": "2025-03-12T00:29:29.615Z",
    "note": "This extension is no longer actively maintained. Please Use the successor extension instead.",
    "successorId": "f0f86186-0a5a-45b2-aa33-502777496347"
  },
  "description": "string",
  "detailedDescriptions": {
    "de": {
      "markdown": "string",
      "plain": "string"
    },
    "en": {
      "markdown": "string",
      "plain": "string"
    }
  },
  "disabled": true,
  "externalFrontends": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "frontendComponents": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "frontendFragments": {
    "string": null
  },
  "functional": true,
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "logoRefId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "name": "string",
  "published": true,
  "requestedChanges": {
    "context": "project",
    "scopes": [
      "string"
    ],
    "webhookUrls": {
      "extensionAddedToContext": {
        "url": "string"
      },
      "extensionInstanceRemovedFromContext": {
        "url": "string"
      },
      "extensionInstanceSecretRotated": {
        "url": "string"
      },
      "extensionInstanceUpdated": {
        "url": "string"
      }
    }
  },
  "scopes": [
    "string"
  ],
  "secrets": [
    {
      "secretId": "f0f86186-0a5a-45b2-aa33-502777496347",
      "usableUntil": "2025-03-12T00:29:29.615Z"
    }
  ],
  "state": "enabled",
  "statistics": {
    "amountOfInstances": 42
  },
  "subTitle": {
    "de": "Ping deine App an",
    "en": "Ping your app"
  },
  "support": {
    "email": "a.lovelace@example.com",
    "phone": "string"
  },
  "tags": [
    "string"
  ],
  "verificationRequested": true,
  "verified": true,
  "webhookUrls": {
    "extensionAddedToContext": {
      "url": "string"
    },
    "extensionInstanceRemovedFromContext": {
      "url": "string"
    },
    "extensionInstanceSecretRotated": {
      "url": "string"
    },
    "extensionInstanceUpdated": {
      "url": "string"
    }
  }
}

JSON Schema

{
  "properties": {
    "assets": {
      "items": {
        "description": "The following assets are the media that are associated with the extension and will be shown in extension details page.",
        "properties": {
          "assetType": {
            "enum": [
              "image",
              "video"
            ],
            "example": "image",
            "type": "string"
          },
          "fileName": {
            "example": "myFile.png",
            "type": "string"
          },
          "id": {
            "description": "The asset ID and reference ID to its file. Retrieve the file with this id on `/v2/files/{id}",
            "format": "uuid",
            "type": "string"
          },
          "index": {
            "example": 0,
            "maximum": 3,
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "fileName",
          "index",
          "assetType"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "backendComponents": {
      "deprecated": true,
      "properties": {
        "extensionAddedToContext": {
          "deprecated": true,
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        },
        "extensionInstanceRemovedFromContext": {
          "deprecated": true,
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        },
        "extensionInstanceSecretRotated": {
          "deprecated": true,
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        },
        "extensionInstanceUpdated": {
          "deprecated": true,
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        }
      },
      "type": "object"
    },
    "blocked": {
      "deprecated": true,
      "type": "boolean"
    },
    "context": {
      "enum": [
        "project",
        "customer"
      ],
      "type": "string"
    },
    "contributorId": {
      "type": "string"
    },
    "deprecation": {
      "description": "The Extension is deprecated by the contributor and will expire at the given date.",
      "properties": {
        "deprecatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "note": {
          "example": "This extension is no longer actively maintained. Please Use the successor extension instead.",
          "type": "string"
        },
        "successorId": {
          "description": "The ID of the successor extension.",
          "format": "uuid",
          "type": "string"
        }
      },
      "required": [
        "deprecatedAt"
      ],
      "type": "object"
    },
    "description": {
      "type": "string"
    },
    "detailedDescriptions": {
      "description": "A detailed description of the capabilities of the extension.",
      "properties": {
        "de": {
          "description": "Language specific descriptions in various formats.",
          "properties": {
            "markdown": {
              "minLength": 1,
              "type": "string"
            },
            "plain": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "markdown"
          ],
          "type": "object"
        },
        "en": {
          "description": "Language specific descriptions in various formats.",
          "properties": {
            "markdown": {
              "minLength": 1,
              "type": "string"
            },
            "plain": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "markdown"
          ],
          "type": "object"
        }
      },
      "required": [
        "de"
      ],
      "type": "object"
    },
    "disabled": {
      "type": "boolean"
    },
    "externalFrontends": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "url"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "frontendComponents": {
      "deprecated": true,
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "url"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "frontendFragments": {
      "additionalProperties": {
        "allOf": [
          {
            "properties": {
              "additionalProperties": {
                "additionalProperties": {
                  "type": "string"
                },
                "type": "object"
              }
            },
            "type": "object"
          },
          {
            "oneOf": [
              {
                "properties": {
                  "url": {
                    "type": "string"
                  }
                },
                "required": [
                  "url"
                ],
                "type": "object"
              }
            ]
          }
        ]
      },
      "type": "object"
    },
    "functional": {
      "type": "boolean"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "logoRefId": {
      "description": "This is the FileId of the Logo. Retrieve the file with this id on `/v2/files/{logoRefId}`.",
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "published": {
      "type": "boolean"
    },
    "requestedChanges": {
      "additionalProperties": false,
      "properties": {
        "context": {
          "enum": [
            "project",
            "customer"
          ],
          "type": "string"
        },
        "scopes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "webhookUrls": {
          "properties": {
            "extensionAddedToContext": {
              "properties": {
                "url": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "type": "object"
            },
            "extensionInstanceRemovedFromContext": {
              "properties": {
                "url": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "type": "object"
            },
            "extensionInstanceSecretRotated": {
              "properties": {
                "url": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "type": "object"
            },
            "extensionInstanceUpdated": {
              "properties": {
                "url": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "type": "object"
            }
          },
          "required": [
            "extensionAddedToContext",
            "extensionInstanceUpdated",
            "extensionInstanceSecretRotated",
            "extensionInstanceRemovedFromContext"
          ],
          "type": "object"
        }
      },
      "type": "object"
    },
    "scopes": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "secrets": {
      "items": {
        "properties": {
          "secretId": {
            "format": "uuid",
            "type": "string"
          },
          "usableUntil": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "secretId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "state": {
      "description": "deprecated",
      "enum": [
        "enabled",
        "blocked",
        "disabled"
      ],
      "type": "string"
    },
    "statistics": {
      "properties": {
        "amountOfInstances": {
          "description": "The amout of instances for this extension. Accurate for the Contributor. Publicly rounded to the next lower hundred.",
          "example": 42,
          "minimum": 0,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "subTitle": {
      "description": "A few words to promote your Extension.",
      "properties": {
        "de": {
          "example": "Ping deine App an",
          "maxLength": 40,
          "type": "string"
        },
        "en": {
          "example": "Ping your app",
          "maxLength": 40,
          "type": "string"
        }
      },
      "required": [
        "de"
      ],
      "type": "object"
    },
    "support": {
      "properties": {
        "email": {
          "example": "a.lovelace@example.com",
          "type": "string"
        },
        "phone": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "minItems": 0,
      "type": "array"
    },
    "verificationRequested": {
      "type": "boolean"
    },
    "verified": {
      "type": "boolean"
    },
    "webhookUrls": {
      "properties": {
        "extensionAddedToContext": {
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        },
        "extensionInstanceRemovedFromContext": {
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        },
        "extensionInstanceSecretRotated": {
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        },
        "extensionInstanceUpdated": {
          "properties": {
            "url": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        }
      },
      "required": [
        "extensionAddedToContext",
        "extensionInstanceUpdated",
        "extensionInstanceSecretRotated",
        "extensionInstanceRemovedFromContext"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "contributorId",
    "name",
    "statistics",
    "assets",
    "published",
    "verified",
    "verificationRequested",
    "functional",
    "secrets"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PATCH \
    -d '{"deprecation":{"deprecatedAt":"2025-03-12T00:29:29.635Z","note":"This extension is no longer actively maintained. Please Use the successor extension instead.","successorId":"f0f86186-0a5a-45b2-aa33-502777496347"},"description":"string","detailedDescriptions":{"de":{"markdown":"string","plain":"string"},"en":{"markdown":"string","plain":"string"}},"externalFrontends":[{"name":"string","url":"string"}],"frontendFragments":{"string":null},"name":"string","scopes":["string"],"subTitle":{"de":"Ping deine App an","en":"Ping your app"},"support":{"email":"a.lovelace@example.com","phone":"string"},"tags":["string"],"webhookUrls":{"extensionAddedToContext":{"url":"string"},"extensionInstanceRemovedFromContext":{"url":"string"},"extensionInstanceSecretRotated":{"url":"string"},"extensionInstanceUpdated":{"url":"string"}}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/contributors/string/extensions/f0f86186-0a5a-45b2-aa33-502777496347

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionPatchExtension({
  "contributorId": "string",
  "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "deprecation": {
      "deprecatedAt": "2025-03-12T00:29:29.635Z",
      "note": "This extension is no longer actively maintained. Please Use the successor extension instead.",
      "successorId": "f0f86186-0a5a-45b2-aa33-502777496347"
    },
    "description": "string",
    "detailedDescriptions": {
      "de": {
        "markdown": "string",
        "plain": "string"
      },
      "en": {
        "markdown": "string",
        "plain": "string"
      }
    },
    "externalFrontends": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "frontendFragments": {
      "string": null
    },
    "name": "string",
    "scopes": [
      "string"
    ],
    "subTitle": {
      "de": "Ping deine App an",
      "en": "Ping your app"
    },
    "support": {
      "email": "a.lovelace@example.com",
      "phone": "string"
    },
    "tags": [
      "string"
    ],
    "webhookUrls": {
      "extensionAddedToContext": {
        "url": "string"
      },
      "extensionInstanceRemovedFromContext": {
        "url": "string"
      },
      "extensionInstanceSecretRotated": {
        "url": "string"
      },
      "extensionInstanceUpdated": {
        "url": "string"
      }
    }
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionPatchExtension\ExtensionPatchExtensionRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionPatchExtension\ExtensionPatchExtensionRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// ExtensionPatchExtensionRequestBody to learn how to construct a valid instance
$body = new ExtensionPatchExtensionRequestBody(/* TODO: ... */);

$request = (new ExtensionPatchExtensionRequest(
  contributorId: "string",
  extensionId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->marketplace()->extensionPatchExtension($request);

var_dump($response->getBody();