Meta ads

Create up to 50 ads from creator content in existing ad sets; each row is checked and created on its own

POST/api/public/v1/meta_ads/bulk
QueuedWorks now; what it creates waits for the Meta connection to publish.

Operation id bulkCreateMetaAds

Request

curl

curl -X POST "https://creator.growthdept.ai/api/public/v1/meta_ads/bulk" \
  -H "Authorization: Bearer gdc_..." \
  -H "Content-Type: application/json" \
  -d '{"ads":[{"copy_template_id":1024,"creative":{"call_to_action":"string","content_submission_version_id":1024,"description":"string","headline":"string","identity_display":"string","link_url":"https://example.com/p/1","page_id":"string","primary_text":"string","require_instagram":true,"social_post_id":"string","tts_external_id":"string","tts_username":"Example name","url_tags":"https://example.com/p/1"},"launch_state":"paused","meta_ad_account_id":1024,"meta_ad_set_id":1024,"meta_partnership_ad_request_id":1024,"name":"Example name"}]}'

Parameters

NameInTypeNotes
organization_idqueryinteger

Request body

FieldTypeNotes
adsarray of objectrequired
ads[].[].copy_template_idinteger
ads[].[].creativeobjectrequired
ads[].[].creative.call_to_actionstringrequired
ads[].[].creative.content_submission_version_idinteger
ads[].[].creative.descriptionstring
ads[].[].creative.headlinestringrequired
ads[].[].creative.identity_displaystring
ads[].[].creative.link_urlstringrequired
ads[].[].creative.page_idstring
ads[].[].creative.primary_textstringrequired
ads[].[].creative.require_instagramboolean
ads[].[].creative.social_post_idstring
ads[].[].creative.tts_external_idstring
ads[].[].creative.tts_usernamestring
ads[].[].creative.url_tagsstring
ads[].[].launch_statestringOne of pausedactive
ads[].[].meta_ad_account_idintegerrequired
ads[].[].meta_ad_set_idintegerrequired
ads[].[].meta_partnership_ad_request_idinteger
ads[].[].namestringrequired

Example

{
  "ads": [
    {
      "copy_template_id": 1024,
      "creative": {
        "call_to_action": "string",
        "content_submission_version_id": 1024,
        "description": "string",
        "headline": "string",
        "identity_display": "string",
        "link_url": "https://example.com/p/1",
        "page_id": "string",
        "primary_text": "string",
        "require_instagram": true,
        "social_post_id": "string",
        "tts_external_id": "string",
        "tts_username": "Example name",
        "url_tags": "https://example.com/p/1"
      },
      "launch_state": "paused",
      "meta_ad_account_id": 1024,
      "meta_ad_set_id": 1024,
      "meta_partnership_ad_request_id": 1024,
      "name": "Example name"
    }
  ]
}

Responses

207Success

FieldTypeNotes
resultsarray of object
results[].[].dataobject
results[].[].data.meta_ad_idinteger
results[].[].data.statestring
results[].[].data.statusstring
results[].[].errorobject
results[].[].error.codestring
results[].[].error.detailsobject
results[].[].error.messagestring
results[].[].error.user_messagestring
results[].[].indexinteger
results[].[].successboolean
successboolean
summaryobject
summary.failedinteger
summary.succeededinteger
summary.totalinteger

Example

{
  "results": [
    {
      "data": {
        "meta_ad_id": 1024,
        "state": "string",
        "status": "string"
      },
      "error": {
        "code": "MAYA15",
        "details": {},
        "message": "string",
        "user_message": "string"
      },
      "index": 3,
      "success": true
    }
  ],
  "success": true,
  "summary": {
    "failed": 3,
    "succeeded": 3,
    "total": 3
  }
}

Errors: 401403404422429with an error and usually a message. See errors.

Example values are made up from each field's type and name.