Organization Settings APIs

Use the following APIs to view and update your organization settings.

Update Organization Settings

Required Permissions

You must have the Edit Organization Settings permission to perform this operation.

API

/api/organizations/{id}/settings

Method

PUT

Parameters

Name	Description
category string	Enter categories such as metric, campaign, identity, and notifications. A system namespace is available by default.
settings string	Enter the settings for the organization.

Input Example

[{
  "category" : "campaign", 
  "settings" : { 
     "campaign-approval-needed": "false"
  }
}]

Response

{
  "id": ""
}

Get Organization Settings for a Category

Required Permissions

You must have the View Organization Settings permission to perform this operation.

API

/api/organizations/{id}/settings?category=<category>

Method

GET

Required Parameters

Name	Description
category string	Enter categories such as metric, campaign, identity, and notifications. A system namespace is available by default.

Response

{
  "category" : "iam", 
  "settings" : { 
     "delete-ttl-days" : 20
  },
    }

Get Organization Settings

Required Permissions

You must have the View Organization Settings permission to perform this operation.

API

/api/organizations/{id}/settings

Method

GET

Required Parameters

None

Response

	
[{
  "category" : "campaign", 
  "settings" : { 
     "campaign-approval-needed": "false"
  }
}]