---
schema_version: "1"
id: fd3a4cd90dfc93406a080c3627a052ebc323df7ca8d9bd76ef6038e74efd07b3
title: Content - In-App Message (Connect API)
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/mc-core/references/generated-api-specs/mc-next-in-app-message.md
canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud-growth/references/mc-next-in-app-message
source_site: developer.salesforce.com
content_type: documentation
content_hash: f64b452f1240dafee68706211f6e38e6a8ec09018a2cb3186d96b58036262cdb
products:
  - Marketing Cloud Next
  - Marketing Cloud
---
Content - In-App Message (Connect API)

# Content - In-App Message (Connect API)

Create in-app message content in Marketing Cloud Next. In-app messages support banner, full-screen, modal, and push-primer layouts.

This table lists the in-app message-related use cases that the API supports.

| Supported Use Case | HTTP Verb | URI |
| --- | --- | --- |
| Create in-app message content | [POST](/docs/marketing/marketing-cloud-growth/references/mc-next-in-app-message?meta=createInAppMessage) | /services/data/{apiVersion}/connect/cms/contents/inApp |

### In-App Message Content Structure

In-app message content uses a block-based architecture:

```json
{
  "sfdc_cms:title": "My In-App Message",
  "inAppType": "Banner",
  "inAppBlock": {
    "type": "block",
    "definition": "sfdc_cms__inAppTypeBanner",
    "attributes": {
      "type": "Banner",
      "title": {
        "type": "block",
        "definition": "sfdc_cms__inAppTitle",
        "attributes": { "content": { "title": "Banner Title" } }
      },
      "message": {
        "type": "block",
        "definition": "sfdc_cms__inAppMessage",
        "attributes": { "content": { "message": "Banner message" } }
      }
    }
  }
}
```

### In-App Message Types

Marketing Cloud Next supports these in-app message types:

*   **Banner**—Compact notification-style banner with title, message, media, and action buttons
*   **FullScreen**—Full-screen takeover with title, message, media, action buttons, tertiary message, and container styling
*   **Modal**—Centered modal dialog with title, message, media, action buttons, tertiary message, and container styling
*   **PushPrimer**—Permission prompt overlay with title, message, media, action buttons, tertiary message, and container styling

### Sub-Block Types

| Block | Definition | Purpose |
| --- | --- | --- |
| Title | `sfdc_cms__inAppTitle` | The message title. Can include font and color styling. |
| Message | `sfdc_cms__inAppMessage` | A multiline message. Can include font and color styling. |
| Media | `sfdc_cms__inAppMedia` | A reference to an image. Can include sizing and styling. |
| Action Buttons | `sfdc_cms__inAppActionButtons` | A button container. |
| Action Button | `sfdc_cms__inAppActionButton` | An individual button with an associated action. |
| Container Style | `sfdc_cms__inAppContainerStyle` | Style information for the container. |
| Tertiary Message | `sfdc_cms__inAppTertiaryMessage` | Footer text. |
| Tertiary Link | `sfdc_cms__inAppTertiaryLink` | An individual hyperlink. |

### Action Types

The `action` property can contain one of these values:

*   `0`—Dismiss
*   `1`—Go to web URL
*   `2`—Open page in app
*   `3`—Go to app URL (Android)
*   `4`—Go to app URL (iOS)
*   `5`—Go to app URL (both platforms)

### Content Properties

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `sfdc_cms:title` | text | Yes | The name of the in-app message content item. |
| `description` | text | No | A description of the content item. |
| `inAppType` | text | Yes | The message type. Possible values: `Banner`, `FullScreen`, `Modal`, and `PushPrimer`. |
| `inAppImageLayoutType` | text | No | The image layout aspect ratio, such as `16x9`. |
| `inAppBlock` | block | No | A block that contains the message content and configuration. |
| `lightning:dataProviders` | list | No | Data providers for personalization. |

### Data Providers

In-app messages support these data providers for personalization:

*   `sfdc_cms__unifiedIndividualDataProvider`—Unified Individual profile data
*   `sfdc_cms__organizationDataProvider`—Organization data
*   `sfdc_cms__eventListDataProvider`—Event list data
*   `sfdc_cms__couponListDataProvider`—Coupon list data

### Handlebars Expression Support

In-app message content supports [Handlebars scripting](/docs/marketing/handlebars-for-marketing-cloud-next/overview) in title, message, and label fields.

**Version:** 1.0.0

Contact: Salesforce Marketing Cloud, https://www.salesforce.com/products/marketing-cloud/

## Servers

*   `https://{subdomain}.my.salesforce.com`
    *   `subdomain (default (no default)) The unique API subdomain for your Salesforce org.`

## Tags

### In-App Message Content

Operations for managing in-app message content items. In-app messages support four types: Banner, FullScreen, Modal, and PushPrimer.

## Operations

### POST Create in-app message content

`POST /services/data/{apiVersion}/connect/cms/contents/inApp`

