Skip to content

Update your organization's settings

Request

Security
x-api-key
Bodyapplication/jsonrequired

Update your organization's settings. At least one property must be supplied. Omitted properties are left unchanged.

monitoredDomainsArray of strings, <= 100 items

The domains that are monitored as belonging to your organization. Supplying this property replaces the full list; supply an empty array to clear it.

Example:
[ "example.com" ]
monitorAllDomainsboolean

Whether all domains (not just monitoredDomains) should be monitored.

Example:false
brandingobject(Update extension branding)

Branding shown on Push banners and block pages. At least one property must be supplied, and omitted properties are left unchanged. helpLinkHidden, helpLinkText and helpLinkUrl must be supplied together, or not at all.

curl -i -X PATCH \
  https://eu1.api.pushsecurity.com/v1/settings \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

OK

Headers
any
Bodyapplication/json
monitoredDomainsArray of strings
Example:
[ "example.com" ]
monitorAllDomainsboolean
Example:false
brandingobject(Extension branding)

Branding shown on Push banners and block pages.

Response
{ "monitoredDomains": [ "example.com" ], "monitorAllDomains": false, "branding": { "logoId": "f3133cea-bc0b-45c8-95a1-7320360ef847", "borderColor": "#EE4323", "buttonColor": "#FF9D29", "linkColor": "#02B0E6", "helpLinkHidden": false, "helpLinkText": "Why am I seeing this?", "helpLinkUrl": "https://pushsecurity.com/help/audience/employees/docs/what-is-push/", "alignment": "CENTRE", "theme": "DARK" } }