Marketing API Version

Ad Creative Link Data Custom Overlay Spec

Reading

How to render custom overlays on an image.

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription

background_color

enum {background_ffffff, background_e50900, background_f78400, background_00af4c, background_0090ff, background_755dde, background_f23474, background_595959, background_000000}

Background color to use in overlay.

float_with_margin

bool

Whether the overlay should have a margin.

font

enum {droid_serif_regular, lato_regular, nunito_sans_bold, open_sans_bold, pt_serif_bold, roboto_medium, roboto_condensed_regular, noto_sans_regular}

Font to be used for rendering text on overlay.

option

enum {bank_transfer, boleto, discount_with_boleto, cash_on_delivery, free_shipping}

What type of overlay should be rendered.

position

enum {top_left, top_right, bottom_left, bottom_right}

Position for overlay on an image.

template

enum {pill_with_text}

Overlay creative template.

text_color

enum {text_ffffff, text_c91b00, text_f78400, text_009c2a, text_007ad0, text_755dde, text_f23474, text_646464, text_000000}

Text color to use in overlay.

Edges

No edges

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.