Operation ID: `createInAppMessage`. Tags: In-App Message Content.

Creates an in-app message content item. The content body includes the message title, type, and in-app block configuration with sub-blocks for title, message, media, action buttons, container styling, and tertiary messages.

#### Request body (required)

Media type: `application/json`. Schema: `InAppContentRequest`.

_Example: bannerMinimal_ Minimal banner in-app message.

```
{
  "contentSpaceOrFolderId": "0Zuxx00000003M5CAI",
  "contentType": "sfdc_cms__inApp",
  "contentBody": {
    "sfdc_cms:title": "Welcome Banner",
    "inAppType": "Banner",
    "inAppBlock": {
      "type": "block",
      "definition": "sfdc_cms__inAppTypeBanner",
      "attributes": {
        "type": "Banner",
        "title": {
          "type": "block",
          "definition": "sfdc_cms__inAppTitle",
          "attributes": {
            "content": {
              "title": "Welcome!"
            }
          }
        },
        "message": {
          "type": "block",
          "definition": "sfdc_cms__inAppMessage",
          "attributes": {
            "content": {
              "message": "Thanks for opening the app today."
            }
          }
        }
      }
    }
  }
}
```

_Example: fullScreenWithMediaAndActions_ Full-screen message with media and action buttons.

```
{
  "contentSpaceOrFolderId": "0Zuxx00000003M5CAI",
  "contentType": "sfdc_cms__inApp",
  "contentBody": {
    "sfdc_cms:title": "Summer Sale Full Screen",
    "description": "Full-screen promotional message for summer sale.",
    "inAppType": "FullScreen",
    "inAppImageLayoutType": "16x9",
    "inAppBlock": {
      "type": "block",
      "definition": "sfdc_cms__inAppTypeFullScreen",
      "attributes": {
        "type": "FullScreen",
        "title": {
          "type": "block",
          "definition": "sfdc_cms__inAppTitle",
          "attributes": {
            "content": {
              "title": "Summer Sale is Here!"
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Display",
              "fontSize": "24",
              "fontStyle": "Bold",
              "textColor": "#1A1A1A",
              "textAlignment": "Center",
              "padding": "16"
            }
          }
        },
        "message": {
          "type": "block",
          "definition": "sfdc_cms__inAppMessage",
          "attributes": {
            "content": {
              "message": "Get up to 50% off on all summer collections. Limited time only!"
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Text",
              "fontSize": "16",
              "fontStyle": "Regular",
              "textColor": "#4A4A4A",
              "textAlignment": "Center",
              "padding": "12"
            }
          }
        },
        "media": {
          "type": "block",
          "definition": "sfdc_cms__inAppMedia",
          "attributes": {
            "content": {
              "link": {
                "source": {
                  "type": "imageReference",
                  "ref": {
                    "contentKey": "MC5IEGQZHII5GEJLZW5DVSAZHSRI"
                  }
                },
                "url": "/services/data/{apiVersion}/connect/cms/media/MC5IEGQZHII5GEJLZW5DVSAZHSRI?version=1.1&fileName=summer-sale.png"
              },
              "type": "mediaUrl",
              "mediaType": "Image"
            },
            "style": {
              "mediaSize": "Large",
              "insetSize": "0",
              "border": "none",
              "cornerRadius": "8",
              "padding": "0",
              "shadow": "none"
            }
          }
        },
        "actionButtons": {
          "type": "block",
          "definition": "sfdc_cms__inAppActionButtons",
          "attributes": {
            "actions": [
              {
                "type": "block",
                "definition": "sfdc_cms__inAppActionButton",
                "attributes": {
                  "content": {
                    "id": "btn-shop-now",
                    "label": "Shop Now",
                    "action": "1",
                    "actionUrl": "https://example.com/summer-sale",
                    "passbackValue": "shop_summer_sale"
                  },
                  "style": {
                    "androidFont": "Roboto",
                    "iosFont": "SF Pro Text",
                    "fontSize": "16",
                    "fontStyle": "Bold",
                    "textColor": "#FFFFFF",
                    "buttonColor": "#FF6B35",
                    "cornerRadius": "24",
                    "textAlignment": "Center",
                    "border": "none",
                    "shadow": "none",
                    "padding": "12"
                  }
                }
              },
              {
                "type": "block",
                "definition": "sfdc_cms__inAppActionButton",
                "attributes": {
                  "content": {
                    "id": "btn-dismiss",
                    "label": "Maybe Later",
                    "action": "0",
                    "passbackValue": "dismiss_summer_sale"
                  },
                  "style": {
                    "androidFont": "Roboto",
                    "iosFont": "SF Pro Text",
                    "fontSize": "14",
                    "fontStyle": "Regular",
                    "textColor": "#666666",
                    "buttonColor": "#EEEEEE",
                    "cornerRadius": "24",
                    "textAlignment": "Center",
                    "border": "none",
                    "shadow": "none",
                    "padding": "10"
                  }
                }
              }
            ],
            "style": {
              "buttonsLayout": "Vertical"
            }
          }
        },
        "containerStyle": {
          "type": "block",
          "definition": "sfdc_cms__inAppContainerStyle",
          "attributes": {
            "messageOrientation": "Portrait",
            "modalOrientation": "Portrait",
            "overlay": {
              "color": "#000000",
              "opacity": "0.5"
            },
            "background": {
              "color": "#FFFFFF",
              "opacity": "1"
            },
            "cornerRadius": "16",
            "dismissIcon": {
              "iconColor": "#333333",
              "backgroundColor": "#F5F5F5"
            },
            "border": {
              "color": "#E0E0E0",
              "size": "1"
            },
            "shadow": {
              "color": "#000000",
              "length": "4"
            },
            "animation": {
              "slide": "Bottom"
            }
          }
        }
      }
    }
  }
}
```

