createCustomEmbed( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a custom embed within the specified position (HEAD, BODY_START or BODY_END).

Required fields: name, position, embedData (including category and html).

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Marketing Tags
SCOPE.EDITOR.MANAGE_CUSTOM_EMBEDS
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
customEmbedCustomEmbedRequired

Custom embed to create.

Returns
Return Type:Promise<CustomEmbed>
Errors
429Resource Exhausted

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?