Skip to main content
POST
Create an embed

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the business

Body

application/json
plg
boolean

Whether the embed is a PLG embed. If not provided, the embed will not be a PLG embed.

Response

200 - application/json

The created Embed object

id
string
required

The ID of the embed

business
string
required

The ID of the business

expires_at
string
required

The time when the embed will expire in ISO 8601 format

url
string
required

The URL of the embed

plg
boolean
required

Whether this is a PLG embed

admin
boolean
required

Whether this is an admin embed