_Example: modalWithTertiaryMessage_ Modal message with tertiary message and hyperlinks.

```
{
  "contentSpaceOrFolderId": "0Zuxx00000003M5CAI",
  "contentType": "sfdc_cms__inApp",
  "contentBody": {
    "sfdc_cms:title": "Privacy Policy Update Modal",
    "description": "Inform users of updated privacy policy.",
    "inAppType": "Modal",
    "inAppBlock": {
      "type": "block",
      "definition": "sfdc_cms__inAppTypeModal",
      "attributes": {
        "type": "Modal",
        "title": {
          "type": "block",
          "definition": "sfdc_cms__inAppTitle",
          "attributes": {
            "content": {
              "title": "Privacy Policy Updated"
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Display",
              "fontSize": "20",
              "fontStyle": "Bold",
              "textColor": "#1A1A1A",
              "textAlignment": "Center",
              "padding": "16"
            }
          }
        },
        "message": {
          "type": "block",
          "definition": "sfdc_cms__inAppMessage",
          "attributes": {
            "content": {
              "message": "We have updated our privacy policy to better protect your data. Please review the changes."
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Text",
              "fontSize": "14",
              "fontStyle": "Regular",
              "textColor": "#4A4A4A",
              "textAlignment": "Center",
              "padding": "12"
            }
          }
        },
        "actionButtons": {
          "type": "block",
          "definition": "sfdc_cms__inAppActionButtons",
          "attributes": {
            "actions": [
              {
                "type": "block",
                "definition": "sfdc_cms__inAppActionButton",
                "attributes": {
                  "content": {
                    "id": "btn-accept",
                    "label": "I Understand",
                    "action": "0",
                    "passbackValue": "accept_privacy"
                  },
                  "style": {
                    "androidFont": "Roboto",
                    "iosFont": "SF Pro Text",
                    "fontSize": "16",
                    "fontStyle": "Bold",
                    "textColor": "#FFFFFF",
                    "buttonColor": "#0070D2",
                    "cornerRadius": "8",
                    "textAlignment": "Center",
                    "border": "none",
                    "shadow": "none",
                    "padding": "14"
                  }
                }
              }
            ],
            "style": {
              "buttonsLayout": "Horizontal"
            }
          }
        },
        "tertiaryMessage": {
          "type": "block",
          "definition": "sfdc_cms__inAppTertiaryMessage",
          "attributes": {
            "content": {
              "text": "By continuing, you agree to our Terms of Service and Privacy Policy.",
              "links": [
                {
                  "type": "block",
                  "definition": "sfdc_cms__inAppTertiaryLink",
                  "attributes": {
                    "hyperText": "Terms of Service",
                    "hyperLink": "https://example.com/terms"
                  }
                },
                {
                  "type": "block",
                  "definition": "sfdc_cms__inAppTertiaryLink",
                  "attributes": {
                    "hyperText": "Privacy Policy",
                    "hyperLink": "https://example.com/privacy"
                  }
                }
              ]
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Text",
              "fontSize": "12",
              "fontStyle": "Regular",
              "textColor": "#666666",
              "linkColor": "#0070D2",
              "padding": "8",
              "textAlignment": "Center"
            }
          }
        },
        "containerStyle": {
          "type": "block",
          "definition": "sfdc_cms__inAppContainerStyle",
          "attributes": {
            "messageOrientation": "Portrait",
            "modalOrientation": "Portrait",
            "overlay": {
              "color": "#000000",
              "opacity": "0.6"
            },
            "background": {
              "color": "#FFFFFF",
              "opacity": "1"
            },
            "cornerRadius": "12",
            "dismissIcon": {
              "iconColor": "#333333",
              "backgroundColor": "#EEEEEE"
            },
            "border": {
              "color": "#DDDDDD",
              "size": "1"
            },
            "shadow": {
              "color": "#000000",
              "length": "8"
            },
            "animation": {
              "slide": "Bottom"
            }
          }
        }
      }
    }
  }
}
```

_Example: pushPrimer_ Push primer asking for notification permission.

