# Consumer Management

_

## Get list of accessible consumers

 - [GET /consumers](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/list-accessible-customers.md): Returns a list of the names of your consumers that you have access to.

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers

## Get a specific filter type

 - [GET /consumers/{name}/filters/{filter}](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/list-filters-channel-types.md): This endpoint returns the filtered values within one of a consumer's specified filter types

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers/example-consumer/filters/x-mm-channel-type

## Post a specific filter type

 - [POST /consumers/{name}/filters/{filter}](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/update-filters-channel-types.md): This endpoint lets you update filtered values under a given consumer's specific filter type.  Note: The user must have permission to add the filter value(s) to the filter (see the /permissions command).

Sample POST endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers/example-consumer/filter/x-mm-channel-type with body ["DISPLAY","EMAIL"]

## Get permissions

 - [GET /permissions](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/get-filter-list-per-consumer.md): This endpoint returns the current lists of filters and parameters that you can update without having to engaging the MM team. 

If you would like to make updates to any other filters please email your account representative.

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/permissions/

If you have access to:

"EDIT.Filters.X-Mm-Exch-Id": [
  "15",
  "42",
  "62"
]

This means that you can add or subtract thos exchange id values from any of your consumers you control as you see fit.

## Get filters

 - [GET /consumers/{name}/filters](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/list-consumers-active-filters.md): This endpoint returns all of the current filters you have for a specified consumer.

For more information on other filters that MediaMath would have to change for you, checkout our other documentation.

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers/example-consumer/filters

## Get sample settings

 - [GET /consumers/{name}/samplesettings](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/get-consumer-statuses.md): This will get your consumer's current disable/enable and sample rate status.

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers/example-consumer/samplesettings

## Post sample settings

 - [POST /consumers/{name}/samplesettings](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/set-consumer-statuses.md): This will set your sample rate and/or disabled value.

## Get consumer config

 - [GET /consumers/{name}](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/get-consumer-details.md): Get details of a specific consumer (which includes but is not limited to the filters)

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers/example-consumer

## Post consumer config

 - [POST /consumers/{name}](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/post_consumer_config.md): This endpoint allows you to edit your entire config directly instead of in pieces as you see fit. You can take the output of /consumers/{name} and POST it back here and any changes will be updated

## Get consumer web settings

 - [GET /consumers/{name}/websettings](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/list-consumer-websettings.md): This will get your consumer's web settings.

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers/example-consumer/websettings

## Post consumer web settings

 - [POST /consumers/{name}/websettings](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/set-consumer-websettings.md): This will set your consumer's web settings.

## Get consumer aws settings

 - [GET /consumers/{name}/awssettings](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/list-consumer-awsettings.md): This will get your consumer's awssettings.

Sample endpoint: https://api.mediamath.com/opportunity-firehose/v2.0/consumers/example-consumer/awssettings

## Post consumer aws settings

 - [POST /consumers/{name}/awssettings](https://apidocs.mediamath.com/apis/bof-api-v1/consumer-management/set-consumer-awsettings.md): This will set your consumer's awssettings. 

Note: "RoleARN" and "ExternalID" cannot be changed