---
agentTools:
  projectIndex: https://copperx.readme.io/llms.txt
---

# Update branding

Updates the organization branding which will be reflected on payment pages, invoices, etc.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/organization/brand": {
      "put": {
        "operationId": "OrganizationController_updateBranding",
        "summary": "Update branding",
        "description": "Updates the organization branding which will be reflected on payment pages, invoices, etc.",
        "parameters": [],
        "requestBody": {
          "required": false,
          "content": {
            "multipart/form-data": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/UpdateBrandDto"
                  },
                  {
                    "properties": {
                      "brandLogo": {
                        "type": "string",
                        "format": "binary"
                      }
                    },
                    "type": "object"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrganizationDto"
                }
              }
            }
          },
          "500": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorDto"
                }
              }
            }
          }
        },
        "tags": [
          "Organization"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "Copperx API",
    "description": "Copperx APIs allows you to access to manage payments, transactions and more in a simple way. Our APIs are easy to use and provide an intuitive APIs for developers to create powerful applications.",
    "version": "v0.0.0",
    "contact": {
      "name": "Copperx",
      "url": "https://t.me/+bVxXaalfhF8wMDFl",
      "email": "support@copperx.io"
    }
  },
  "servers": [
    {
      "url": "https://api.copperx.dev",
      "description": "Test"
    },
    {
      "url": "https://api.copperx.io",
      "description": "Production"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "ErrorDto": {
        "type": "object",
        "properties": {
          "message": {
            "type": "object"
          },
          "statusCode": {
            "type": "number"
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "statusCode",
          "error"
        ]
      },
      "OrganizationStatus": {
        "type": "string",
        "enum": [
          "pending",
          "active",
          "suspended"
        ]
      },
      "OrganizationKind": {
        "type": "string",
        "enum": [
          "individual",
          "business"
        ]
      },
      "WithdrawalAddressMinimalDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Withdrawal address id"
          },
          "name": {
            "type": "string",
            "description": "Withdrawal address name"
          },
          "address": {
            "type": "string",
            "description": "Withdrawal address"
          },
          "chainId": {
            "type": "number",
            "example": 1,
            "description": "Withdrawal address chain id"
          },
          "isDefault": {
            "type": "boolean",
            "description": "Is default withdrawal address"
          }
        },
        "required": [
          "id",
          "name",
          "address",
          "chainId",
          "isDefault"
        ]
      },
      "AddressDetailDto": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string"
          },
          "line2": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        }
      },
      "OrganizationDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "type": "string",
            "description": "Organization's name"
          },
          "type": {
            "type": "string",
            "description": "Organization's type"
          },
          "status": {
            "description": "Organization's status",
            "$ref": "#/components/schemas/OrganizationStatus"
          },
          "kind": {
            "description": "Organization's kind",
            "$ref": "#/components/schemas/OrganizationKind"
          },
          "ownerId": {
            "type": "string",
            "description": "User's id who owns organization"
          },
          "noOfEmployees": {
            "type": "string",
            "description": "No of employees"
          },
          "monthlyPaymentVolume": {
            "type": "string",
            "description": "Monthly payment volume"
          },
          "addresses": {
            "description": "Withdrawal addresses",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WithdrawalAddressMinimalDto"
            }
          },
          "email": {
            "type": "string",
            "description": "Organization's email"
          },
          "supportEmail": {
            "type": "string",
            "description": "Organization's support email"
          },
          "phone": {
            "type": "string",
            "description": "Organization's support phone number"
          },
          "addressDetails": {
            "description": "Organization's business address",
            "allOf": [
              {
                "$ref": "#/components/schemas/AddressDetailDto"
              }
            ]
          },
          "brandLogo": {
            "type": "string",
            "description": "Brand logo url"
          },
          "brandColor": {
            "type": "string",
            "description": "Brand color in hex format"
          },
          "supportUrl": {
            "type": "string",
            "description": "Organization's support url"
          },
          "termsUrl": {
            "type": "string",
            "description": "Organization's terms and conditions url"
          },
          "privacyUrl": {
            "type": "string",
            "description": "Organization's privacy policy url"
          },
          "websiteUrl": {
            "type": "string",
            "description": "Organization's website url"
          },
          "featureAccessRequests": {
            "description": "Feature access requests from organization",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "companyIdentificationNumber": {
            "type": "string"
          },
          "taxIdentificationNumber": {
            "type": "string"
          },
          "referralCode": {
            "type": "string",
            "description": "Referral code"
          },
          "referrerId": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "type",
          "status",
          "kind",
          "ownerId",
          "noOfEmployees",
          "monthlyPaymentVolume",
          "addresses",
          "brandLogo",
          "brandColor",
          "featureAccessRequests"
        ]
      },
      "UpdateBrandDto": {
        "type": "object",
        "properties": {
          "brandLogo": {
            "type": "string",
            "format": "binary",
            "description": "Brand logo file"
          },
          "brandColor": {
            "type": "string",
            "description": "Brand color in hex format"
          }
        },
        "required": [
          "brandColor"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 181,
      "2": 177,
      "3": 27,
      "4": 23,
      "5": 171,
      "6": 139,
      "7": 0,
      "8": 127,
      "9": 93,
      "10": 212,
      "11": 76
    }
  }
}
```