```
{
  "contentSpaceOrFolderId": "0Zuxx00000003M5CAI",
  "contentType": "sfdc_cms__inApp",
  "contentBody": {
    "sfdc_cms:title": "Enable Notifications Primer",
    "description": "Push primer to encourage notification opt-in.",
    "inAppType": "PushPrimer",
    "inAppBlock": {
      "type": "block",
      "definition": "sfdc_cms__inAppTypePushPrimer",
      "attributes": {
        "type": "PushPrimer",
        "title": {
          "type": "block",
          "definition": "sfdc_cms__inAppTitle",
          "attributes": {
            "content": {
              "title": "Stay in the Loop!"
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Display",
              "fontSize": "22",
              "fontStyle": "Bold",
              "textColor": "#1A1A1A",
              "textAlignment": "Center",
              "padding": "16"
            }
          }
        },
        "message": {
          "type": "block",
          "definition": "sfdc_cms__inAppMessage",
          "attributes": {
            "content": {
              "message": "Enable push notifications to get real-time updates on orders, exclusive deals, and more."
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Text",
              "fontSize": "16",
              "fontStyle": "Regular",
              "textColor": "#4A4A4A",
              "textAlignment": "Center",
              "padding": "12"
            }
          }
        },
        "media": {
          "type": "block",
          "definition": "sfdc_cms__inAppMedia",
          "attributes": {
            "content": {
              "link": {
                "source": {
                  "type": "imageReference",
                  "ref": {
                    "contentKey": "MC7BELLICON3NOTIFZW5DVSAZHSRI"
                  }
                },
                "url": "/services/data/{apiVersion}/connect/cms/media/MC7BELLICON3NOTIFZW5DVSAZHSRI?version=1.0&fileName=bell-icon.png"
              },
              "type": "mediaUrl",
              "mediaType": "Image"
            },
            "style": {
              "mediaSize": "Medium",
              "insetSize": "16",
              "border": "none",
              "cornerRadius": "0",
              "padding": "8",
              "shadow": "none"
            }
          }
        },
        "actionButtons": {
          "type": "block",
          "definition": "sfdc_cms__inAppActionButtons",
          "attributes": {
            "actions": [
              {
                "type": "block",
                "definition": "sfdc_cms__inAppActionButton",
                "attributes": {
                  "content": {
                    "id": "btn-enable",
                    "label": "Enable Notifications",
                    "action": "0",
                    "passbackValue": "enable_push"
                  },
                  "style": {
                    "androidFont": "Roboto",
                    "iosFont": "SF Pro Text",
                    "fontSize": "16",
                    "fontStyle": "Bold",
                    "textColor": "#FFFFFF",
                    "buttonColor": "#4CAF50",
                    "cornerRadius": "24",
                    "textAlignment": "Center",
                    "border": "none",
                    "shadow": "none",
                    "padding": "14"
                  }
                }
              },
              {
                "type": "block",
                "definition": "sfdc_cms__inAppActionButton",
                "attributes": {
                  "content": {
                    "id": "btn-not-now",
                    "label": "Not Now",
                    "action": "0",
                    "passbackValue": "dismiss_push_primer"
                  },
                  "style": {
                    "androidFont": "Roboto",
                    "iosFont": "SF Pro Text",
                    "fontSize": "14",
                    "fontStyle": "Regular",
                    "textColor": "#666666",
                    "buttonColor": "transparent",
                    "cornerRadius": "24",
                    "textAlignment": "Center",
                    "border": "none",
                    "shadow": "none",
                    "padding": "10"
                  }
                }
              }
            ],
            "style": {
              "buttonsLayout": "Vertical"
            }
          }
        },
        "tertiaryMessage": {
          "type": "block",
          "definition": "sfdc_cms__inAppTertiaryMessage",
          "attributes": {
            "content": {
              "text": "You can change this anytime in Settings.",
              "links": []
            },
            "style": {
              "androidFont": "Roboto",
              "iosFont": "SF Pro Text",
              "fontSize": "11",
              "fontStyle": "Regular",
              "textColor": "#999999",
              "linkColor": "#0070D2",
              "padding": "4",
              "textAlignment": "Center"
            }
          }
        },
        "containerStyle": {
          "type": "block",
          "definition": "sfdc_cms__inAppContainerStyle",
          "attributes": {
            "messageOrientation": "Portrait",
            "modalOrientation": "Portrait",
            "overlay": {
              "color": "#000000",
              "opacity": "0.5"
            },
            "background": {
              "color": "#FFFFFF",
              "opacity": "1"
            },
            "cornerRadius": "16",
            "dismissIcon": {
              "iconColor": "#333333",
              "backgroundColor": "#F5F5F5"
            },
            "border": {
              "color": "#E0E0E0",
              "size": "0"
            },
            "shadow": {
              "color": "#000000",
              "length": "6"
            },
            "animation": {
              "slide": "Bottom"
            }
          }
        }
      }
    }
  }
}
```

#### Responses

