Patch contributor

PATCH/contributors/{contributorId}/

API version

v2

Request method

PATCH

Operation ID

contributor-patch-contributor

---

Request

• contributorIdstring

  required

Responses

Format

application/json

Beschreibung

Contributor has been patched.

Schema-Dokumentation

• contactPersonUserIdstring (uuid)

  required
• contractOwnerobject

  required
  • contactobject

    required
    • firstNamestring
    • lastNamestring
    • titlestring
    • salutationstring (one of: mr, ms, other)

      required
    • companystring
    • addressobject

      required
      • streetstring

        required
      • houseNumberstring

        required
      • citystring

        required
      • zipstring

        required
      • countryCodestring

        required

        ISO 3166-1 alpha-2 country code

      • addressPrefixstring
    • emailAddressstring (email)
    • phoneNumbersarray of string
      • Array[
      • *string
      ]
  • useFormalTermboolean
• inheritedboolean

  required

contributorNumberstring

required

customerIdstring

required

descriptionstring

descriptionsobject

A few words about the introduction as a contributor

• destring

  required
• enstring

emailstring (email)

deprecated

required

homepagestring (uri)

idstring

required

imprintone of 2 alternatives

• Alternativeobject
  • textstring (≥ 1 characters)

    required
• Alternativeobject
  • urlstring (≥ 1 characters, uri)

    required

logoRefIdstring (uuid)

namestring

required

nameInheritedboolean

required

phonestring

deprecated

statestring (one of: enabled, disabled)

required

supportInformation

required

urlstring

deprecated

Beispiel

Content-Type: application/json

{
  "contactPersonUserId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "contractOwner": {
    "contact": {
      "firstName": "string",
      "lastName": "string",
      "title": "string",
      "salutation": "mr",
      "company": "string",
      "address": {
        "street": "Königsberger Straße",
        "houseNumber": "4-6",
        "city": "Espelkamp",
        "zip": "32339",
        "countryCode": "DE",
        "addressPrefix": "c/o Ada Lovelace"
      },
      "emailAddress": "email@mittwald.example",
      "phoneNumbers": [
        "string"
      ],
      "useFormalTerm": true
    },
    "inherited": true
  },
  "contributorNumber": "string",
  "customerId": "string",
  "description": "string",
  "descriptions": {
    "de": "Ich bin ein Contributor",
    "en": "I am a contributor"
  },
  "homepage": "string",
  "id": "string",
  "imprint": {
    "text": "string"
  },
  "logoRefId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "name": "string",
  "nameInherited": true,
  "state": "enabled",
  "supportInformation": null
}

JSON Schema

{
  "properties": {
    "contactPersonUserId": {
      "format": "uuid",
      "type": "string"
    },
    "contractOwner": {
      "properties": {
        "contact": {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string"
            },
            "lastName": {
              "type": "string"
            },
            "title": {
              "type": "string"
            },
            "salutation": {
              "type": "string",
              "enum": [
                "mr",
                "ms",
                "other"
              ]
            },
            "company": {
              "type": "string"
            },
            "address": {
              "type": "object",
              "properties": {
                "street": {
                  "type": "string",
                  "example": "Königsberger Straße"
                },
                "houseNumber": {
                  "type": "string",
                  "example": "4-6"
                },
                "city": {
                  "type": "string",
                  "example": "Espelkamp"
                },
                "zip": {
                  "type": "string",
                  "example": "32339"
                },
                "countryCode": {
                  "type": "string",
                  "example": "DE",
                  "description": "ISO 3166-1 alpha-2 country code"
                },
                "addressPrefix": {
                  "type": "string",
                  "example": "c/o Ada Lovelace"
                }
              },
              "required": [
                "street",
                "houseNumber",
                "city",
                "zip",
                "countryCode"
              ]
            },
            "emailAddress": {
              "type": "string",
              "format": "email"
            },
            "phoneNumbers": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "useFormalTerm": {
              "type": "boolean"
            }
          },
          "required": [
            "address",
            "salutation"
          ]
        },
        "inherited": {
          "type": "boolean"
        }
      },
      "required": [
        "contact",
        "inherited"
      ],
      "type": "object"
    },
    "contributorNumber": {
      "type": "string"
    },
    "customerId": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "descriptions": {
      "description": "A few words about the introduction as a contributor",
      "properties": {
        "de": {
          "example": "Ich bin ein Contributor",
          "type": "string"
        },
        "en": {
          "example": "I am a contributor",
          "type": "string"
        }
      },
      "required": [
        "de"
      ],
      "type": "object"
    },
    "email": {
      "deprecated": true,
      "format": "email",
      "type": "string"
    },
    "homepage": {
      "format": "uri",
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "imprint": {
      "oneOf": [
        {
          "properties": {
            "text": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "text"
          ],
          "type": "object"
        },
        {
          "properties": {
            "url": {
              "format": "uri",
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "url"
          ],
          "type": "object"
        }
      ]
    },
    "logoRefId": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "nameInherited": {
      "type": "boolean"
    },
    "phone": {
      "deprecated": true,
      "type": "string"
    },
    "state": {
      "enum": [
        "enabled",
        "disabled"
      ],
      "type": "string"
    },
    "supportInformation": {
      "allOf": [
        {
          "properties": {
            "email": {
              "example": "a.lovelace@example.com",
              "format": "email",
              "type": "string"
            },
            "phone": {
              "type": "string"
            }
          },
          "required": [
            "email"
          ],
          "type": "object"
        },
        {
          "properties": {
            "inherited": {
              "description": "Whether the support information is inherited from the customer.",
              "type": "boolean"
            }
          },
          "required": [
            "inherited"
          ],
          "type": "object"
        }
      ]
    },
    "url": {
      "deprecated": true,
      "type": "string"
    }
  },
  "required": [
    "id",
    "customerId",
    "state",
    "name",
    "nameInherited",
    "supportInformation",
    "email",
    "contactPersonUserId",
    "contractOwner",
    "contributorNumber"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PATCH \
    -d '{"contactPersonUserId":"string","descriptions":null,"deviatingContractOwner":null,"deviatingName":"string","deviatingSupportInformation":null,"homepage":"string","imprint":{"text":"string"}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/contributors/string

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.contributorPatchContributor({
  "contributorId": "string",
  "data": {
    "contactPersonUserId": "string",
    "descriptions": null,
    "deviatingContractOwner": null,
    "deviatingName": "string",
    "deviatingSupportInformation": null,
    "homepage": "string",
    "imprint": {
      "text": "string"
    }
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ContributorPatchContributor\ContributorPatchContributorRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ContributorPatchContributor\ContributorPatchContributorRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new ContributorPatchContributorRequest(
  contributorId: "string",
  body: $body
));
$response = $client->marketplace()->contributorPatchContributor($request);

var_dump($response->getBody();