MagicDoorAPI
SupportOpen MagicDoor
Company

Update the tenant and owner portal settings

Changes the portal's branding. Only the fields you send are written, so this can be used to change one thing at a time.

PUT
https://api.portal.magicdoor.com/company-app/companies/portal-settings

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Body

application/json

metadataobject

Page metadata and theme. Every field inside it is required when you send it at all.

contactobject

Contact details shown on the portal.

socialLinksobject

Social profile URLs keyed by network. Allowed keys are twitter, facebook, instagram, linkedIn, youTube and tikTok. Sending this replaces the whole map.

translationLanguagesstring[]

ISO 639-1 codes to offer the portal in. Sending this replaces the whole list.

iconUploadSessionIdstring

Upload session holding the new favicon. A Snowflake id sent as a decimal string.

logoUploadSessionIdstring

Upload session holding the new logo.

coverUploadSessionIdstring

Upload session holding the new cover image.

iconFileIdstringdeprecated

An already-stored file to use as the favicon. Use iconUploadSessionId instead.

logoFileIdstringdeprecated

An already-stored file to use as the logo. Use logoUploadSessionId instead.

coverFileIdstringdeprecated

An already-stored file to use as the cover image. Use coverUploadSessionId instead.

Response

200 · The portal settings after the change.

metadataobject

How the portal presents itself to browsers and search engines.

contactobject

Contact details shown on the portal.

socialLinksobject

Social profile URLs, keyed by network. Keys are twitter, facebook, instagram, linkedIn, youTube and tikTok.

translationLanguagesstring[]

ISO 639-1 codes the portal offers itself in.

iconFileobject

The favicon. Absent when none was uploaded.

logoFileobject

The portal logo. Absent when none was uploaded.

coverFileobject

The portal cover image. Absent when none was uploaded.

iconFileIdstringdeprecated

Same value as iconFile.id.

iconUrlstringdeprecated

Pre-signed URL for the favicon. Use iconFile.secureUrl.raw instead.

iconThumbUrlstringdeprecated

Pre-signed thumbnail URL for the favicon. Use iconFile.secureUrl.variantTemplate instead.

logoFileIdstringdeprecated

Same value as logoFile.id.

logoUrlstringdeprecated

Pre-signed URL for the logo. Use logoFile.secureUrl.raw instead.

logoThumbUrlstringdeprecated

Pre-signed thumbnail URL for the logo. Use logoFile.secureUrl.variantTemplate instead.

coverFileIdstringdeprecated

Same value as coverFile.id.

coverUrlstringdeprecated

Pre-signed URL for the cover image. Use coverFile.secureUrl instead.

401 · The access token is missing, expired, or not valid for this company.

To change an image, first request an upload session, send the bytes to it, then send the session id here.