*   **201** In-app message content created successfully.
    
    Media type: `application/json`. Schema: `InAppContentResponse`.
    
    _Example: complete_ Complete response.
    
    ```
    {
      "apiName": "MCJUR5WKNRHZFP7NAUQOMMNJ7CI4",
      "contentBody": {
        "sfdc_cms:title": "Welcome Banner",
        "inAppType": "Banner",
        "inAppBlock": {
          "type": "block",
          "definition": "sfdc_cms__inAppTypeBanner",
          "attributes": {
            "type": "Banner",
            "title": {
              "type": "block",
              "definition": "sfdc_cms__inAppTitle",
              "attributes": {
                "content": {
                  "title": "Welcome!"
                }
              }
            },
            "message": {
              "type": "block",
              "definition": "sfdc_cms__inAppMessage",
              "attributes": {
                "content": {
                  "message": "Thanks for opening the app today."
                }
              }
            }
          }
        }
      },
      "contentFqn": "marketing--Default_Content_Workspace.sfdc_cms__inApp--MCJUR5WKNRHZFP7NAUQOMMNJ7CI4",
      "contentKey": "MCJUR5WKNRHZFP7NAUQOMMNJ7CI4",
      "contentSpace": {
        "id": "0ZuSB000002FYzW0AW",
        "resourceUrl": "/services/data/v65.0/connect/cms/spaces/0ZuSB000002FYzW"
      },
      "contentType": {
        "fullyQualifiedName": "sfdc_cms__inApp"
      },
      "createdBy": {
        "id": "005SB00000eaki1YAA",
        "name": "Admin User",
        "resourceUrl": "/services/data/v65.0/chatter/users/005SB00000eaki1YAA"
      },
      "createdDate": "2026-06-16T20:34:56.000Z",
      "externalId": null,
      "folder": {
        "id": "9PuSB000002KUDo0AO",
        "resourceUrl": "/services/data/v65.0/connect/cms/folders/9PuSB000002KUDo0AO"
      },
      "isPublished": false,
      "language": "en_US",
      "lastModifiedBy": {
        "id": "005SB00000eaki1YAA",
        "name": "Admin User",
        "resourceUrl": "/services/data/v65.0/chatter/users/005SB00000eaki1YAA"
      },
      "lastModifiedDate": "2026-06-16T20:34:56.000Z",
      "managedContentId": "20YSB000004SkOz2AK",
      "managedContentVariantId": "9PsSB0000045XAj0AM",
      "managedContentVersionId": "5OUSB000004K7np4AC",
      "status": {
        "label": "Draft",
        "status": "Draft"
      },
      "title": "Welcome Banner",
      "urlName": "welcome-banner",
      "versionNumber": "1.1"
    }
    ```
    
*   **400** Invalid request body.
    
    Media type: `application/json`. Schema: `Error`.
    
    _Example: missingTitle_ Missing required sfdc\_cms:title.
    
    ```
    {
      "error": "VALIDATION_ERROR",
      "message": "Required field 'sfdc_cms:title' is missing",
      "details": [
        {
          "field": "contentBody.sfdc_cms:title",
          "message": "Title: Complete this field."
        }
      ]
    }
    ```
    
    _Example: missingInAppType_ Missing required inAppType.
    
    ```
    {
      "error": "VALIDATION_ERROR",
      "message": "Required field 'inAppType' is missing",
      "details": [
        {
          "field": "contentBody.inAppType",
          "message": "In-App Type: Complete this field."
        }
      ]
    }
    ```
    
    _Example: additionalProperties_ Additional properties not allowed.
    
    ```
    {
      "error": "VALIDATION_ERROR",
      "message": "Additional properties are not allowed",
      "details": [
        {
          "field": "contentBody.invalidProperty",
          "message": "You can't add the invalidProperty property because additionalProperties is set to false."
        }
      ]
    }
    ```
    
    _Example: invalidInAppType_ Invalid inAppType value.
    
    ```
    {
      "error": "VALIDATION_ERROR",
      "message": "Invalid value for 'inAppType'",
      "details": [
        {
          "field": "contentBody.inAppType",
          "message": "Value must be one of: Banner, FullScreen, Modal, PushPrimer"
        }
      ]
    }
    ```
    
*   **401** Unauthorized.
    
    Media type: `application/json`. Schema: `Error`.
    
    _Example: response_ Example response.
    
    ```
    {
      "error": "UNAUTHORIZED",
      "message": "Authentication credentials are missing or invalid"
    }
    ```
    
*   **403** Forbidden.
    
    Media type: `application/json`. Schema: `Error`.
    
    _Example: response_ Example response.
    
    ```
    {
      "error": "FORBIDDEN",
      "message": "Insufficient permissions to create in-app message content"
    }
    ```
    
*   **500** Internal server error.
    
    Media type: `application/json`. Schema: `Error`.
    
    _Example: response_ Example response.
    
    ```
    {
      "error": "INTERNAL_SERVER_ERROR",
      "message": "An unexpected error occurred while processing the request"
    }
    ```
    
