---
updatedAt: 2026-04-06T12:57:35.000Z
agentTools:
  projectIndex: https://boomfi.readme.io/llms.txt
---

# Update Organization

The **Update Organization** endpoint allows you to modify your organization's details, such as the `name`, `logo_url`, and `webhook_url`. This endpoint is useful for keeping your organization's information current and ensuring that your settings align with any changes in your operations or branding.  


<HTMLBlock>{`
<style>
  :root {
    --callout-border: 0;
    --callout-border-radius: 4px;
    --text-color: #000000;

    /* Info Callout Colors */
    --info-light-bg: #DAF8FF;
    --info-light-border: #7CCEDF;
    --info-light-header: #57B3C7;
    --info-light-text: #283652;
    --info-light-link: #57B3C7;
    --info-dark-bg: #DAF8FF;
    --info-dark-border: #7CCEDF;
    --info-dark-header: #57B3C7;
    --info-dark-text: #97B5BC;
    --info-dark-link: #57B3C7;

    /* Okay Callout Colors */
    --okay-light-bg: #DFFFE8;
    --okay-light-border: #116E5F;
    --okay-light-header: #116E5F;
    --okay-light-text: #116E5F;
    --okay-light-link: #61AEA0;
    --okay-dark-bg: #DFFFE8;
    --okay-dark-header: #5BB2A4;
    --okay-dark-text: #7B9792;
    --okay-dark-link: #61AEA0;

    /* Default Callout Colors */
    --default-light-bg: #e8e8e8;
    --default-light-border: #ACACAC;
    --default-light-text: #8A8A8A;
    --default-dark-bg: #e8e8e8;
    --default-dark-text: #FFFFFF;

    /* Warn Callout Colors */
    --warn-light-bg: #fff9c2;
    --warn-light-border: #FFB293;
    --warn-light-header: #FF966B;
    --warn-light-text: #80776C;
    --warn-light-link: #FF966B;
    --warn-dark-bg: #fff9c2;
    --warn-dark-header: #FF966B;
    --warn-dark-text: #989693;
    --warn-dark-link: #FF966B;

    /* Error Callout Colors */
    --error-light-bg: #ffdada;
    --error-light-border: #FA94A6;
    --error-light-header: #FF728B;
    --error-light-text: #B56978;
    --error-light-link: #FF728B;
    --error-dark-bg: #ffdada;
    --error-dark-header: #FF728B;
    --error-dark-text: #C6A5AB;
    --error-dark-link: #FF728B;
  }

  .field-description blockquote,
  .markdown-body blockquote {
    border-left: 0;
  }

  .callout {
    border-radius: var(--callout-border-radius);
    border: var(--callout-border);
  }

  .callout .callout-heading p,
  .callout p,
  .callout ul {
    color: var(--text-color) !important;
  }

  @media (prefers-color-scheme: dark) {

    [data-color-mode="system"] .callout .callout-heading p,
    [data-color-mode="system"] .callout p,
    [data-color-mode="system"] .callout ul {
      color: var(--text-color) !important;
    }
  }

  [data-color-mode="dark"] .callout .callout-heading p,
  [data-color-mode="dark"] .callout p,
  [data-color-mode="dark"] .callout ul {
    color: var(--text-color) !important;
  }

  /* INFO CALLOUT */
  .callout.callout_info {
    background: var(--info-light-bg);
  }

  .callout.callout_info a {
    color: var(--info-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_info {
      background-color: var(--info-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_info a {
      color: var(--info-dark-link) !important;
    }
  }

  [data-color-mode="dark"] .callout.callout_info {
    background-color: var(--info-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_info a {
    color: var(--info-dark-link) !important;
  }

  /* INFO CALLOUT */

  /* OKAY CALLOUT */
  .callout.callout_okay {
    background: var(--okay-light-bg);
  }

  .callout.callout_okay a {
    color: var(--okay-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_okay {
      background-color: var(--okay-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_okay a {
      color: var(--okay-dark-link) !important;
    }
  }

  [data-color-mode="dark"] .callout.callout_okay {
    background-color: var(--okay-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_okay a {
    color: var(--okay-dark-link) !important;
  }

  /* OKAY CALLOUT */

  /* DEFAULT CALLOUT */
  .callout.callout_default {
    background: var(--default-light-bg);
  }

  .callout.callout_default a {
    color: var(--text-color) !important;
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_default {
      background-color: var(--default-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_default a {
      color: var(--text-color) !important;
    }

  }

  [data-color-mode="dark"] .callout.callout_default {
    background-color: var(--default-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_default a {
    color: var(--text-color) !important;
  }

  /* DEFAULT CALLOUT */

  /* WARN CALLOUT */
  .callout.callout_warn {
    background: var(--warn-light-bg);
  }

  .callout.callout_warn a {
    color: var(--warn-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_warn {
      background-color: var(--warn-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_warn a {
      color: var(--warn-dark-link);
    }
  }

  [data-color-mode="dark"] .callout.callout_warn {
    background-color: var(--warn-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_warn a {
    color: var(--warn-dark-link);
  }

  /* WARN CALLOUT */

  /* ERROR CALLOUT */
  .callout.callout_error {
    background: var(--error-light-bg);
  }

  .callout.callout_error a {
    color: var(--error-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_error {
      background-color: var(--error-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_error a {
      color: var(--error-dark-link);
    }
  }

  [data-color-mode="dark"] .callout.callout_error {
    background-color: var(--error-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_error a {
    color: var(--error-dark-link);
  }

  /* ERROR CALLOUT */

  img {
    border-radius: 14px !important;
    box-shadow: 0px 0px 4px rgba(0, 0, 0, 0.15);
  }

  .Sidebar-listWrapper6Q9_yUrG906C.rm-Sidebar-section:nth-child(3),
  .rm-Sidebar-section:nth-child(3), .rm-Sidebar-section:nth-child(4) {
    display: none;
  }

  .Select option {
    color: var(--color-input-text);
  }
</style>
`}</HTMLBlock>

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "The BoomFi Merchants API provides a set of endpoints for merchants to manage their accounts, transactions, and more.",
    "title": "BoomFi Merchants API",
    "contact": {
      "name": "API Support",
      "email": "support@boomfi.xyz"
    },
    "version": "1.0"
  },
  "paths": {
    "/v1/orgs": {
      "put": {
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "description": "The **Update Organization** endpoint allows you to modify your organization's details, such as the `name`, `logo_url`, and `webhook_url`. This endpoint is useful for keeping your organization's information current and ensuring that your settings align with any changes in your operations or branding.  \n",
        "tags": [
          "Organization"
        ],
        "summary": "Update Organization",
        "operationId": "update-organization",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/orgs.UpdateOrgRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/models.Org"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/internal.ErrorResponse500"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "//mapi.boomfi.xyz"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "name": "X-API-KEY",
        "in": "header"
      }
    },
    "schemas": {
      "internal.ErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/internal.ErrorStruct"
          }
        }
      },
      "internal.ErrorResponse500": {
        "type": "object",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/internal.ErrorStruct500"
          }
        }
      },
      "internal.ErrorStruct": {
        "type": "object",
        "properties": {
          "code": {
            "description": "The error code returned by the server.\nExample: 400",
            "type": "integer",
            "example": 400
          },
          "errors": {
            "description": "A list of detailed error objects.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/internal.SingleError"
            }
          },
          "message": {
            "description": "A descriptive message explaining the error.\nExample: Insufficient quantity",
            "type": "string",
            "example": "Insufficient quantity"
          }
        }
      },
      "internal.ErrorStruct500": {
        "type": "object",
        "properties": {
          "code": {
            "description": "The error code returned by the server.\nExample: 500",
            "type": "integer",
            "example": 500
          },
          "errors": {
            "description": "A list of detailed error objects.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/internal.SingleError500"
            }
          },
          "message": {
            "description": "A descriptive message explaining the error.\nExample: Internal server error",
            "type": "string",
            "example": "Internal server error"
          }
        }
      },
      "internal.SingleError": {
        "type": "object",
        "properties": {
          "domain": {
            "description": "The domain associated with the error.\nExample: orders",
            "type": "string",
            "example": "orders"
          },
          "reason": {
            "description": "The reason for the error.\nExample: InsufficientQuantity",
            "type": "string",
            "example": "InsufficientQuantity"
          }
        }
      },
      "internal.SingleError500": {
        "type": "object",
        "properties": {
          "domain": {
            "description": "The domain associated with the error.\nExample: orders",
            "type": "string",
            "example": "orders"
          },
          "reason": {
            "description": "The reason for the error.\nExample: Internal",
            "type": "string",
            "example": "Internal"
          }
        }
      },
      "models.Org": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for BoomFi",
            "example": "2Tpmnmh6GHJXumKN1oBy2u56Ima"
          },
          "name": {
            "type": "string",
            "description": "The name of the BoomFi service",
            "example": "BoomFi"
          },
          "owner_user_id": {
            "type": "string",
            "description": "The user ID of the owner",
            "example": "2TzGhPCAfFWLPBjtc6h52Aao2S6"
          },
          "webhook_url": {
            "type": "string",
            "format": "uri",
            "description": "The URL for webhook notifications",
            "example": "https://webhook.site/b09eec23-3f7a-4f0c-aec6-84c277c5eb78"
          },
          "logo_url": {
            "type": "string",
            "format": "uri",
            "description": "The URL for the logo of BoomFi",
            "example": "https://boomfi-test-addonsstack-ipj55n-merchantdatabucket-11rcw286tjikp.s3.eu-west-2.amazonaws.com/7403e69d-71c7-4ab4-8b19-7130ecd0bb3e/merchant-logos/57da50bd-857a-4658-8916-7f4a5f9ad9ad.png"
          },
          "offramp_fee_pct": {
            "type": "number",
            "description": "The offramp fee percentage",
            "example": 1
          },
          "payment_fee_pct": {
            "type": "number",
            "description": "The payment fee percentage",
            "example": 1
          },
          "swap_fee_pct": {
            "type": "number",
            "description": "The swap fee percentage",
            "example": 1
          },
          "credits_usd": {
            "type": "number",
            "description": "The credits in USD",
            "example": 0
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when BoomFi was created",
            "example": "2023-08-11T10:09:25.679Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when BoomFi was last updated",
            "example": "2024-03-29T13:59:55.003Z"
          },
          "properties": {
            "type": "object",
            "properties": {
              "ramp": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "description": "Indicates if Ramp is enabled",
                    "example": true
                  }
                }
              },
              "spreedly": {
                "type": "object",
                "properties": {
                  "merchant_profile_id": {
                    "type": "string",
                    "description": "The merchant profile ID for Spreedly",
                    "example": "65oxw5ZZ2lE4siMz618v4HQqD2X"
                  },
                  "sca_authentication_enabled": {
                    "type": "boolean",
                    "description": "Indicates if SCA authentication is enabled",
                    "example": true
                  },
                  "sca_provider_id": {
                    "type": "string",
                    "description": "The SCA provider ID for Spreedly",
                    "example": "YN8LHxRK9ysWlKfdWZdDCtUM2TI"
                  },
                  "sub_merchant_data": {
                    "type": "string",
                    "description": "Sub-merchant data for Spreedly",
                    "example": "eyJ0b2tlbiI6Ik5zVkUyV1E0eWZmUklBaDRSMENzalRXYU5naSIsIm5hbWUiOiJDcmV3IiwiZW52aXJvbm1lbnRfa2V5IjoiM0I1TkFGWTlBTTkyODlGWDZROTVOM1g4RFciLCJtZXJjaGFudF9kZWZpbmVkX3VpZCI6IjJUcG1ubWg2R0hKWHVtS04xb0J5MnU1NkltYSIsImFkZHJlc3MiOnsiYWRkcmVzczEiOiIiLCJjaXR5IjoiIiwic3RhdGUiOiIiLCJ6aXAiOiIiLCJjb3VudHJ5IjoiIn0sIm1ldGFkYXRhIjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0xNlQxNDo0OToyM1oiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0xNlQxNDo0OToyM1oifQ=="
                  },
                  "sub_merchant_id": {
                    "type": "string",
                    "description": "The sub-merchant ID for Spreedly",
                    "example": "NsVE2WQ4yffRIAh4R0CsjTWaNgi"
                  }
                }
              }
            }
          }
        }
      },
      "orgs.UpdateOrgRequest": {
        "type": "object",
        "required": [
          "logo_url",
          "name",
          "webhook_url"
        ],
        "properties": {
          "logo_url": {
            "type": "string",
            "description": "The URL of the organization's logo.",
            "example": "https://boomfi-test-addonsstack-ipj55n-merchantdatabucket-11rcw286tjikp.s3.eu-west-2.amazonaws.com/7403e69d-71c7-4ab4-8b19-7130ecd0bb3e/merchant-logos/57da50bd-857a-4658-8916-7f4a5f9ad9ad.png"
          },
          "name": {
            "type": "string",
            "description": "The updated name of the organization.",
            "example": "BoomFi"
          },
          "webhook_url": {
            "type": "string",
            "description": "The updated webhook URL for the organization.",
            "example": "https://webhook.site/b09eec23-3f7a-4f0c-aec6-84c277c5eb78"
          }
        }
      }
    }
  }
}
```