API Reference
Actions Reference
- POSTCreate Campaign
- POSTUpdate Campaign
- POSTGet Campaign By ID
- POSTGet Campaigns
- POSTCreate Ad Set
- POSTUpdate Ad Set
- POSTGet Ad Set By ID
- POSTGet Ad Sets
- POSTCreate Ad
- POSTUpdate Ad
- POSTGet Ad By ID
- POSTBuild Ad Creative Object
- POSTCreate Ad Creative
- POSTCreate Lead Gen Form
- POSTSend Purchase Event
- POSTSend Lead Event
- POSTSend Funnel Event
- POST
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT",
"parameters": {
"adCreativeType": "IMAGE",
"imageURL": "<string>",
"linkURL": "<string>",
"additionalField": {},
"leadGenFormId": "<string>",
"linkTitle": "<string>",
"linkDescription": "<string>",
"message": "<string>",
"callToActionType": "APPLY_NOW"
}
}
'Build Ad Creative Object
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT",
"parameters": {
"adCreativeType": "IMAGE",
"imageURL": "<string>",
"linkURL": "<string>",
"additionalField": {},
"leadGenFormId": "<string>",
"linkTitle": "<string>",
"linkDescription": "<string>",
"message": "<string>",
"callToActionType": "APPLY_NOW"
}
}
'Authorizations
Your Paragon User Token (JWT), which you can generate using your project's signing keys.
Path Parameters
Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.
Body
Show child attributes
Show child attributes
Type : Select a type of ad creative to build.
IMAGE, TEXT, LINK, LEAD_GEN_FORM_ID Image URL : This image will be uploaded to your ad account’s image library. (example: "https://example.com/ad.png") This field appears only when 'adCreativeType' = 'IMAGE')
Link URL : The URL used for the CTA in this ad. (example: "https://example.com/promo") This field appears only when 'adCreativeType' = 'IMAGE') This field appears only when 'type' = '') This field appears only when 'type' = '') This field appears only when 'type' = '')
Additional Fields : Specify any other fields that should be included in the post, as fields of AdCreativeLinkData (https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data/). (example: "{ "call_to_action": { ... }, "child_attachments": [{ ... }] }") This field appears only when 'adCreativeType' = 'IMAGE') This field appears only when 'type' = '') This field appears only when 'type' = '') This field appears only when 'type' = '')
Lead Gen Form ID : The ID of the lead gen form to use with this creative.
This field appears only when 'adCreativeType' = 'LEAD_GEN_FORM_ID')
Link Title : A title to use for the link of your ad. This field appears only when 'adCreativeType' = 'IMAGE') This field appears only when 'type' = '') This field appears only when 'type' = '') This field appears only when 'type' = '')
Link Description : A description to use for the link of your ad. This field appears only when 'adCreativeType' = 'IMAGE') This field appears only when 'type' = '') This field appears only when 'type' = '') This field appears only when 'type' = '')
Message : The body of the post included with the image. This field appears only when 'adCreativeType' = 'IMAGE') This field appears only when 'type' = '')
Call to Action Type This field appears only when 'adCreativeType' = 'LEAD_GEN_FORM_ID')
APPLY_NOW, DOWNLOAD, GET_QUOTE, LEARN_MORE, SIGN_UP, SUBSCRIBE Response
Success
Was this page helpful?