*   **503** Service unavailable.
    
    Media type: `application/json`. Schema: `Error`.
    
    _Example: response_ Example response.
    
    ```
    {
      "error": "SERVICE_UNAVAILABLE",
      "message": "The service is temporarily unavailable. Please try again later"
    }
    ```
    

## Schemas

### InAppContentRequest

Request to create an in-app message content item.

*   `contentSpaceOrFolderId` (_string_, required) The ID of the content space or folder to create the content in.
*   `contentType` (_string_, required) Must be `sfdc_cms__inApp`.  
    Allowed values: `sfdc_cms__inApp`.
*   `contentBody` (_InAppContentBody_, required)

### InAppContentResponse

Response structure returned when creating or retrieving in-app message content. This envelope is standard across all CMS content types.

*   `apiName` (_string_) System-generated API name for the content item.
*   `contentBody` (_InAppContentBody_)
*   `contentFqn` (_string_, nullable) Fully qualified name including workspace and content type.
*   `contentKey` (_string_) 28-character alphanumeric content key used for cross-references.
*   `contentSpace` (_object_)
    *   `id` (_string_)
    *   `resourceUrl` (_string_)
*   `contentType` (_object_)
    *   `fullyQualifiedName` (_string_)
*   `createdBy` (_object_)
    *   `id` (_string_)
    *   `name` (_string_)
    *   `resourceUrl` (_string_)
*   `createdDate` (_string (date-time)_)
*   `externalId` (_string_, nullable) The external ID of the message, if one is set.
*   `folder` (_object_)
    *   `id` (_string_)
    *   `resourceUrl` (_string_)
*   `isPublished` (_boolean_)
*   `language` (_string_)
*   `lastModifiedBy` (_object_)
    *   `id` (_string_)
    *   `name` (_string_)
    *   `resourceUrl` (_string_)
*   `lastModifiedDate` (_string (date-time)_)
*   `managedContentId` (_string_) The Salesforce record ID for the managed content item.
*   `managedContentVariantId` (_string_) The variant ID for this content version.
*   `managedContentVersionId` (_string_) The version ID for this specific content version.
*   `status` (_object_)
    *   `label` (_string_)
    *   `status` (_string_)  
        Allowed values: `Draft`, `Published`.
*   `title` (_string_) The display title of the content.
*   `urlName` (_string_) URL-friendly slug auto-generated from title.
*   `versionNumber` (_string_) Content version number.

### Error

*   `error` (_string_, required) Error code or type.
*   `message` (_string_, required) Human-readable error message.
*   `details` (_array of object_) Additional error details.
    *   `field` (_string_) Field path that caused the error.
    *   `message` (_string_) Field-specific error message.

### InAppContentBody

The content body for an in-app message. Contains CMS metadata, in-app message type, and the in-app block with all content configuration including sub-blocks for title, message, media, action buttons, container styling, and tertiary messages.

*   `sfdc_cms:title` (_string_, required) The title/name of the in-app message content item (used for CMS management).
*   `description` (_string_) Description of the in-app message.  
    Maximum length: 255.
*   `inAppType` (_string_, required) The type of in-app message. Determines which block definition is used for `inAppBlock`.  
    Allowed values: `Banner`, `FullScreen`, `Modal`, `PushPrimer`.
*   `inAppImageLayoutType` (_string_) Image layout aspect ratio for the in-app message media.
*   `inAppBlock` (_InAppBlock_)
*   `lightning:dataProviders` (_array of DataProvider_) Data providers for personalization.

### InAppBlock

The in-app block that contains the content and configuration of the message. The block `definition` must correspond to the `inAppType`:

*   Banner messages use `sfdc_cms__inAppTypeBanner`
*   FullScreen messages use `sfdc_cms__inAppTypeFullScreen`
*   Modal messages use `sfdc_cms__inAppTypeModal`
*   PushPrimer messages use `sfdc_cms__inAppTypePushPrimer`

*   `type` (_string_, required) The type of content. For content blocks, the value is always `block`.  
    Allowed values: `block`.
*   `definition` (_string_, required) Block definition identifier.  
    Allowed values: `sfdc_cms__inAppTypeBanner`, `sfdc_cms__inAppTypeFullScreen`, `sfdc_cms__inAppTypeModal`, `sfdc_cms__inAppTypePushPrimer`.
*   `attributes` (_InAppBlockAttributes_, required)

### DataProvider

Data provider configuration for personalization expressions. Data providers supply runtime data for Handlebars merge fields in message content.

*   `sfdcExpressionKey` (_string_) Expression key prefix used in Handlebars expressions (for example, `$unifiedIndividual`).
*   `definition` (_string_) Data provider block definition.  
    Allowed values: `sfdc_cms__unifiedIndividualDataProvider`, `sfdc_cms__organizationDataProvider`, `sfdc_cms__eventListDataProvider`, `sfdc_cms__couponListDataProvider`.
