Update a Reseller account info

PATCH /v1/Resellers/{resellerId}/account-info

Updates the specified reseller account info. Available to the roles: csp

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

  • resellerId string(uuid) Required

    GUID Unique identifier for the reseller.

application/json

Body

The request body with the info to perform the update. This body contains an JSON Object with all the properties to update the reseller account info.

  • companyName string | null Required

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

  • country string | null Required

    The company country. Must be in standard iso 3166-1 alpha 2.

  • 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.

  • zipCode string | null Required

    The company ZIP. Should be a valid zip according to the company country. This may be up to 30 characters.

  • firstName string | null Required

    The company primary contact first 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. Should be a valid phone according to the company country. This may be up to 30 characters.

Responses

  • 204

    No Content

  • 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
    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
    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
  • 401

    Unauthorized

  • 403

    Forbidden

  • 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
    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
    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
PATCH /v1/Resellers/{resellerId}/account-info
curl \
 -X PATCH https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Resellers/{resellerId}/account-info \
 -H "Content-Type: application/json" \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string" \
 -d '{"companyName":"string","country":"string","addressLine1":"string","addressLine2":"string","city":"string","state":"string","zipCode":"string","firstName":"string","lastName":"string","email":"string","phone":"string"}'
Request example
# Headers
X-Tenant: string
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "companyName": "string",
  "country": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "zipCode": "string",
  "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 (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"
      ]
    }
  ]
}