Skip to content
Users
/
Update User's Settings

Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://mediamathsupport.force.com/

Support

developers@mediamath.com

Languages
Servers
Live Server

https://api.mediamath.com/api/v3.0/

Organizations

Organizations

Operations

Agencies

Agencies

Operations

Advertisers

Advertisers

Operations

Campaigns

Campaigns

Operations

Campaigns Budget Flights

Campaigns Budget Flights

Operations

Campaign Plans

Campaign Plans

Operations

Strategies

Strategies

Operations

Strategy Parameters

Strategy Parameters

Operations

Strategy Templates

Strategy Templates

Operations

New Strategy Plans

New Strategy Plans

Operations

Targeting

Targeting

Operations

Targeting Attachments

TargetingAttachments

Operations

Targeting Segments

Targeting Segments

Operations

Targeting Segment Objectives

Targeting Segment Objectives

Operations

Vendor Contracts

Vendor Contracts

Operations

Contracts

Contracts

Operations

Audience Vendors

Audience Vendors

Operations

Vendors

Vendors

Operations

Atomic Creatives

Atomic Creatives

Operations

Concepts

Concepts

Operations

Creatives

Creatives

Operations

Pixel Bundles

Pixel Bundles

Operations

Pixel Providers

Pixel Providers

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

List users

Request

Get a list of users

Security
Auth0
Query
page_limitinteger[ 1 .. 1000 ]

Number of elements in the collection to retrieve

Example: page_limit=100
page_offsetinteger[ 0 .. 1000 ]

Index of the first element in the collection to retrieve

Example: page_offset=0
sort_bystring

The field to sort by. You can use any field name in ascending or descending order. For ascending order, use the field name directly, e.g., id. For descending order, prefix the field name with a hyphen (-), e.g., -id.

Example: sort_by=id, -id, name, -name
qstring

Query search for filtering. This parameter can be used to filter results based on various fields.

  • q=name=:{search}* to find all results with names starting with "search".
  • q=status==true to find all active entities.
  • q=id>=1000 to find all entities with id greater than or equal to 1000.
  • q=id==(1,2,3) find specific entities by ID.
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/users?page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Collection response

Bodyapplication/json
dataArray of objects or null
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Create a User

Request

Create a user

Security
Auth0
Bodyapplication/jsonrequired
titlestring<= 64 characters
activeboolean
languagestring
zone_namestring
first_namestring[ 1 .. 32 ] charactersrequired
last_namestring[ 1 .. 32 ] charactersrequired
phonestring<= 24 characters
usernamestring[ 1 .. 255 ] charactersrequired
rolesArray of integers(int16)required
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/users \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "active": true,
    "language": "string",
    "zone_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "username": "string",
    "roles": [
      0
    ]
  }'

Responses

User created response

Bodyapplication/json
dataobject(user)
metaobject
Response
application/json
{
  "data": {
    "title": "string",
    "active": true,
    "language": "string",
    "zone_name": "string",
    "id": 0,
    "entity_type": "string",
    "username": "string",
    "version": 0,
    "first_name": "string",
    "last_name": "string",
    "link_ldap": true,
    "link_saml": true,
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "type": "string",
    "role": "string",
    "scope": "string",
    "view_organizations": true,
    "edit_campaigns": true,
    "edit_margins_and_performance": true,
    "creator_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "last_login_on": "string",
    "access_internal_fees": true,
    "view_segments": true,
    "edit_segments": true,
    "view_data_definition": true,
    "edit_data_definition": true,
    "view_dmp_reports": true,
    "email": "string",
    "roles": [ … ],
    "permissions": { … }
  },
  "meta": {
    "status": "success"
  }
}

Get a User

Request

Get a user by ID

Security
Auth0
Path
user_idintegerrequired

Numeric ID of the user to get

Query
extendedboolean

Get extended properties in response

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/users/{user_id}?extended=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

User response

