Skip to content

Remove the organization's image

The organizations.avatar.remove operation: DELETE /api/v1/organizations/{id}/avatar in the REST API and the organizations_avatar_remove tool in the MCP server.

DELETE/api/v1/organizations/{id}/avatar

Removes the organization's image: its initials show again. Removing when there is no image changes nothing. Needs org:write (organization owners and admins).

At a glance

  • REST: DELETE /api/v1/organizations/{id}/avatar
  • MCP tool: organizations_avatar_remove
  • Operation ID: organizations.avatar.remove
  • Scope: Organization
  • Permission: org:write
  • Risk tier: write
  • Dry run: Supported (send Ownrecord-Dry-Run: true)
  • Idempotency: Idempotency-Key optional
  • Modes: Test and live
  • Authentication: API key with the org:write scope
  • Since: M13

Request

Path parameters

FieldTypeDescription
idorg_… ID

Body

This operation takes no body.

Response

200 OK with a JSON object:

FieldTypeDescription
idorg_… ID
object"organization"
slugstring
namestring
countrystring
statusone of active, restricted, suspended, closing, closed
isPlatformboolean
supportAccessone of off, on_request, always_read
requireMfaboolean
entitlementsobject
planobject
plan.statusone of trialing, active, past_due, unpaid, canceled, none
plan.overrideobject or null
avatarobject or null
createdByusr_… ID
createdAtdate-time
updatedAtdate-time

Examples

Go back to the initials

HTTP
DELETE /api/v1/organizations/org_01m4tx5nj7ekd958x53w4bntcg/avatar
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "id": "org_01m4tx5nj7ekd958x53w4bntcg",
  "object": "organization",
  "slug": "acme",
  "name": "Acme",
  "country": "HR",
  "status": "active",
  "isPlatform": false,
  "supportAccess": "on_request",
  "requireMfa": false,
  "entitlements": {
    "livemode": true,
    "entities.max": 2,
    "brands.max": 3,
    "members.max": 10,
    "jurisdictions.registered.max": 10,
    "subscriptions.enabled": true,
    "usage_billing.enabled": true,
    "einvoicing.enabled": true,
    "processors.secondary": false,
    "custom_domains.max": 2,
    "api.rate_limit_rps": 100,
    "audit.retention_days": 90,
    "support.level": "email",
    "filing.reports": "full",
    "sso.enabled": false,
    "assistant.enabled": true,
    "assistant.messages_per_month": 1000
  },
  "plan": {
    "status": "none",
    "override": {
      "reason": "Temporary Growth entitlements until platform billing (M12)",
      "expiresAt": null
    }
  },
  "avatar": null,
  "createdBy": "usr_01m4tx5nj8emwbyf7y9vcf47xa",
  "createdAt": "2026-10-13T12:00:00.000Z",
  "updatedAt": "2026-10-14T09:30:00.000Z"
}

Errors

CodeHTTP statusWhenWhat to do
resource_not_found404The ID isn't the organization of the request.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
version_conflict409The organization changed at the same time; retry.Fetch the object again and retry the change.
permission_denied403You can't change this organization's settings.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: validation_failed, api_version_unsupported, invalid_json, unsupported_media_type, authentication_required, api_key_invalid, idempotency_key_reused, idempotency_in_progress, approval_required, approval_rejected, approval_expired, stale_approval, approval_policy_denied, rate_limited, internal_error.