Embed

Create an embed

Creates a new embed document

post/embed

Request

  • Base URL
    https://api.fanheroapi.com
  • URL
    https://api.fanheroapi.com/embed
  • Auth
    API key in header apiKey

Headers

organizationstring

The URL of the end-user web application

channelstring

Channel ID

Request body

codestring required

Example request

{
  "code": "foo-code",
  "customization": {
    "key": "sample name",
    "value": "sample value"
  }
}

Response

Embed created.

idstring required
createdAtstring date-time required
codestring required
uploadedAtstring date-time required
channelstring required

Example response

{
  "id": "61886612d37f875060b4749c",
  "code": "1234",
  "uploadedAt": "2023-02-13T12:58:15.253Z",
  "customization": {
    "key": "sample name",
    "value": "sample value"
  },
  "channel": "61a91a5b4db7a07e677bce0b"
}

Changes

No recorded changes to this operation across all 1 revision of this API.