GEgetauctor
portals

Update Portal

Changed on
patch/api/py/portals/{portal_id}

Request

  • Base URL
    https://api.getauctor.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.getauctor.com/api/py/portals/{portal_id}
  • Auth
    none declared

Path parameters

portal_idstring uuid required

Request body

titlestring nullable
descriptionstring nullable
accent_colorstring nullable
font_family'sans' | 'serif' | 'mono' | 'custom' nullable
font_bucket_pathstring nullable
icon_bucket_pathstring nullable
landing_file_idstring uuid nullable

Response

Successful Response

can_manageboolean required
can_edit_metadataboolean required
can_deleteboolean required
idstring uuid required
titlestring required
descriptionstring nullable required
landing_file_idstring uuid nullable required
accent_colorstring nullable required
effective_accent_colorstring required
default_accent_colorstring required
font_family'sans' | 'serif' | 'mono' | 'custom' required
custom_font_format'woff2' | 'truetype' | 'opentype' nullable required
custom_font_urlstring nullable required
has_custom_fontboolean required
icon_urlstring nullable required

Changes