Skip to main content
DELETE
Delete a creative field

Path Parameters

workspaceId
string
required
fieldId
string
required

Response

OK

id
string
required
key
string
required

Machine-readable slug the ad meta is keyed by. Derived from the name on create and immutable, so renaming a field never breaks renderers reading the slug.

name
string
required

Human-readable field label.

type
enum<string>
required

Input type of the creative field.

Available options:
Text,
Textarea,
Url,
Number,
Switch,
Image,
Color,
Select
description
string
required

Help text shown under the input in the creative form.

default
string
required

Value pre-filled in the creative form when the field is blank.

placeholder
string
required

Placeholder shown in the creative form input.

isRequired
boolean
required

Whether advertisers must fill this field.

order
integer
required

Sort position within the creative form. Kept as a dense 0..n-1 sequence: reordering renumbers every field, so sparse values are not preserved.

Required range: -9007199254740991 <= x <= 9007199254740991
options
string[]
required

Choices for a Select field. Empty for other types.

maxLength
integer | null
required

Max characters for a Text/Textarea field. Null for no field-specific limit.

Required range: -9007199254740991 <= x <= 9007199254740991
min
number | null
required

Minimum for a Number field. Null for unbounded.

max
number | null
required

Maximum for a Number field. Null for unbounded.

workspaceId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required