Update a customer account info

PATCH /v1/Customers/{customerId}/account-info

Updates the specified customer account info. Additionally this request contains the flag RetryFailedProviderCustomersFromCompanyInfo that if set to true will retry any provider customer that failed due to invalid company info. Available to the roles: csp, reseller

Headers

  • X-Tenant string Required

    This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.

  • 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. This body contains an JSON Object with two properties (customer, retryFailedProviderCustomersFromCompanyInfo).

  • customer object

    View model that represents a customer.

    Hide customer attributes Show customer attributes
    • companyName string | null Required

      The name of the company. This may be up to 255 characters.

    • taxId string | null

      The company tax Id. This may be up to 255 characters.

    • country string | null Required

      The company country code in the ISO 3166-1 alpha-2 standard.

    • addressLine1 string | null Required

      The company address line 1. This may be up to 255 characters.

    • addressLine2 string | null

      The company address line 2. This may be up to 255 characters.

    • city string | null Required

      The company city. This may be up to 255 characters.

    • state string | null Required

      The company State. This may be up to 255 characters.

    • zip string | null Required

      The company ZIP. This may be up to 30 characters.

    • firstName string | null Required

      The company primary contact first name. This may be up to 255 characters.

    • middleName string | null

      The company primary contact middle name. This may be up to 255 characters.

    • lastName string | null Required

      The company primary contact last name. This may be up to 255 characters.

    • email string | null Required

      The company primary contact email. This may be up to 255 characters.

    • phone string | null Required

      The company primary contact phone. This may be up to 30 characters.

    • Additional properties are NOT allowed
  • retryFailedProviderCustomersFromCompanyInfo boolean

    This flag indicates if we want to retry any provider customer that failed from invalid company info.

  • Additional properties are NOT allowed

Responses

  • • 202

    Accepted

  • • 400

    Bad Request

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
  • • 401

    Unauthorized

  • • 403

    Forbidden

  • • 500

    Server Error

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
PATCH /v1/Customers/{customerId}/account-info 
curl \
 -X PATCH https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/account-info \
 -H "Content-Type: application/json" \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string" \
 -d '{"customer":{"companyName":"string","taxId":"string","country":"PT","addressLine1":"string","addressLine2":"string","city":"string","state":"string","zip":"string","firstName":"string","middleName":"string","lastName":"string","email":"string","phone":"string"},"retryFailedProviderCustomersFromCompanyInfo":true}'
Request example 
# Headers
X-Tenant: string
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "customer": {
    "companyName": "string",
    "taxId": "string",
    "country": "PT",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string"
  },
  "retryFailedProviderCustomersFromCompanyInfo": true
}
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 (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"
      ]
    }
  ]
}