*   `attributes` (_object_) Data provider configuration attributes.

### InAppBlockAttributes

Attributes for the in-app block. Available properties depend on the in-app message type.

All message types support these properties:

*   `type`—Must match the `inAppType`
*   `title`—Title sub-block (`sfdc_cms__inAppTitle`)
*   `message`—Message sub-block (`sfdc_cms__inAppMessage`)
*   `media`—Media sub-block (`sfdc_cms__inAppMedia`)
*   `actionButtons`—Action buttons sub-block (`sfdc_cms__inAppActionButtons`)

Banner messages also support `type`, `title`, `message`, `media`, `actionButtons`, and `containerStyle`.

FullScreen, Modal, and PushPrimer also support:

*   `tertiaryMessage`—Tertiary message with hyperlinks (`sfdc_cms__inAppTertiaryMessage`)
*   `containerStyle`—Container styling block (`sfdc_cms__inAppContainerStyle`)

*   `type` (_string_) Must match the in-app message type.  
    Allowed values: `Banner`, `FullScreen`, `Modal`, `PushPrimer`.
*   `title` (_InAppTitleBlock_)
*   `message` (_InAppMessageBlock_)
*   `media` (_InAppMediaBlock_)
*   `actionButtons` (_InAppActionButtonsBlock_)
*   `tertiaryMessage` (_InAppTertiaryMessageBlock_)
*   `containerStyle` (_InAppContainerStyleBlock_)

### InAppTitleBlock

Title sub-block for in-app messages. Contains the title text content and optional styling for fonts, colors, and alignment.

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppTitle`.
*   `attributes` (_object_)
    *   `content` (_object_) Title content.
        *   `title` (_string_) The title text displayed in the in-app message.
    *   `style` (_InAppTextStyle_)

### InAppMessageBlock

Message sub-block for in-app messages. Contains the multiline message text and optional styling for fonts, colors, and alignment.

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppMessage`.
*   `attributes` (_object_)
    *   `content` (_object_) Message content.
        *   `message` (_string_) The message text displayed in the in-app message (multiline).
    *   `style` (_InAppTextStyle_)

### InAppMediaBlock

Media sub-block for in-app messages. Contains the image reference/URL and styling for media size, borders, and spacing.

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppMedia`.
*   `attributes` (_object_)
    *   `content` (_InAppMediaContent_)
    *   `style` (_InAppMediaStyle_)

### InAppActionButtonsBlock

Action buttons container sub-block. Holds an array of individual action button blocks and a layout style (Horizontal or Vertical).

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppActionButtons`.
*   `attributes` (_object_)
    *   `actions` (_array of InAppActionButtonBlock_) Array of action button blocks.
    *   `style` (_object_) Button container styling.
        *   `buttonsLayout` (_string_) Layout direction for action buttons.  
            Allowed values: `Horizontal`, `Vertical`.

### InAppTertiaryMessageBlock

Tertiary message sub-block for in-app messages. Displays additional text below the action buttons, typically containing legal text or links. Available for FullScreen, Modal, and PushPrimer types.

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppTertiaryMessage`.
*   `attributes` (_object_)
    *   `content` (_object_) Tertiary message content.
        *   `text` (_string_) The tertiary message text.
        *   `links` (_array of InAppTertiaryLinkBlock_) Array of tertiary link blocks for hyperlinks within the text.
    *   `style` (_InAppTertiaryMessageStyle_)

### InAppContainerStyleBlock

Container style sub-block for in-app messages. Configures the message overlay, background, orientation, corner radius, dismiss icon, borders, shadows, and animation behavior.

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppContainerStyle`.
*   `attributes` (_InAppContainerStyleAttributes_)

### InAppTextStyle

Text styling properties shared by title and message sub-blocks.

*   `androidFont` (_string_) Font family for Android.
*   `iosFont` (_string_) Font family for iOS.
*   `fontSize` (_string_) Font size in points.
*   `fontStyle` (_string_) Font style (for example, Regular, Bold, Italic).
*   `textColor` (_string_) Text color in hex format.
*   `textAlignment` (_string_) Text alignment.  
    Allowed values: `Left`, `Center`, `Right`.
*   `padding` (_string_) Padding in points.

### InAppMediaContent

Media content with image reference, URL, and type information.

*   `link` (_object_) Media link with source reference and URL.
    *   `source` (_object_)
        *   `type` (_string_) Source type.  
            Allowed values: `imageReference`.
        *   `ref` (_object_)
            *   `contentKey` (_string_) CMS content key for the media asset.
    *   `url` (_string_) URL path to the media file.
*   `type` (_string_) Media link type.  
    Allowed values: `mediaUrl`.
*   `mediaType` (_string_) Type of media.  
    Allowed values: `Image`.
*   `altText` (_string_) Alt text for the media image (accessibility).

### InAppMediaStyle

Styling properties for media sub-block.

