Updates a Customer Microsoft Agreement

PATCH /v1/Customers/{customerId}/microsoft-customer-agreement

Updates the specified customer Microsoft customer agreement. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider. Available to the roles: csp, reseller

Headers

  • X-Tenant string Required

    The domain used to access the portal.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

  • customerId string(uuid) Required

    GUID Unique identifier for the customer

application/json

Body

The request body with the info to perform the update.

  • providerInstanceId string(uuid) Required

    The GUID identifier for the provider instance.

  • agreementDate string(date-time) Required

    The date this agreement was accepted by the customer.

  • keepPrimaryInformation boolean Required

    The flag indicating wheter to use the current primary contact information of the customer in the microsoft customer agreement. If true there is no need to set the properties firstName, lastName, email and phone since they will be overriden by the customer primary contact information. If set to false the earlier mentioned properties are required.

  • firstName string | null

    The first name to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If set to false this is required. This may be up to 255 characters.

  • lastName string | null

    The last name to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If KeepPrimaryInformation set to false this is required. This may be up to 255 characters.

  • email string | null

    The email to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If KeepPrimaryInformation set to false this is required. This may be up to 255 characters.

  • phone string | null

    The phone to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If KeepPrimaryInformation set to false this is required. This may be up to 30 characters.

Responses

PATCH /v1/Customers/{customerId}/microsoft-customer-agreement
curl \
 -X PATCH https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/microsoft-customer-agreement \
 -H "Content-Type: application/json" \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string" \
 -d '{"providerInstanceId":"string","agreementDate":"2024-05-04T09:42:00+00:00","keepPrimaryInformation":true,"firstName":"string","lastName":"string","email":"string","phone":"string"}'
Request examples
# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "providerInstanceId": "string",
  "agreementDate": "2024-05-04T09:42:00+00:00",
  "keepPrimaryInformation": true,
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string"
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (404)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (404)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}