Bodyapplication/json
dataobject(user)
metaobject
Response
application/json
{
  "data": {
    "title": "string",
    "active": true,
    "language": "string",
    "zone_name": "string",
    "id": 0,
    "entity_type": "string",
    "username": "string",
    "version": 0,
    "first_name": "string",
    "last_name": "string",
    "link_ldap": true,
    "link_saml": true,
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "type": "string",
    "role": "string",
    "scope": "string",
    "view_organizations": true,
    "edit_campaigns": true,
    "edit_margins_and_performance": true,
    "creator_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "last_login_on": "string",
    "access_internal_fees": true,
    "view_segments": true,
    "edit_segments": true,
    "view_data_definition": true,
    "edit_data_definition": true,
    "view_dmp_reports": true,
    "email": "string",
    "roles": [ … ],
    "permissions": { … }
  },
  "meta": {
    "status": "success"
  }
}

Update a User

Request

Update a user by ID

Security
Auth0
Path
user_idintegerrequired

Numeric ID of the user to update

Bodyapplication/jsonrequired
titlestring<= 64 characters
activeboolean
languagestring
zone_namestring
versionintegerrequired
first_namestringrequired
last_namestringrequired
phonestring
rolesArray of integers(int16)required
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "active": true,
    "language": "string",
    "zone_name": "string",
    "version": 0,
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "roles": [
      0
    ]
  }'

Responses

User updated response

Bodyapplication/json
dataobject(user)
metaobject
Response
application/json
{
  "data": {
    "title": "string",
    "active": true,
    "language": "string",
    "zone_name": "string",
    "id": 0,
    "entity_type": "string",
    "username": "string",
    "version": 0,
    "first_name": "string",
    "last_name": "string",
    "link_ldap": true,
    "link_saml": true,
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "type": "string",
    "role": "string",
    "scope": "string",
    "view_organizations": true,
    "edit_campaigns": true,
    "edit_margins_and_performance": true,
    "creator_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "last_login_on": "string",
    "access_internal_fees": true,
    "view_segments": true,
    "edit_segments": true,
    "view_data_definition": true,
    "edit_data_definition": true,
    "view_dmp_reports": true,
    "email": "string",
    "roles": [ … ],
    "permissions": { … }
  },
  "meta": {
    "status": "success"
  }
}

User Audit Log

Request

Get a list changes to this user

Security
Auth0
Path
user_idintegerrequired

Numeric ID of the user

Query
page_limitinteger[ 1 .. 1000 ]

Number of elements in the collection to retrieve

Example: page_limit=100
page_offsetinteger[ 0 .. 1000 ]

Index of the first element in the collection to retrieve

Example: page_offset=0
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/users/{user_id}/history?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Audit log response

Bodyapplication/json
dataArray of objects or null
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Get User's Settings

Request

Get user's settings by ID

Security
Auth0
Path
user_idintegerrequired

Numeric ID of the user to get

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/users/{user_id}/settings' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

User settings response

Bodyapplication/json
dataobject
userobject
statusobject
Response
application/json
{
  "data": {
    "settings": [ … ]
  },
  "user": {
    "id": 0,
    "type": "string",
    "name": "string"
  },
  "status": {
    "code": "ok"
  }
}

Update User's Settings

Request

Update user's settings by ID

Security
Auth0
Path
user_idintegerrequired

Numeric ID of the user to update

Bodyapplication/jsonrequired
settingsArray of objects
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/users/{user_id}/settings' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "settings": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }'

Responses

User settings updated response

Bodyapplication/json
dataobject
userobject
statusobject
Response
application/json
{
  "data": {
    "settings": [ … ]
  },
  "user": {
    "id": 0,
    "type": "string",
    "name": "string"
  },
  "status": {
    "code": "ok"
  }
}

User Permissions

User Permissions

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

Timezones

Timezones

Operations

Verticals

Verticals

Operations

Supply Sources

Supply Sources

Operations

Ad Servers

Ad Servers

Operations

Segment Groups

Segment Groups

Operations