createCustomEmbed( )

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

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

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
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?