Create a Contract

Request

Create a contract

Security

Auth0(Required scopes: offline_accessmanage:services)

Bodyapplication/jsonrequired

organization_idinteger, (int32)required

Example:34

effective_start_datestring, (date-time)required

effective_end_datestring, (date-time)required

platform_monthly_minnumber, (float)required

platform_access_fee_pctnumber or null, (float)

platform_access_fee_cpmnumber or null, (float)

platform_access_fee_fixednumber or null, (float)

managed_service_fee_pctnumber or null, (float)

managed_service_fee_cpmnumber or null, (float)

managed_service_fee_fixednumber or null, (float)

optimization_fee_pctnumber or null, (float)

optimization_fee_cpmnumber or null, (float)

optimization_fee_fixednumber or null, (float)

pmp_optimization_off_unitstring

Enum:"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"

pmp_optimization_off_fee_pctnumber or null, (float)

pmp_optimization_off_fee_cpmnumber or null, (float)

pmp_optimization_on_unitstring

Enum:"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"

pmp_optimization_on_fee_pctnumber or null, (float)

pmp_optimization_on_fee_cpmnumber or null, (float)

dmp_fee_unitstring or null

Enum:"PCT_TOTAL_COST""CPM""CPTS"

dmp_fee_pctnumber or null, (float)

dmp_fee_cpmnumber or null, (float)

dmp_fee_cptsnumber or null, (float)

signals_fee_unitstring or null

Enum:"PCT_TOTAL_COST""CPM"

signals_fee_pctnumber or null, (float)

signals_fee_cpmnumber or null, (float)

t1_apps_fee_unitstring or null

Enum:"PCT_TOTAL_COST""CPM"

t1_apps_fee_pctnumber or null, (float)

t1_apps_fee_cpmnumber or null, (float)

spend_capnumber or null, (float)

platform_access_fee_unitstring

Enum:"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"

managed_service_fee_unitstring

Enum:"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"

optimization_fee_unitstring

Enum:"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"

profit_share_fee_pctnumber, (float)required

exclude_agency_marginbooleanrequired

Default:false

t1_as_fee_cpmnumber, (float)required

Default:0.05

evidon_privacy_cost_cpmnumber, (float)

Default:0.02

peer39_channel_fee_cpmnumber or null, (float)

peer39_custom_fee_cpmnumber or null, (float)

peer39_safety_fee_cpmnumber, (float)

peer39_quality_fee_cpmnumber, (float)

fbx_dynamic_cpmnumber, (float)

Default:0.3

t1_vads_fee_cpmnumber, (float)required

Default:0.25

adaptive_segment_cpmnumber, (float)required

Default:0

external_media_tracking_cpmnumber, (float)

Default:0

currency_codestring, = 3 charactersrequired

t1_html5_fee_cpmnumber, (float)required

Default:0.05

viewability_display_samplenumber or null, (float)

viewability_display_all_impsnumber or null, (float)

viewability_video_samplenumber or null, (float)

viewability_video_all_impsnumber or null, (float)

standard_segment_cpmnumber, (float)required

Default:0.1

connected_id_costnumber, (float)

Default:0

financing_costnumber, (float)

Default:0

audience_verification_costnumber, (float)

Default:0.25

programmatic_guaranteed_platform_access_fee_cpmnumber or null, (float)

programmatic_guaranteed_platform_access_fee_pctnumber or null, (float)

programmatic_guaranteed_platform_access_fee_unitstring

Enum:"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"

media_enablement_fee_cpmnumber or null, (float)

media_enablement_fee_pctnumber or null, (float)

media_enablement_fee_unitstring

Enum:"PCT_TOTAL_COST""CPM""PCT_CLEAR"

source_platform_access_fee_cpmnumber or null, (float)

source_platform_access_fee_pctnumber or null, (float)

source_platform_access_fee_unitstring

Enum:"PCT_TOTAL_COST""CPM"

country_tax_withholding_fee_cpmnumber or null, (float)

country_tax_withholding_fee_pctnumber or null, (float)

country_tax_withholding_fee_unitstring

Enum:"CPM""PCT_CLEAR""PCT_NET_TOTAL_SPEND"

partnership_rebate_fee_cpmnumber or null, (float)

partnership_rebate_fee_pctnumber or null, (float)

partnership_rebate_fee_unitstring

Enum:"CPM""PCT_CLEAR""PCT_NET_TOTAL_SPEND"

cross_device_fee_cpmnumber or null, (float)

dba_optimization_fee_cpmnumber or null, (float)

dba_optimization_fee_pctnumber or null, (float)

