Skip to content
/
Update companion - V3

Update companion - V3

Request

Update an existing companion's details. Regenerates the creative's MetaVAST document after the companion is updated.

Path
creativeIdintegerrequired

Creative ID

companionIdintegerrequired

Companion ID

Bodyapplication/jsonrequired

Companion ad details

detailsobject(CompanionDetails)required
fileExtensionstring

File extension

fileNamestring

File name

resourceUrlstring

Resource URL for all other companion types

resourceDatastring

Resource data encoded in Data URI Scheme for static companion types

curl -i -X POST \
  'https://api.mediamath.com/v3.0/creatives/{creativeId}/companions/{companionId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "details": {
      "adServer": "string",
      "typ": "static",
      "width": 32,
      "height": 32,
      "landingUrl": "string",
      "iFrameUrlOrHTML": "string",
      "clickthroughUrl": "string"
    },
    "fileExtension": "string",
    "fileName": "string",
    "resourceUrl": "string",
    "resourceData": "string"
  }'

Responses

Companion updated successfully

Bodyapplication/json
object
Response
{}