Skip to content

Remove a legal entity's image

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

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

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

At a glance

  • REST: DELETE /api/v1/entities/{id}/avatar
  • MCP tool: entities_avatar_remove
  • Operation ID: entities.avatar.remove
  • Scope: Organization, or one of its legal entities or brands
  • Permission: entities: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 entities:write scope
  • Since: M13

Request

Path parameters

FieldTypeDescription
ident_… ID

Body

This operation takes no body.

Response

200 OK with a JSON object:

FieldTypeDescription
ident_… ID
object"legal_entity"
orgIdorg_… ID
slugstring
legalNamestring
tradingNamestring or null
avatarobject or null
establishmentobject
establishment.countrystring
establishment.subdivisionstring or null
establishment.addressobject
establishment.address.line1string
establishment.address.line2string or null
establishment.address.citystring
establishment.address.postalCodestring or null
establishment.address.regionstring or null
establishment.address.countrystring
establishment.companyRegistryIdstring
establishment.euVatEstablishedboolean
homeTaxIdobject
homeTaxId.typestring
homeTaxId.valuestring
verificationobject
verification.statusone of unverified, pending_review, verified, rejected
verification.methodone of vies, hmrc, ch_uid, document
verification.checkedAtdate-time or null
defaultCurrencystring
timezonestring
invoiceSettingsobject
invoiceSettings.numberFormatstring
invoiceSettings.sequenceResetYearlyboolean
invoiceSettings.languagestring
invoiceSettings.bilingualstring or null
invoiceSettings.footerTextstring or null
invoiceSettings.bankTransferobject or null
statusone of onboarding, active, suspended, archived
createdAtdate-time
updatedAtdate-time

Examples

Go back to the initials

HTTP
DELETE /api/v1/entities/ent_01m4tx5nj8emwbyf7y9vcf47x2/avatar
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "id": "ent_01m4tx5nj8emwbyf7y9vcf47x2",
  "object": "legal_entity",
  "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
  "slug": "acme-hr",
  "legalName": "Acme Digital d.o.o.",
  "tradingName": null,
  "avatar": null,
  "establishment": {
    "country": "HR",
    "subdivision": null,
    "address": {
      "line1": "Ilica 1",
      "line2": null,
      "city": "Zagreb",
      "postalCode": "10000",
      "region": null,
      "country": "HR"
    },
    "companyRegistryId": "080000000",
    "euVatEstablished": true
  },
  "homeTaxId": {
    "type": "eu_vat",
    "value": "HR12345678901"
  },
  "verification": {
    "status": "unverified",
    "method": "vies",
    "checkedAt": null
  },
  "defaultCurrency": "EUR",
  "timezone": "Europe/Zagreb",
  "invoiceSettings": {
    "numberFormat": "{series}-{year}-{seq:06}",
    "sequenceResetYearly": true,
    "language": "en",
    "bilingual": null,
    "footerText": null,
    "bankTransfer": null
  },
  "status": "onboarding",
  "createdAt": "2026-10-13T12:00:00.000Z",
  "updatedAt": "2026-10-14T09:30:00.000Z"
}

Errors

CodeHTTP statusWhenWhat to do
resource_not_found404No entity with this ID is visible to the request.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
version_conflict409The entity changed at the same time; retry.Fetch the object again and retry the change.
permission_denied403You can't change legal entities here.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.