dba_optimization_fee_unitstring

Enum:"CPM""PCT_MEDIA"

audio_video_platform_access_fee_cpmnumber or null, (float)

audio_video_platform_access_fee_pctnumber or null, (float)

audio_video_platform_access_fee_unitstring

Enum:"CPM""PCT_TOTAL_COST"

mfa_fee_cpmnumber or null, (float)

curl -i -X POST \
  https://api.mediamath.com/api/v3.0/contracts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organization_id": 34,
    "effective_start_date": "2019-08-24T14:15:22Z",
    "effective_end_date": "2019-08-24T14:15:22Z",
    "platform_monthly_min": 0.1,
    "platform_access_fee_pct": 0.1,
    "platform_access_fee_cpm": 0.1,
    "platform_access_fee_fixed": 0.1,
    "managed_service_fee_pct": 0.1,
    "managed_service_fee_cpm": 0.1,
    "managed_service_fee_fixed": 0.1,
    "optimization_fee_pct": 0.1,
    "optimization_fee_cpm": 0.1,
    "optimization_fee_fixed": 0.1,
    "pmp_optimization_off_unit": "PCT_TOTAL_COST",
    "pmp_optimization_off_fee_pct": 0.1,
    "pmp_optimization_off_fee_cpm": 0.1,
    "pmp_optimization_on_unit": "PCT_TOTAL_COST",
    "pmp_optimization_on_fee_pct": 0.1,
    "pmp_optimization_on_fee_cpm": 0.1,
    "dmp_fee_unit": "PCT_TOTAL_COST",
    "dmp_fee_pct": 0.1,
    "dmp_fee_cpm": 0.1,
    "dmp_fee_cpts": 0.1,
    "signals_fee_unit": "PCT_TOTAL_COST",
    "signals_fee_pct": 0.1,
    "signals_fee_cpm": 0.1,
    "t1_apps_fee_unit": "PCT_TOTAL_COST",
    "t1_apps_fee_pct": 0.1,
    "t1_apps_fee_cpm": 0.1,
    "spend_cap": 0.1,
    "platform_access_fee_unit": "PCT_TOTAL_COST",
    "managed_service_fee_unit": "PCT_TOTAL_COST",
    "optimization_fee_unit": "PCT_TOTAL_COST",
    "profit_share_fee_pct": 0.1,
    "exclude_agency_margin": false,
    "t1_as_fee_cpm": 0.05,
    "evidon_privacy_cost_cpm": 0.02,
    "peer39_channel_fee_cpm": 0.1,
    "peer39_custom_fee_cpm": 0.1,
    "peer39_safety_fee_cpm": 0.1,
    "peer39_quality_fee_cpm": 0.1,
    "fbx_dynamic_cpm": 0.3,
    "t1_vads_fee_cpm": 0.25,
    "adaptive_segment_cpm": 0,
    "external_media_tracking_cpm": 0,
    "currency_code": "str",
    "t1_html5_fee_cpm": 0.05,
    "viewability_display_sample": 0.1,
    "viewability_display_all_imps": 0.1,
    "viewability_video_sample": 0.1,
    "viewability_video_all_imps": 0.1,
    "standard_segment_cpm": 0.1,
    "connected_id_cost": 0,
    "financing_cost": 0,
    "audience_verification_cost": 0.25,
    "programmatic_guaranteed_platform_access_fee_cpm": 0.1,
    "programmatic_guaranteed_platform_access_fee_pct": 0.1,
    "programmatic_guaranteed_platform_access_fee_unit": "PCT_TOTAL_COST",
    "media_enablement_fee_cpm": 0.1,
    "media_enablement_fee_pct": 0.1,
    "media_enablement_fee_unit": "PCT_TOTAL_COST",
    "source_platform_access_fee_cpm": 0.1,
    "source_platform_access_fee_pct": 0.1,
    "source_platform_access_fee_unit": "PCT_TOTAL_COST",
    "country_tax_withholding_fee_cpm": 0.1,
    "country_tax_withholding_fee_pct": 0.1,
    "country_tax_withholding_fee_unit": "CPM",
    "partnership_rebate_fee_cpm": 0.1,
    "partnership_rebate_fee_pct": 0.1,
    "partnership_rebate_fee_unit": "CPM",
    "cross_device_fee_cpm": 0.1,
    "dba_optimization_fee_cpm": 0.1,
    "dba_optimization_fee_pct": 0.1,
    "dba_optimization_fee_unit": "CPM",
    "audio_video_platform_access_fee_cpm": 0.1,
    "audio_video_platform_access_fee_pct": 0.1,
    "audio_video_platform_access_fee_unit": "CPM",
    "mfa_fee_cpm": 0.1
  }'

