Update a portal

Required roles:

can_write_portals

patch/v1/portals/{portal_id}/

Request

Base URL
https://app.iconik.io/API/assets
Auth
none declared. Required headers: App-ID, Auth-Token
TypeScript
https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/portals/:portal_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

portal_idstring required

Query parameters

low_priority_indexingboolean

If true, the portal is reindexed using the low priority queue

Headers

App-IDstring required

Auth-Tokenstring required

Request body

created_by_userstring uuid

date_createdstring date-time

date_modifiedstring date-time

descriptionstring nullable

idstring uuid

keyframesobject[]

logostring

logo_storage_idstring uuid

namestring required

playlist_idstring uuid

status'ACTIVE'

system_domain_idstring uuid

Response

Returns an updated portal