*   `mediaSize` (_string_) Size of the media element.
*   `insetSize` (_string_) Inset size in points.
*   `border` (_string_) Border style.
*   `cornerRadius` (_string_) Corner radius in points.
*   `padding` (_string_) Padding in points.
*   `shadow` (_string_) Shadow style.

### InAppActionButtonBlock

Individual action button sub-block. Defines button content (label, action behavior) and styling (colors, fonts, borders).

Action values:

*   `0`—Dismiss the in-app message
*   `1`—Go to web URL
*   `2`—Open page in app
*   `3`—Go to app URL (Android only)
*   `4`—Go to app URL (iOS only)
*   `5`—Go to app URL (both platforms)

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppActionButton`.
*   `attributes` (_object_)
    *   `content` (_InAppActionButtonContent_)
    *   `style` (_InAppActionButtonStyle_)

### InAppTertiaryLinkBlock

Individual tertiary link sub-block. Defines a hyperlink within the tertiary message text. The `hyperText` value should match a substring in the parent tertiary message `text` to be rendered as a tappable link.

*   `type` (_string_)  
    Allowed values: `block`.
*   `definition` (_string_)  
    Allowed values: `sfdc_cms__inAppTertiaryLink`.
*   `attributes` (_object_)
    *   `hyperText` (_string_) The text substring to render as a hyperlink.
    *   `hyperLink` (_string_) The URL the hyperlink navigates to.

### InAppTertiaryMessageStyle

Styling properties for tertiary message sub-block.

*   `androidFont` (_string_) Font family for Android.
*   `iosFont` (_string_) Font family for iOS.
*   `fontSize` (_string_) Font size in points.
*   `fontStyle` (_string_) Font style (for example, Regular, Bold).
*   `textColor` (_string_) Text color in hex format.
*   `linkColor` (_string_) Hyperlink text color in hex format.
*   `padding` (_string_) Padding in points.
*   `textAlignment` (_string_) Text alignment.  
    Allowed values: `Left`, `Center`, `Right`.

### InAppContainerStyleAttributes

Container style configuration attributes.

*   `messageOrientation` (_string_) Orientation of the message.
*   `modalOrientation` (_string_) Orientation of the modal.
*   `overlay` (_object_) Background overlay configuration.
    *   `color` (_string_) Overlay color in hex format.
    *   `opacity` (_string_) Overlay opacity (0 to 1).
*   `background` (_object_) Message background configuration.
    *   `color` (_string_) Background color in hex format.
    *   `opacity` (_string_) Background opacity (0 to 1).
*   `cornerRadius` (_string_) Corner radius of the message container in points.
*   `dismissIcon` (_object_) Dismiss (close) icon styling.
    *   `iconColor` (_string_) Icon color in hex format.
    *   `backgroundColor` (_string_) Icon background color in hex format.
*   `border` (_object_) Container border configuration.
    *   `color` (_string_) Border color in hex format.
    *   `size` (_string_) Border size in points.
*   `shadow` (_object_) Container shadow configuration.
    *   `color` (_string_) Shadow color in hex format.
    *   `length` (_string_) Shadow length/spread in points.
*   `animation` (_object_) Entry animation configuration.
    *   `slide` (_string_) Slide-in direction for the message.  
        Allowed values: `Top`, `Bottom`, `Left`, `Right`.

### InAppActionButtonContent

Action button content properties.

*   `id` (_string_) Unique identifier for the button.
*   `label` (_string_) Button label text displayed to the user.
*   `action` (_string_)
    
    The type of action triggered when the user taps the button:
    
    *   `0`—Dismiss
    *   `1`—Go to web URL
    *   `2`—Open page in app
    *   `3`—Go to app URL (Android)
    *   `4`—Go to app URL (iOS)
    *   `5`—Go to app URL (both)
    
      
    Allowed values: `0`, `1`, `2`, `3`, `4`, `5`.
*   `actionUrl` (_string_) URL for action types 1–5 (web URL, deep link, or app URL).
*   `androidAppURL` (_string_) Android-specific app URL (for action type 3 or 5).
*   `iosAppURL` (_string_) iOS-specific app URL (for action type 4 or 5).
*   `passbackValue` (_string_) Unique identifier passed back to the app when the action is triggered.

### InAppActionButtonStyle

Action button styling properties.

*   `androidFont` (_string_) Font family for Android.
*   `iosFont` (_string_) Font family for iOS.
*   `fontSize` (_string_) Font size in points.
*   `fontStyle` (_string_) Font style (for example, Regular, Bold).
*   `textColor` (_string_) Button text color in hex format.
*   `buttonColor` (_string_) Button background color in hex format.
*   `cornerRadius` (_string_) Button corner radius in points.
*   `textAlignment` (_string_) Text alignment within the button.  
    Allowed values: `Left`, `Center`, `Right`.
*   `border` (_string_) Border style.
*   `shadow` (_string_) Shadow style.
*   `padding` (_string_) Padding in points.