Responses

Contract created response

Bodyapplication/json

dataobject(contract_base)

metaobject

Response

{
  "data": {
    "id": 4,
    "version": 44,
    "organization_id": 34,
    "effective_start_date": "2019-08-24T14:15:22Z",
    "effective_end_date": "2019-08-24T14:15:22Z",
    "platform_monthly_min": 0.1,
    "platform_access_fee_pct": 0.1,
    "platform_access_fee_cpm": 0.1,
    "platform_access_fee_fixed": 0.1,
    "managed_service_fee_pct": 0.1,
    "managed_service_fee_cpm": 0.1,
    "managed_service_fee_fixed": 0.1,
    "optimization_fee_pct": 0.1,
    "optimization_fee_cpm": 0.1,
    "optimization_fee_fixed": 0.1,
    "pmp_optimization_off_unit": "PCT_TOTAL_COST",
    "pmp_optimization_off_fee_pct": 0.1,
    "pmp_optimization_off_fee_cpm": 0.1,
    "pmp_optimization_on_unit": "PCT_TOTAL_COST",
    "pmp_optimization_on_fee_pct": 0.1,
    "pmp_optimization_on_fee_cpm": 0.1,
    "dmp_fee_unit": "PCT_TOTAL_COST",
    "dmp_fee_pct": 0.1,
    "dmp_fee_cpm": 0.1,
    "dmp_fee_cpts": 0.1,
    "signals_fee_unit": "PCT_TOTAL_COST",
    "signals_fee_pct": 0.1,
    "signals_fee_cpm": 0.1,
    "t1_apps_fee_unit": "PCT_TOTAL_COST",
    "t1_apps_fee_pct": 0.1,
    "t1_apps_fee_cpm": 0.1,
    "contract_number": 0,
    "spend_cap": 0.1,
    "platform_access_fee_unit": "PCT_TOTAL_COST",
    "managed_service_fee_unit": "PCT_TOTAL_COST",
    "optimization_fee_unit": "PCT_TOTAL_COST",
    "profit_share_fee_pct": 0.1,
    "exclude_agency_margin": false,
    "t1_as_fee_cpm": 0.05,
    "evidon_privacy_cost_cpm": 0.02,
    "peer39_channel_fee_cpm": 0.1,
    "peer39_custom_fee_cpm": 0.1,
    "peer39_safety_fee_cpm": 0.1,
    "peer39_quality_fee_cpm": 0.1,
    "fbx_dynamic_cpm": 0.3,
    "t1_vads_fee_cpm": 0.25,
    "adaptive_segment_cpm": 0,
    "external_media_tracking_cpm": 0,
    "currency_code": "str",
    "t1_html5_fee_cpm": 0.05,
    "viewability_display_sample": 0.1,
    "viewability_display_all_imps": 0.1,
    "viewability_video_sample": 0.1,
    "viewability_video_all_imps": 0.1,
    "standard_segment_cpm": 0.1,
    "connected_id_cost": 0,
    "financing_cost": 0,
    "audience_verification_cost": 0.25,
    "programmatic_guaranteed_platform_access_fee_cpm": 0.1,
    "programmatic_guaranteed_platform_access_fee_pct": 0.1,
    "programmatic_guaranteed_platform_access_fee_unit": "PCT_TOTAL_COST",
    "media_enablement_fee_cpm": 0.1,
    "media_enablement_fee_pct": 0.1,
    "media_enablement_fee_unit": "PCT_TOTAL_COST",
    "source_platform_access_fee_cpm": 0.1,
    "source_platform_access_fee_pct": 0.1,
    "source_platform_access_fee_unit": "PCT_TOTAL_COST",
    "country_tax_withholding_fee_cpm": 0.1,
    "country_tax_withholding_fee_pct": 0.1,
    "country_tax_withholding_fee_unit": "CPM",
    "partnership_rebate_fee_cpm": 0.1,
    "partnership_rebate_fee_pct": 0.1,
    "partnership_rebate_fee_unit": "CPM",
    "cross_device_fee_cpm": 0.1,
    "dba_optimization_fee_cpm": 0.1,
    "dba_optimization_fee_pct": 0.1,
    "dba_optimization_fee_unit": "CPM",
    "audio_video_platform_access_fee_cpm": 0.1,
    "audio_video_platform_access_fee_pct": 0.1,
    "audio_video_platform_access_fee_unit": "CPM",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "mfa_fee_cpm": 0.1
  },
  "meta": {
    "status": "success"
  }
}