Add A New Branding Policy To An Organization
POST {{baseUrl}}/organizations/:organizationId/brandingPolicies
Add a new branding policy to an organization #### Body Parameters Parameter|Type|Description :-------------: |:-------------: |:-------------: name| string| Name of the Dashboard branding policy. enabled| boolean| Boolean indicating whether this policy is enabled. adminSettings| object| Settings for describing which kinds of admins this policy applies to. helpSettings| object| Settings for describing the modifications to various Help page features. Each property in this object accepts one of 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on Dashboard; see the documentation for each property to see the allowed values. Each property defaults to 'default or inherit' when not provided.
Request Body
{"name"=>"<string>", "enabled"=>"<boolean>", "adminSettings"=>{"appliesTo"=>"<string>", "values"=>["<string>", "<string>"]}, "helpSettings"=>{"helpTab"=>"<string>", "getHelpSubtab"=>"<string>", "communitySubtab"=>"<string>", "casesSubtab"=>"<string>", "dataProtectionRequestsSubtab"=>"<string>", "getHelpSubtabKnowledgeBaseSearch"=>"<string>", "universalSearchKnowledgeBaseSearch"=>"<string>", "ciscoMerakiProductDocumentation"=>"<string>", "supportContactInfo"=>"<string>", "newFeaturesSubtab"=>"<string>", "firewallInfoSubtab"=>"<string>", "apiDocsSubtab"=>"<string>", "hardwareReplacementsSubtab"=>"<string>", "smForums"=>"<string>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Cisco-Meraki-API-Key | null | ||
Content-Type | string |
RESPONSES
status: Created
{"brandingPolicyId":"456","name":"My Branding Policy","enabled":true,"adminSettings":{"appliesTo":"All admins of networks...","values":["N_1234","L_5678"]},"helpSettings":{"helpTab":"show","getHelpSubtab":"default or inherit","communitySubtab":"show","casesSubtab":"hide","dataProtectionRequestsSubtab":"default or inherit","getHelpSubtabKnowledgeBaseSearch":"\u003ch1\u003eSome custom HTML content\u003c/h1\u003e","universalSearchKnowledgeBaseSearch":"hide","ciscoMerakiProductDocumentation":"show","supportContactInfo":"show","newFeaturesSubtab":"show","firewallInfoSubtab":"hide","apiDocsSubtab":"default or inherit","hardwareReplacementsSubtab":"hide","smForums":"hide"}}