PUT
/
setup_processes
/
{eid}
Error
A valid request URL is required to generate request examples
{
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "id": 123,
  "total_budget": 123,
  "goal": "UTILIZATION",
  "conversion_id": "<string>",
  "creatives": [
    {
      "tc": "<string>",
      "tc_run_id": 123,
      "destination_url": [
        "<string>"
      ],
      "call_to_action": "SHOP_NOW",
      "headline": [
        "<string>"
      ],
      "body": [
        "<string>"
      ],
      "description": "<string>",
      "audience_id": "<string>",
      "media": [
        {
          "type": "<string>",
          "filename": "<string>",
          "url": "<string>",
          "size": 123
        }
      ],
      "excluded_variations": [
        "<string>"
      ]
    }
  ],
  "targeting": [
    {
      "tc": "<string>",
      "tc_run_id": 123,
      "location_recency": [
        "recent"
      ],
      "postal-codes": {
        "countries": {
          "*": {}
        }
      },
      "range-locations": {
        "excluded": [
          {
            "location": {
              "key": "<string>",
              "name": "<string>",
              "type": "<string>",
              "country_name": "nullable string"
            },
            "mile_range": 30,
            "kilometer_range": 48
          }
        ],
        "included": [
          {
            "location": {
              "key": "<string>",
              "name": "<string>",
              "type": "<string>",
              "country_name": "nullable string"
            },
            "mile_range": 30,
            "kilometer_range": 48
          }
        ]
      },
      "targeting_mode": "fd_targeting"
    }
  ],
  "integration_details": [
    {
      "id": "<string>",
      "partner_id": "<string>",
      "platform": "facebook",
      "asset_class": "profile",
      "asset_id": "<string>",
      "asset_label": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Copy your Cognito JWT Token below: 'Bearer <JWT>'

Path Parameters

eid
string
required

Body

application/json
start_date
string<date-time>
required
end_date
string<date-time>
required
id
integer

Setup process ID

total_budget
integer
goal
enum<string>
Available options:
UTILIZATION,
ROAS,
VISIBILITY,
LINK_CLICKS
Example:

"UTILIZATION"

conversion_id
string

Custom conversion event ID

creatives
object[]
targeting
object[]
integration_details
object[]

Response

Success

start_date
string<date-time>
required
end_date
string<date-time>
required
id
integer

Setup process ID

total_budget
integer
goal
enum<string>
Available options:
UTILIZATION,
ROAS,
VISIBILITY,
LINK_CLICKS
Example:

"UTILIZATION"

conversion_id
string

Custom conversion event ID

creatives
object[]
targeting
object[]
integration_details
object[]