The identity and technical contract details declared by the specification.
Error
object
Error payload
2 properties
1 required
FolderResponse
object
7 properties
7 required
Pagination
object
Pagination related information
2 properties
2 required
FolderCreateRequest
object
2 properties
1 required
FolderUpdateRequest
object
2 properties
BasePermissionsResponseSchema
object
6 properties
6 required
FolderPermissionListResponseItem
object
2 properties
2 required
FolderPermissionBulkCreateRequest
object
2 properties
2 required
FolderPermissionUpdateRequest
object
2 properties
FileUrlBulkCreateRequest
object
1 property
1 required
BatchFileUrlResponse
object
1 property
1 required
AssetContent
object
Content of the asset
2 properties
2 required
ResourceLabelResponse
object
Label associated to a fetched resource
2 properties
2 required
AssetResponse
object
15 properties
15 required
LibraryAssetCreateRequest
object
3 properties
2 required
BaseAssetField
object
4 properties
4 required
AssetFieldTypeCurrencyNumber
AssetFieldTypePercentageNumber
AssetFieldTypeSimpleNumber
AssetFieldListResponseItem
BaseObjectFieldUpdatePayload
object
2 properties
2 required
MultiChoiceTypeObjectFieldUpdatePayload
MultiChoiceTypeObjectField
NumberTypeObjectFieldUpdatePayload
DateTypeObjectFieldUpdatePayload
DropdownTypeObjectFieldUpdatePayload
RadioButtonTypeObjectFieldUpdatePayload
RadioButtonTypeObjectField
StringTypeObjectFieldUpdatePayload
AssetTypeObjectFieldUpdatePayload
AssetFieldsUpdateRequest
array
AssetFieldUpdateRequest
object
AssetFieldTypes
string
Type of the field
AssetFieldUpdateResponse
object
5 properties
5 required
AssetVersionCreateRequest
object
2 properties
2 required
LibraryAssetVersionResponse
object
8 properties
8 required
BaseAssetRenditionResponse
object
5 properties
5 required
AssetPermissionListResponseItem
object
2 properties
2 required
AssetPermissionBulkCreateRequest
object
2 properties
2 required
AssetPermissionUpdateRequest
object
2 properties
DetailedAssetRenditionResponse
RenditionConfigResponse
object
8 properties
8 required
AssetLineageCreateRequest
object
4 properties
2 required
AssetLineageResponse
object
10 properties
10 required
RelatedAssetItem
object
7 properties
7 required
RelatedAssetsListResponse
object
2 properties
2 required
ReplaceRelatedAssetsRequest
object
1 property
1 required
ReplaceRelatedAssetsResponse
object
2 properties
2 required
ArticleAuthorResponse
object
Author of the article
1 property
1 required
FeaturedImageResponse
object
9 properties
9 required
Tag
object
2 properties
2 required
LibraryArticle
object
28 properties
28 required
LibraryImage
object
26 properties
26 required
ResourceLabelRequest
object
Payload to associate labels to a resource
2 properties
2 required
LibraryImageUpdateRequest
object
11 properties
LibraryVideo
object
24 properties
24 required
LibraryVideoUpdateRequest
object
11 properties
LibraryRawFile
object
23 properties
23 required
LibraryRawFileUpdateRequest
object
10 properties
NumberFieldValueModel
object
2 properties
1 required
BooleanFieldValueModel
object
2 properties
1 required
DatetimeFieldValueModel
object
2 properties
1 required
TextFieldValueModel
object
2 properties
1 required
RichTextFieldValueModel
object
2 properties
1 required
LibraryAssetType
string
An enumeration.
LibraryAssetFieldValueModel
object
4 properties
2 required
LocalizedFieldValuesWithEmbeddedContent
object
2 properties
2 required
RecursiveStructuredContent
object
8 properties
2 required
ContentFieldValueWithEmbeddedModel
object
1 property
1 required
ContentFieldValueModel
object
4 properties
2 required
URLFieldValueModel
object
2 properties
1 required
JSONFieldValueModel
object
2 properties
1 required
ChoiceFieldValueModel
object
2 properties
1 required
LocationFieldValueModel
object
3 properties
2 required
StructuredContentBody
object
The fields of structured content
1 property
LibraryStructuredContentCreateRequest
object
3 properties
1 required
ContentDetailsModel
object
19 properties
11 required
ContentFieldValueExpandedModel
object
5 properties
3 required
LocalizedFieldValues
object
2 properties
2 required
error_reason
string
An enumeration.
ContentFieldsVersionValidation
object
1 property
ContentFieldsVersionDetails
object
8 properties
5 required
BaseContentTypeVersionModel
object
6 properties
6 required
FieldType
string
An enumeration.
CoreFieldDef
object
13 properties
5 required
ContentTypeFieldEmbedMixConfig
integer
Ref Type: 1 Refer only 2 Refer and create embed 3 Create only
AllowedContentTypeItem
object
2 properties
2 required
ContentTypeFieldDefinition
object
6 properties
3 required
LibraryAssetDefaultValue
object
2 properties
2 required
LibraryAssetFieldDefinition
object
3 properties
2 required
TextFieldDefinition
object
5 properties
3 required
BaseFieldDefinitionType
string
An enumeration.
LocationDefaultValue
object
2 properties
2 required
BaseFieldDefinition
object
3 properties
2 required
DatetimeFieldDefinition
object
4 properties
3 required
RichTextFieldDefinition
object
4 properties
2 required
ChoiceDisplayOption
string
An enumeration.
ChoiceFieldDefinition
object
4 properties
2 required
NumberFieldDefinition
object
4 properties
1 required
VersionedContentTypeModel
object
15 properties
9 required
LibraryStructuredContent
object
11 properties
10 required
DeleteFieldValueModel
object
2 properties
1 required
StructuredContentFields
object
The fields of structured content
RecursivePatchStructuredContentFields
object
8 properties
ContentFieldWithEmbeddedPatchValueModel
object
2 properties
2 required
PatchLocalizedFieldValuesWithEmbeddedContent
object
2 properties
2 required
DeleteLocaleFieldValueModel
object
2 properties
2 required
LibraryStructuredContentUpdateRequest
object
3 properties
LabelGroupValue
object
Values of a label group
2 properties
2 required
LabelGroup
object
4 properties
4 required
TaskListResponseItem
object
13 properties
13 required
TaskCreateRequest
object
6 properties
1 required
TaskSubStep
object
9 properties
9 required
TaskStep
object
6 properties
6 required
TaskResponse
object
15 properties
14 required
TaskUpdateRequest
object
7 properties
AddUrlToTaskRequest
object
2 properties
1 required
TaskUrlResponse
object
2 properties
2 required
TaskBriefTemplateValue
object
Template info of the brief if the brief is of template type
2 properties
2 required
TaskBriefResponse
object
5 properties
4 required
TaskCustomField
object
5 properties
5 required
TaskCustomFieldUpdateRequest
object
1 property
1 required
TaskCustomFieldChoiceListResponseItem
object
2 properties
2 required
FieldBaseType
object
4 properties
4 required
FieldTypePercentageNumber
ObjectFieldCreateRequest
object
ObjectFieldCreateResponse
object
TaskFieldUpdateRequest
object
TaskSubStepRequest
object
5 properties
TaskStepRequest
object
1 property
TaskExternalWorkResponse
object
6 properties
6 required
TaskExternalWorkRequest
object
4 properties
AttachmentResponse
object
3 properties
3 required
TaskSubStepCommentResponse
object
7 properties
6 required
AttachmentRequest
object
2 properties
2 required
CommentWithReplyCreateRequest
object
3 properties
1 required
TaskSubStepCommentUpdateRequest
object
1 property
1 required
TaskAssetResponse
object
9 properties
9 required
TaskAssetRequestForDirectUpload
object
3 properties
2 required
TaskAssetRequestForLibrary
object
3 properties
3 required
TaskAssetDraftListResponseItem
object
8 properties
8 required
TaskAssetDraftResponse
object
8 properties
8 required
TaskAssetDraftBrandComplianceResponse
object
4 properties
4 required
TaskAssetDraftBrandComplianceRequest
object
2 properties
2 required
TaskAssetCommentResponse
object
7 properties
7 required
CommentCreateRequest
object
2 properties
1 required
TaskAssetFieldsUpdateRequest
array
TaskArticle
object
9 properties
8 required
TaskImage
object
11 properties
10 required
TaskVideo
object
10 properties
9 required
TaskRawFile
object
10 properties
9 required
TaskCommentResponse
object
9 properties
9 required
TaskPublishingIntentCreateRequest
object
1 property
1 required
TaskPublishingIntentResponse
object
1 property
1 required
TaskStructuredContentCreateRequest
object
11 properties
1 required
TaskStructuredContentUpdateRequest
object
8 properties
TaskStructuredContentDraftRequest
object
1 property
1 required
MilestoneResponse
object
7 properties
7 required
MilestoneCreateRequest
object
6 properties
3 required
MilestoneUpdateRequest
object
6 properties
CampaignListResponseItem
object
9 properties
9 required
CampaignCreateRequest
object
7 properties
1 required
BudgetResponse
object
Budget of the campaign
2 properties
2 required
CampaignResponse
object
12 properties
12 required
CampaignUpdateRequest
object
4 properties
CampaignCommentResponse
object
9 properties
9 required
CampaignBriefTemplateValue
object
Template info of the brief if the brief is of template type
2 properties
2 required
CampaignBriefResponse
object
5 properties
4 required
CampaignFieldUpdateRequest
object
CampaignFieldTypes
string
Type of the field
CampaignFieldUpdateResponse
object
5 properties
5 required
PublishingChannelResponse
object
3 properties
3 required
PublishingChannelListResponse
object
2 properties
2 required
PublishingEventAssets
object
4 properties
4 required
PublishingEventResponse
object
3 properties
3 required
PublishingEventMetadataResponse
object
9 properties
9 required
PublishingEventMetadataListResponse
object
1 property
PublishingEventMetadataCreateRequest
object
6 properties
2 required
PublishingEventMetadataBulkCreateRequest
object
1 property
1 required
PublishingEventMetadataBulkCreateResponse
object
2 properties
2 required
BaseTemplateResponse
object
5 properties
5 required
TemplateListResponse
object
2 properties
2 required
BaseTemplateFormField
object
8 properties
7 required
TemplateLogicRuleCondition
object
Condition of the rule
2 properties
2 required
TemplateLogicRuleAction
object
Action to perform for the rule
3 properties
3 required
TemplateLogicRule
array
List of logic rules
ResourceChoiceResponse
object
2 properties
2 required
TemplateCurrencyNumberFormField
TemplateInstructionFormField
TemplatePercentageNumberFormField
TemplateSimpleNumberFormField
UserListResponseItem
object
7 properties
7 required
UserListResponse
object
2 properties
2 required
UserResponse
object
7 properties
6 required
BaseFormFieldResponse
object
4 properties
3 required
WorkRequestTextBriefResponse
object
Written brief
2 properties
2 required
WorkRequestAttachmentBriefResponse
object
Brief from uploaded attachment
2 properties
2 required
BriefTypeFormFieldResponse
MultiChoiceTypeFormFieldResponse
NumberTypeFormFieldResponse
DateTypeFormFieldResponse
FileTypeFormFieldValueResponse
object
3 properties
3 required
FileTypeFormFieldResponse
RadioButtonTypeFormFieldResponse
TextTypeFormFieldResponse
WorkRequestResponse
object
11 properties
11 required
BaseFormFieldRequest
object
3 properties
3 required
WorkRequestTextBriefRequest
object
Written brief
2 properties
2 required
WorkRequestAttachmentBriefRequest
object
Brief from uploaded attachment
2 properties
2 required
BriefTypeFormFieldRequest
MultiChoiceTypeFormFieldRequest
NumberTypeFormFieldRequest
FileTypeFormFieldValueRequest
object
2 properties
2 required
RadioButtonTypeFormFieldRequest
WorkRequestCreateRequest
object
3 properties
2 required
WorkRequestUpdateRequest
object
3 properties
WorkRequestCommentResponse
object
9 properties
9 required
CreativeAssetRequest
object
2 properties
2 required
CreativeAssetResponse
object
3 properties
3 required
WorkRequestApprovedAssetResponse
object
5 properties
5 required
WorkRequestCampaignRequest
object
6 properties
1 required
WorkRequestCampaignResponse
object
9 properties
9 required
WorkRequestTaskRequest
object
8 properties
WorkRequestTaskResponse
object
7 properties
6 required
WorkRequestRelatedResourceResponse
object
5 properties
5 required
WorkRequestRequestFormFieldBriefTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldCheckboxTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldCurrencyNumberTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldDateTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldDropdownTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldFileTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldLabelTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldPercentageNumberTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldRadioButtonTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldRichtextTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldSimpleNumberTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldTextAreaTypePayload
object
2 properties
2 required
WorkRequestRequestFormFieldTextTypePayload
object
2 properties
2 required
WorkRequestFormFieldUpdateRequest
WorkRequestRequestFormFieldBriefTypeResponse
object
2 properties
2 required
WorkRequestRequestFormFieldCheckboxTypeResponse
object
2 properties
2 required
WorkRequestRequestFormFieldDropdownTypeResponse
object
2 properties
2 required
WorkRequestRequestFormFieldFileTypeResponse
object
2 properties
2 required
WorkRequestRequestFormFieldLabelTypeResponse
object
2 properties
2 required
WorkRequestRequestFormFieldRadioButtonTypeResponse
object
2 properties
2 required
WorkRequestRequestFormFieldUpdateResponse
ContentTypeListingOption
string
List Type: 1 - Component only 2 - Content only 3 - Component and Content only
BaseContentTypeModel
object
14 properties
8 required
ValidationError
object
3 properties
3 required
HTTPValidationError
object
1 property
CoreContentType
object
5 properties
2 required
SCContentTypeCreateRequest
object
7 properties
3 required
SCContentTypeCreateResponse
object
3 properties
1 required
SCContentTypeUpdateRequest
object
3 properties
2 required
SCContentTypeUpdateResponse
object
1 property
1 required
SCContentTypeVersionCreateRequest
object
3 properties
2 required
SCContentMigrationCreateRequest
object
5 properties
2 required
SCContentPreviewAcknowledgeRequest
object
2 properties
2 required
KeyedPreviewCompletedModel
object
5 properties
1 required
KeyedPreviewErrorModel
object
5 properties
1 required
SCContentPreviewCompleteRequest
object
1 property
1 required
ContentMigrationSummary
object
5 properties
SCContentTypeManagedMigrationResponse
object
10 properties
SCContentTypeManagedMigrationCreateRequest
object
3 properties
2 required
SCContentTypeManagedMigrationStartResponse
object
2 properties
HTTPException
object
1 property
SCContentTypeManagedMigrationValidateRequest
object
2 properties
1 required
Team
object
3 properties
3 required
TeamWithUsers
object
4 properties
4 required
SettingsLabelGroupLabel
object
2 properties
2 required
SettingsLabelGroup
object
3 properties
3 required
CurrencyCustomField
object
4 properties
4 required
NumberCustomField
object
3 properties
3 required
PercentageCustomField
object
2 properties
2 required
MultipleOptionCustomField
object
2 properties
2 required
LabelOnlyCustomField
object
1 property
1 required
SettingsCustomField
object
Settings for custom fields
13 properties
13 required
WorkflowLabel
object
4 properties
4 required
WorkflowCustomfield
object
4 properties
4 required
WorkflowChannel
object
2 properties
2 required
WorkflowSubStep
object
6 properties
5 required
WorkflowStep
object
4 properties
4 required
SettingsWorkflow
object
10 properties
10 required
LogicRuleTargetField
object
Template logic rule action's target field
3 properties
3 required
LogicRuleAction
object
Template logic rule action
3 properties
3 required
LogicRuleCondition
object
Logic rule action associated condition
2 properties
2 required
LogicRule
object
2 properties
2 required
FormField
object
7 properties
7 required
Section
object
2 properties
2 required
Instruction
object
2 properties
2 required
SettingsTemplate
object
7 properties
7 required
SettingsApp
object
6 properties
6 required
SettingsWebhook
object
5 properties
5 required
SettingsRoutingRule
object
5 properties
5 required
SettingsResources
object
7 properties
7 required
Settings
object
1 property
1 required
SettingsChangesetBase
object
7 properties
7 required
SettingsChangeset
object
2 properties
2 required
SettingsUpdateResponse
object
2 properties
2 required
WorkflowListResponseItem
object
4 properties
4 required
WorkflowResponse
object
10 properties
10 required
BaseSettingsFieldsResponse
object
6 properties
6 required
CheckboxAndRadioTypeSettingsFieldResponse
GenericNumberTypeSettingsFieldResponse
CurrencyNumberTypeSettingsFieldResponse
DropdownTypeSettingsFieldResponse
LabelTypeSettingsFieldResponse
BaseSettingsFieldCreatePayload
object
4 properties
3 required
CheckboxAndRadioTypeSettingsFieldCreatePayload
GenericNumberTypeSettingsFieldCreatePayload
CurrencyNumberTypeSettingsFieldCreatePayload
DropdownTypeSettingsFieldCreatePayload
LabelTypeSettingsFieldCreatePayload
SettingsFieldCreateRequest
object
BaseSettingsFieldUpdatePayload
object
4 properties
1 required
GenericNumberTypeSettingsFieldUpdatePayload
CurrencyNumberTypeSettingsFieldUpdatePayload
LabelAndDropdownTypeSettingsFieldUpdatePayload
SettingsFieldUpdateRequest
object
GenericSettingsFieldChoiceCreatePayload
object
Choice for field types other than label
1 property
1 required
LabelTypeSettingsFieldChoiceCreatePayload
SettingsFieldChoiceCreateRequest
array
Choices of the field
SettingsFieldChoiceCreateResponse
array
Choices of the field
GenericSettingsFieldChoiceUpdatePayload
object
Choice for field types other than label
1 property
1 required
LabelTypeSettingsFieldChoiceUpdatePayload
object
Choice for field type of label
2 properties
SettingsFieldChoiceUpdateRequest
object
Payload for updating choice
BrandComplianceCategoriesResponse
object
3 properties
2 required
EventResponse
object
11 properties
11 required
EventCreateRequest
object
7 properties
4 required
EventUpdateRequest
object
5 properties
EventFieldsUpdateRequest
array
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Optimizely publishes across the network.