PUT/v2/membershipplan/{id}/publish

Mitgliedschaftsplan veröffentlichen

Setzt den Status auf published; prüft Texte, Steuer, Geltungsbereiche und serverseitigen Veröffentlichungs-Preflight. version muss dem letzten gelesenen Stand entsprechen; der Statuswechsel erhöht die Version und schreibt Audit/Outbox.

Operation-ID put_v2_membershipplan_id_publish

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: membershipplan · mepl
Levels: 3, 4
Dispatcher-Prüfung: Ja

Parameter

Pfadparameter

iderforderlich

v2 object identifier in the selected account.

string

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"membershipplan_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
  "examples": [
    "membershipplan_012345abcdef_123456"
  ]
}

Header

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data object erforderlich

version integer | number | string | boolean erforderlich

Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden.

request_id string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "version": {
          "type": [
            "integer",
            "number",
            "string",
            "boolean"
          ],
          "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
        },
        "request_id": {
          "type": "string"
        }
      },
      "additionalProperties": true,
      "required": [
        "version"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Mitgliedschaftsplan veröffentlichen

{
  "data": {
    "version": 1,
    "request_id": "demo-plan-publish"
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data enthält das dokumentierte Ergebnisobjekt; error=false und success=true.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id string erforderlich

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern: "^membershipplan_[a-f0-9]{12}_-?[0-9]+$"

version integer erforderlich

status string erforderlich

Erlaubte Werte

"draft""internal""published""archived"

name string erforderlich

description_html string erforderlich

language string erforderlich

validity object erforderlich

type string

Erlaubte Werte

"fixed_range""relative_duration""usage_count"

from integer | null

until integer | null

value integer | null

unit string | null

uses integer | null

promo_code_redemption boolean

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

discount object erforderlich

type string

Erlaubte Werte

"percent""fixed"

value string

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern: "^-?[0-9]+\\.[0-9]{2}$"

currency string | null

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

sale object erforderlich

amount string

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern: "^-?[0-9]+\\.[0-9]{2}$"

currency string

vat string | null

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern: "^vat_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

publication object erforderlich

design string | null

Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.

pattern: "^design_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

renewal object erforderlich

allowed boolean

default boolean

reminder_days integer

duration_value integer | null

duration_unit string | null

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

allow_parallel_instances boolean erforderlich

active_customer_count integer erforderlich

sort_order integer erforderlich

internal_reference string erforderlich

scopes array erforderlich

Array-Elemente

object

type string erforderlich

Erlaubte Werte

"root""category""offer"

resource string | null

v2 category-/offer-ID; bei root null.

id string

Eingabealias für resource.

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

published_at integer | null erforderlich

archived_at integer | null erforderlich

created_at integer erforderlich

updated_at integer erforderlich

texts object | array erforderlich

Sprachcode → Textobjekt; ohne Übersetzungen kann PHP [] liefern.

Array-Elemente

Typ nicht eingeschränkt

Schema für zusätzliche Felder

object

name string

description_html string

content_hash string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
        },
        "version": {
          "type": "integer"
        },
        "status": {
          "type": "string",
          "enum": [
            "draft",
            "internal",
            "published",
            "archived"
          ]
        },
        "name": {
          "type": "string"
        },
        "description_html": {
          "type": "string"
        },
        "language": {
          "type": "string"
        },
        "validity": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "fixed_range",
                "relative_duration",
                "usage_count"
              ]
            },
            "from": {
              "type": [
                "integer",
                "null"
              ]
            },
            "until": {
              "type": [
                "integer",
                "null"
              ]
            },
            "value": {
              "type": [
                "integer",
                "null"
              ]
            },
            "unit": {
              "type": [
                "string",
                "null"
              ]
            },
            "uses": {
              "type": [
                "integer",
                "null"
              ]
            },
            "promo_code_redemption": {
              "type": "boolean"
            }
          },
          "additionalProperties": true
        },
        "discount": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "percent",
                "fixed"
              ]
            },
            "value": {
              "type": "string",
              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
            },
            "currency": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "sale": {
          "type": "object",
          "properties": {
            "amount": {
              "type": "string",
              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
            },
            "currency": {
              "type": "string"
            },
            "vat": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            }
          },
          "additionalProperties": true
        },
        "publication": {
          "type": "object",
          "properties": {
            "design": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            }
          },
          "additionalProperties": true
        },
        "renewal": {
          "type": "object",
          "properties": {
            "allowed": {
              "type": "boolean"
            },
            "default": {
              "type": "boolean"
            },
            "reminder_days": {
              "type": "integer"
            },
            "duration_value": {
              "type": [
                "integer",
                "null"
              ]
            },
            "duration_unit": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "allow_parallel_instances": {
          "type": "boolean"
        },
        "active_customer_count": {
          "type": "integer"
        },
        "sort_order": {
          "type": "integer"
        },
        "internal_reference": {
          "type": "string"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "root",
                  "category",
                  "offer"
                ]
              },
              "resource": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "v2 category-/offer-ID; bei root null."
              },
              "id": {
                "type": "string",
                "description": "Eingabealias für resource."
              }
            },
            "additionalProperties": true,
            "required": [
              "type"
            ]
          }
        },
        "published_at": {
          "type": [
            "integer",
            "null"
          ]
        },
        "archived_at": {
          "type": [
            "integer",
            "null"
          ]
        },
        "created_at": {
          "type": "integer"
        },
        "updated_at": {
          "type": "integer"
        },
        "texts": {
          "type": [
            "object",
            "array"
          ],
          "additionalProperties": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "description_html": {
                "type": "string"
              },
              "content_hash": {
                "type": "string"
              }
            },
            "additionalProperties": true
          },
          "items": {},
          "description": "Sprachcode → Textobjekt; ohne Übersetzungen kann PHP [] liefern."
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "version",
        "status",
        "name",
        "description_html",
        "language",
        "validity",
        "discount",
        "sale",
        "publication",
        "renewal",
        "allow_parallel_instances",
        "active_customer_count",
        "sort_order",
        "internal_reference",
        "scopes",
        "published_at",
        "archived_at",
        "created_at",
        "updated_at",
        "texts"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "membershipplan_012345abcdef_123456",
    "version": 2,
    "status": "published",
    "name": "Jahresmitgliedschaft",
    "description_html": "<p>Vorteile für ein Jahr</p>",
    "language": "de",
    "validity": {
      "type": "relative_duration",
      "from": null,
      "until": null,
      "value": 1,
      "unit": "year",
      "uses": null,
      "promo_code_redemption": false
    },
    "discount": {
      "type": "percent",
      "value": "10.00",
      "currency": null
    },
    "sale": {
      "amount": "120.00",
      "currency": "CHF",
      "vat": null
    },
    "publication": {
      "design": null
    },
    "renewal": {
      "allowed": false,
      "default": false,
      "reminder_days": 30,
      "duration_value": null,
      "duration_unit": null
    },
    "allow_parallel_instances": false,
    "active_customer_count": 0,
    "sort_order": 0,
    "internal_reference": "Mitgliedschaft 2027",
    "scopes": [
      {
        "type": "root",
        "resource": null
      }
    ],
    "published_at": null,
    "archived_at": null,
    "created_at": 1790000000,
    "updated_at": 1790000000,
    "texts": {
      "de": {
        "name": "Jahresmitgliedschaft",
        "description_html": "<p>Vorteile für ein Jahr</p>",
        "content_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      }
    }
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Membershipplan.php:74updateMembershipplan()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/01-membership.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Membershipplan.php",
  "method": "updateMembershipplan",
  "line": 74,
  "branch": {
    "file": "application/models/v2/Membershipplan.php",
    "line": 85
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "membershipplan",
  "short": "mepl",
  "checkedByDispatcher": true,
  "levels": [
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "put_v2_membershipplan_id_publish",
  "summary": "Mitgliedschaftsplan veröffentlichen",
  "description": "Setzt den Status auf published; prüft Texte, Steuer, Geltungsbereiche und serverseitigen Veröffentlichungs-Preflight. version muss dem letzten gelesenen Stand entsprechen; der Statuswechsel erhöht die Version und schreibt Audit/Outbox.",
  "tags": [
    "membershipplan"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "v2 object identifier in the selected account.",
      "schema": {
        "type": "string",
        "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
        "examples": [
          "membershipplan_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data enthält das dokumentierte Ergebnisobjekt; error=false und success=true.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "membershipplan_012345abcdef_123456",
              "version": 2,
              "status": "published",
              "name": "Jahresmitgliedschaft",
              "description_html": "<p>Vorteile für ein Jahr</p>",
              "language": "de",
              "validity": {
                "type": "relative_duration",
                "from": null,
                "until": null,
                "value": 1,
                "unit": "year",
                "uses": null,
                "promo_code_redemption": false
              },
              "discount": {
                "type": "percent",
                "value": "10.00",
                "currency": null
              },
              "sale": {
                "amount": "120.00",
                "currency": "CHF",
                "vat": null
              },
              "publication": {
                "design": null
              },
              "renewal": {
                "allowed": false,
                "default": false,
                "reminder_days": 30,
                "duration_value": null,
                "duration_unit": null
              },
              "allow_parallel_instances": false,
              "active_customer_count": 0,
              "sort_order": 0,
              "internal_reference": "Mitgliedschaft 2027",
              "scopes": [
                {
                  "type": "root",
                  "resource": null
                }
              ],
              "published_at": null,
              "archived_at": null,
              "created_at": 1790000000,
              "updated_at": 1790000000,
              "texts": {
                "de": {
                  "name": "Jahresmitgliedschaft",
                  "description_html": "<p>Vorteile für ein Jahr</p>",
                  "content_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                }
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  },
                  "version": {
                    "type": "integer"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "draft",
                      "internal",
                      "published",
                      "archived"
                    ]
                  },
                  "name": {
                    "type": "string"
                  },
                  "description_html": {
                    "type": "string"
                  },
                  "language": {
                    "type": "string"
                  },
                  "validity": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "fixed_range",
                          "relative_duration",
                          "usage_count"
                        ]
                      },
                      "from": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "until": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "value": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "unit": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "uses": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "promo_code_redemption": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": true
                  },
                  "discount": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "percent",
                          "fixed"
                        ]
                      },
                      "value": {
                        "type": "string",
                        "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                        "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                      },
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "additionalProperties": true
                  },
                  "sale": {
                    "type": "object",
                    "properties": {
                      "amount": {
                        "type": "string",
                        "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                        "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                      },
                      "currency": {
                        "type": "string"
                      },
                      "vat": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      }
                    },
                    "additionalProperties": true
                  },
                  "publication": {
                    "type": "object",
                    "properties": {
                      "design": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      }
                    },
                    "additionalProperties": true
                  },
                  "renewal": {
                    "type": "object",
                    "properties": {
                      "allowed": {
                        "type": "boolean"
                      },
                      "default": {
                        "type": "boolean"
                      },
                      "reminder_days": {
                        "type": "integer"
                      },
                      "duration_value": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "duration_unit": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "additionalProperties": true
                  },
                  "allow_parallel_instances": {
                    "type": "boolean"
                  },
                  "active_customer_count": {
                    "type": "integer"
                  },
                  "sort_order": {
                    "type": "integer"
                  },
                  "internal_reference": {
                    "type": "string"
                  },
                  "scopes": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "root",
                            "category",
                            "offer"
                          ]
                        },
                        "resource": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "description": "v2 category-/offer-ID; bei root null."
                        },
                        "id": {
                          "type": "string",
                          "description": "Eingabealias für resource."
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "type"
                      ]
                    }
                  },
                  "published_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "archived_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "updated_at": {
                    "type": "integer"
                  },
                  "texts": {
                    "type": [
                      "object",
                      "array"
                    ],
                    "additionalProperties": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "description_html": {
                          "type": "string"
                        },
                        "content_hash": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    },
                    "items": {},
                    "description": "Sprachcode → Textobjekt; ohne Übersetzungen kann PHP [] liefern."
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "version",
                  "status",
                  "name",
                  "description_html",
                  "language",
                  "validity",
                  "discount",
                  "sale",
                  "publication",
                  "renewal",
                  "allow_parallel_instances",
                  "active_customer_count",
                  "sort_order",
                  "internal_reference",
                  "scopes",
                  "published_at",
                  "archived_at",
                  "created_at",
                  "updated_at",
                  "texts"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "version": {
                  "type": [
                    "integer",
                    "number",
                    "string",
                    "boolean"
                  ],
                  "description": "Wird serverseitig nach Integer konvertiert; für neue Clients eine ganze Zahl senden."
                },
                "request_id": {
                  "type": "string"
                }
              },
              "additionalProperties": true,
              "required": [
                "version"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Mitgliedschaftsplan veröffentlichen",
            "value": {
              "data": {
                "version": 1,
                "request_id": "demo-plan-publish"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Membershipplan.php",
    "method": "updateMembershipplan",
    "line": 74,
    "branch": {
      "file": "application/models/v2/Membershipplan.php",
      "line": 85
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "membershipplan",
    "short": "mepl",
    "checkedByDispatcher": true,
    "levels": [
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "version": 1,
    "request_id": "demo-plan-publish"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'PUT' \
  --url "${API_ORIGIN%/}"'/v2/membershipplan/'"${PATH_ID}"'/publish' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/membershipplan/{id}/publish";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "version": 1,
    "request_id": "demo-plan-publish"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/membershipplan/{id}/publish"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"version\":1,\"request_id\":\"demo-plan-publish\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/membershipplan/{id}/publish";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "version": 1,
    "request_id": "demo-plan-publish"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/membershipplan/{id}/publish"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"version\":1,\"request_id\":\"demo-plan-publish\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.