API docs by Redocly

Enterprise API - Beta (0.1.0)

Download OpenAPI specification:Download

Campaign

A campaign is an AR experience served on a web browser.

Create

It creates a campaign in draft state.

Authorizations:
bearerAuth
Request Body schema: application/json
flow_type
required
string
Enum: "storytelling" "random"
name
required
string

The name of the campaign, this will be used to generate a unique slug.

trigger_type
required
string
Enum: "image-tracking" "surface"

Which kind of AR campaign will be used. At the moment, only image tracking and surface are fully supported on this API.

init_scenes
number

Use this property if you want to initialize a campaign with already a prepopulated scene. Surface campaigns only support 1 scene.

runtime_dataset
boolean

If you are using an image tracking campaign, this parameter will allow the autogeneration of the dataset.

Responses

Request samples

Content type
application/json
{
  • "flow_type": "storytelling",
  • "name": "My AR Campaign",
  • "trigger_type": "image-tracking",
  • "init_scenes": 1,
  • "runtime_dataset": true
}

Response samples

Content type
application/json
{
  • "id": "63b2e0b081b3cab5cd6d1280",
  • "_id": "63b2e0b081b3cab5cd6d1280",
  • "name": "My AR Campaign",
  • "slug": "my-ar-campaign",
  • "status": "draft",
  • "trigger_type": "image-tracking",
  • "flow_type": "storytelling",
  • "runtime_dataset": true,
  • "domain": null,
  • "scenes": [
    ],
  • "created_at": "2023-01-02T13:56:58.712Z",
  • "draft_token": null,
  • "favicon": null,
  • "launcher_logo": null,
  • "logo": null,
  • "launcher": {
    },
  • "style_kit": "581765f1b2460a117e34115f2"
}

Show

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign.

Responses

Response samples

Content type
application/json
{
  • "id": "63b2e0b081b3cab5cd6d1280",
  • "_id": "63b2e0b081b3cab5cd6d1280",
  • "name": "My AR Campaign",
  • "slug": "my-ar-campaign",
  • "status": "draft",
  • "trigger_type": "image-tracking",
  • "flow_type": "storytelling",
  • "runtime_dataset": true,
  • "domain": null,
  • "scenes": [
    ],
  • "created_at": "2023-01-02T13:56:58.712Z",
  • "draft_token": null,
  • "favicon": null,
  • "launcher_logo": null,
  • "logo": null,
  • "launcher": {
    },
  • "style_kit": "581765f1b2460a117e34115f2"
}

Update

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign.

Request Body schema: application/json
name
string

The name of the campaign, this will be used to generate a unique slug.

status
string
Enum: "published" "archived"

The status of the campaign. A campaign in draft can be reached only by using a draft-token. A published campaign is public and reachable from everybody. An archived campaign is not reachable from anybody and is no more editable.

slug
string

A unique identifier of the campaign. This is used into the relative URL of the campaign. For example, if your campaign has the slug 'my-campaign', it will be reachable from https://app.aryel.io/your-company-slug/my-campaign.

object
Deprecated
runtime_dataset
boolean

If you are using an image tracking campaign, this parameter will allow the autogeneration of the dataset.

Responses

Request samples

Content type
application/json
{
  • "name": "My AR Campaign",
  • "status": "published",
  • "slug": "my-campaign",
  • "launcher": {
    },
  • "runtime_dataset": true
}

Response samples

Content type
application/json
{
  • "id": "63b2e0b081b3cab5cd6d1280",
  • "_id": "63b2e0b081b3cab5cd6d1280",
  • "name": "My AR Campaign",
  • "slug": "my-ar-campaign",
  • "status": "draft",
  • "trigger_type": "image-tracking",
  • "flow_type": "storytelling",
  • "runtime_dataset": true,
  • "domain": null,
  • "scenes": [
    ],
  • "created_at": "2023-01-02T13:56:58.712Z",
  • "draft_token": null,
  • "favicon": null,
  • "launcher_logo": null,
  • "logo": null,
  • "launcher": {
    },
  • "style_kit": "581765f1b2460a117e34115f2"
}

Delete

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign.

Responses

Style Kit Update

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign.

Request Body schema: application/json
style_kit
string

The id of the style kit.

Responses

Request samples

Content type
application/json
{
  • "style_kit": "581765f1b2460a117e34115f2"
}

Response samples

Content type
application/json
{
  • "id": "63b2e0b081b3cab5cd6d1280",
  • "_id": "63b2e0b081b3cab5cd6d1280",
  • "name": "My AR Campaign",
  • "slug": "my-ar-campaign",
  • "status": "draft",
  • "trigger_type": "image-tracking",
  • "flow_type": "storytelling",
  • "runtime_dataset": true,
  • "domain": null,
  • "scenes": [
    ],
  • "created_at": "2023-01-02T13:56:58.712Z",
  • "draft_token": null,
  • "favicon": null,
  • "launcher_logo": null,
  • "logo": null,
  • "launcher": {
    },
  • "style_kit": "581765f1b2460a117e34115f2"
}

Duplicate

Given a campaign id, the campaign pointed by that id will be duplicated.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign.

Request Body schema: application/json
deep_copy
boolean

If set to true, the media assets will be duplicated altogether with the campaign. Note that, if set to false and the campaign contains a 3D model with textures, any future texture replacement for the asset will imply the same change for all the campaigns where it's contained.

Responses

Request samples

Content type
application/json
{
  • "deep_copy": true
}

Response samples

Content type
application/json
{
  • "id": "63b2e0b081b3cab5cd6d1280",
  • "_id": "63b2e0b081b3cab5cd6d1280",
  • "name": "My AR Campaign",
  • "slug": "my-ar-campaign",
  • "status": "draft",
  • "trigger_type": "image-tracking",
  • "flow_type": "storytelling",
  • "runtime_dataset": true,
  • "domain": null,
  • "scenes": [
    ],
  • "created_at": "2023-01-02T13:56:58.712Z",
  • "draft_token": null,
  • "favicon": null,
  • "launcher_logo": null,
  • "logo": null,
  • "launcher": {
    },
  • "style_kit": "581765f1b2460a117e34115f2"
}

Campaign / Draft Token

The Draft Token is used as queryparam to test a draft state campaign. For example, a draft state campaign https://ar.my-site.com/my-campaign is not testable, but by passing the queryparam ?draft-token=token you can test it. The token expires after 1 hour.

Create

Create a draft token. The 'token' key contains the token to be passed as a queryparam to the draft campaign.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign.

Responses

Response samples

Content type
application/json
{
  • "id": "63b2e97aa9a128f1dd1b65ea",
  • "_id": "63b2e97aa9a128f1dd1b65ea",
  • "expires_at": "2023-01-02T15:26:02.107Z",
  • "token": "db249a26dd997797ef872f48e3f4fd02"
}

Show

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign.

Responses

Response samples

Content type
application/json
{
  • "id": "63b2e97aa9a128f1dd1b65ea",
  • "_id": "63b2e97aa9a128f1dd1b65ea",
  • "expires_at": "2023-01-02T15:26:02.107Z",
  • "token": "db249a26dd997797ef872f48e3f4fd02"
}

Campaign / Brand Identity

Those are the requests to change all logos and images to customize the brand identity of the campaign.

Create Favicon Deprecated

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to load the favicon.

Request Body schema: multipart/form-data
file
string <binary>

The file you want to uplaod, max size available 3MB.

Responses

Response samples

Content type
application/json
{}

Create Launcher Logo Deprecated

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to load the launcher logo.

Request Body schema: multipart/form-data
file
string <binary>

The file you want to uplaod, max size available 3MB.

Responses

Response samples

Content type
application/json
{}

Create Logo Deprecated

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to load the logo.

Request Body schema: multipart/form-data
file
string <binary>

The file you want to uplaod, max size available 3MB.

Responses

Response samples

Content type
application/json
{}

Campaign / Scene

The scene is the environment where the 3D content is placed in the space. And it is shown when the trigger is resolved.

Create

Creates a scene on a given campaign. The total number of scenes is limited to 1 surface campaigns.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to create a new scene.

Request Body schema: application/json
name
string

The name of the scene.

orientation
string
Enum: "flat" "upright"

The orientation of the content related to the trigger. More info at https://intercom.help/aryel/en/articles/6215508-what-do-flat-upright-icons-mean.

Responses

Request samples

Content type
application/json
{
  • "name": "Scene 1",
  • "orientation": "flat"
}

Response samples

Content type
application/json
{
  • "_id": "63b2e2aaa9a128f1dd1b65d5",
  • "id": "63b2e2aaa9a128f1dd1b65d5",
  • "name": "Scene 1",
  • "trigger_type": "image-tracking",
  • "orientation": "flat",
  • "assets": [
    ],
  • "triggers": [
    ]
}

List

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign to list the scene.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to show the scene.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene to show in the campaign.

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2e2aaa9a128f1dd1b65d5",
  • "id": "63b2e2aaa9a128f1dd1b65d5",
  • "name": "Scene 1",
  • "trigger_type": "image-tracking",
  • "orientation": "flat",
  • "assets": [
    ],
  • "triggers": [
    ]
}

Delete

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to delete the scene from.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene to delete from the campaign.

Responses

Duplicate

Given a scene id, the scene pointed by that id will be duplicated inside the same campaign. This action is not available for surface campaigns

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to show the scene.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene to show in the campaign.

Request Body schema: application/json
deep_copy
boolean

If set to true, the media assets will be duplicated altogether with the scene. Note that, if set to false and the scene contains a 3D model with textures, any future texture replacement for the asset will imply the same change for all the campaigns where it's contained.

Responses

Request samples

Content type
application/json
{
  • "deep_copy": true
}

Response samples

Content type
application/json
{
  • "_id": "63b2e2aaa9a128f1dd1b65d5",
  • "id": "63b2e2aaa9a128f1dd1b65d5",
  • "name": "Scene 1",
  • "trigger_type": "image-tracking",
  • "orientation": "flat",
  • "assets": [
    ],
  • "triggers": [
    ]
}

Campaign / Scene / Triggers

Triggers are used to show the AR content. They are not used for Surface campaigns, while for the Image tracking, they consist of an image which is framed from the camera.

Create image tracking trigger

It could only be used within image tracking campaigns.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to add a trigger. The campaign trigger_type should be the same type as the campaign trigger.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to add an image tracking trigger.

Request Body schema: multipart/form-data
file
required
string <binary>

The file you want to uplaod as trigger.

name
string

The name of the image tracking trigger.

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "name": "image-trigger",
  • "trigger_type": "image-tracking",
  • "hash": "706a38315a16c2d334c2550f02f07b76",
  • "resource": {}
}

List

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene with triggers.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to list the triggers.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene with the trigger.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene with image tracking trigger.

trigger
required
string

The id of the image tracking trigger to show.

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "name": "image-trigger",
  • "trigger_type": "image-tracking",
  • "hash": "706a38315a16c2d334c2550f02f07b76",
  • "resource": {}
}

Delete

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene with the trigger.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene with image tracking trigger.

trigger
required
string

The id of the image tracking trigger to delete.

Responses

Campaign / Scene / Asset

Assets represent the content shown by the scene initialization.

Create 3D Asset

It creates 3D asset in the campaign scene. For surface campaigns only one 3d asset can be created.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to load a 3d model.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to load a 3d model.

Request Body schema: multipart/form-data
file
string <binary>

The 3D file you want to uplaod. Max size available 40MB.

name
string

The name of the asset. It has a labeling purpose.

position[x]
integer

The position on the x of the asset into a three-dimensional space.

position[y]
integer

The position on the y of the asset into a three-dimensional space.

position[z]
integer

The position on the z of the asset into a three-dimensional space.

gestures
boolean

Enable or disable the gestures on the campaign for this specific asset.

rotation[x]
integer

The rotation on the x of the asset into a three-dimensional space.

rotation[y]
integer

The rotation on the y of the asset into a three-dimensional space.

rotation[z]
integer

The rotation on the z of the asset into a three-dimensional space.

scale[x]
integer

The scale on the x of the asset into a three-dimensional space.

scale[y]
integer

The scale on the y of the asset into a three-dimensional space.

scale[z]
integer

The scale on the z of the asset into a three-dimensional space.

media
string

The id of a pre-created 3d media object.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "3d",
  • "gestures": true,
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}

Create Audio Asset

It creates audio asset in the campaign scene. It won't work with surface campaigns. In all other types of campaign it's limited to 1 per scene.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to load an asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to load an asset.

Request Body schema: multipart/form-data
file
string <binary>

The audio file you want to uplaod. Max size available 40MB.

name
string

The name of the asset. It has a labeling purpose.

loop
boolean

Enable or disable the loop on the audio file. If true, the audio auto-restarts when reaching the end of the track.

autoplay
boolean

Enable or disable the autoplay on the audio file. If true, the audio automatically starts once scene is loaded if campaign type is 'storytelling'. On campaign type 'random' the audio starts once the campaign is loaded.

media
string

The id of a pre-created audio media object.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "audio",
  • "loop": false,
  • "autoplay": false,
  • "media": {},
  • "actions": []
}

Create Button Asset

It creates button asset on campaign scene. On any type of campaign it's limited to 1 per scene.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to load the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to load the asset.

Request Body schema: application/json
text
string

The displayed label of a button.

background_color
string

Hex color code of button's background.

text_color
string

Hex color code of button's text.

border_radius
string

The pixel amount value of border-radius css property.

font_family
string

The value of font-family css property. Please take note: the font_family is just a string containing the font family name, it's not bound to the provided font_url.

font_variant
string

The value of font-weight css property.

font_url
string

The URL to the .ttf font file.

button_type
string
Enum: "phone" "email" "link"

The type of link to assign to the button. It can be a URL, a call or a mailto link.

Array of objects (ActionArray)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Create Image Asset

It creates an image asset in a campaign scene. It won't work with surface campaigns.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to load the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to load the asset.

Request Body schema: multipart/form-data
file
string <binary>

The image file you want to uplaod. Max size available 40MB.

name
string

The name of the asset. It has a labeling purpose.

position[x]
integer

The position on the x of the asset into a three-dimensional space.

position[y]
integer

The position on the y of the asset into a three-dimensional space.

position[z]
integer

The position on the z of the asset into a three-dimensional space.

rotation[x]
integer

The rotation on the x of the asset into a three-dimensional space.

rotation[y]
integer

The rotation on the y of the asset into a three-dimensional space.

rotation[z]
integer

The rotation on the z of the asset into a three-dimensional space.

scale[x]
integer

The scale on the x of the asset into a three-dimensional space.

scale[y]
integer

The scale on the y of the asset into a three-dimensional space.

scale[z]
integer

The scale on the z of the asset into a three-dimensional space.

media
string

The id of a pre-created image media object.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "image",
  • "name": "My 3D asset",
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}

Create Text Asset

It creates text asset in a campaign scene. It won't work with surface campaigns.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to load the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to load the asset.

Request Body schema: application/json
name
string

The name of the asset. It has a labeling purpose.

text
string

The displayed text value.

text_color
string

Hex color code of text.

text_align
string

The value of text-align css property.

font_family
string

The value of font-family css property. Please take note: the font_family is just a string containing the font family name, it's not bound to the provided font_url.

font_variant
string

The value of font-weight css property.

font_url
string

The URL to the .ttf font file.

object (CartesianAxe)
object (CartesianAxe)
object (CartesianAxe)
Array of objects (ActionArray)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "text",
  • "name": "My 3D asset",
  • "text": "string",
  • "text_color": "string",
  • "text_align": "string",
  • "font_family": "Roboto",
  • "font_variant": "100",
  • "font_url": "https://fonts.gstatic.com/s/roboto/v30/KFOkCnqEu92Fr1MmgWxPKTM1K9nz.ttf",
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "actions": []
}

Create Video Asset

It creates a video asset in campaign scene. It won't work with surface campaigns.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to load the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to load the asset.

Request Body schema: multipart/form-data
file
string <binary>

The video file you want to uplaod. Max size available 40MB.

name
string

The name of the asset. It has a labeling purpose.

loop
boolean

Enable or disable the loop on the video file. If true, the video auto-restarts when reaching the end of the track.

object
position[x]
integer

The position on the x of the asset into a three-dimensional space.

position[y]
integer

The position on the y of the asset into a three-dimensional space.

position[z]
integer

The position on the z of the asset into a three-dimensional space.

rotation[x]
integer

The rotation on the x of the asset into a three-dimensional space.

rotation[y]
integer

The rotation on the y of the asset into a three-dimensional space.

rotation[z]
integer

The rotation on the z of the asset into a three-dimensional space.

scale[x]
integer

The scale on the x of the asset into a three-dimensional space.

scale[y]
integer

The scale on the y of the asset into a three-dimensional space.

scale[z]
integer

The scale on the z of the asset into a three-dimensional space.

media
string

The id of a pre-created video media object.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "video",
  • "name": "My 3D asset",
  • "look_at_camera": false,
  • "loop": false,
  • "chromakey": {
    },
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}

List

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene with all the assets.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to list all the assets.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene with the asset to show.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene with the asset to show.

asset
required
string

The id of the asset to show.

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "3d",
  • "gestures": true,
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}

Delete

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene with the asset to delete.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene with the asset to delete.

asset
required
string

The id of the asset to delete.

Responses

Edit 3D Asset

Given a 3D asset inside a scene, the endpoint allows to edit its properties or to replace the whole source file. Please note that all unspecified properties will be left unchanged.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to edit the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to edit the asset.

asset
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the asset you want to edit.

Request Body schema: multipart/form-data
file
string <binary>

The 3D file you want to upload. Max size available 40MB. Please note: You can either select a 'media' field or upload a new file, not both.

name
string

The name of the asset. It has a labeling purpose.

position[x]
integer

The position on the x of the asset into a three-dimensional space.

position[y]
integer

The position on the y of the asset into a three-dimensional space.

position[z]
integer

The position on the z of the asset into a three-dimensional space.

gestures
boolean

Enable or disable the gestures on the campaign for this specific asset.

rotation[x]
integer

The rotation on the x of the asset into a three-dimensional space.

rotation[y]
integer

The rotation on the y of the asset into a three-dimensional space.

rotation[z]
integer

The rotation on the z of the asset into a three-dimensional space.

scale[x]
integer

The scale on the x of the asset into a three-dimensional space.

scale[y]
integer

The scale on the y of the asset into a three-dimensional space.

scale[z]
integer

The scale on the z of the asset into a three-dimensional space.

media
string

The id of a pre-created 3d media object. Please note: You can either select a 'media' field or upload a new file, not both.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "3d",
  • "gestures": true,
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}

Edit Audio Asset

Given an audio asset inside a scene, the endpoint allows to edit its properties or to replace the whole source file. Please note that all unspecified properties will be left unchanged.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to edit the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to edit the asset.

asset
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the asset you want to edit.

Request Body schema: multipart/form-data
file
string <binary>

The audio file you want to upload. Max size available 40MB. Please note: You can either select a 'media' field or upload a new file, not both.

name
string

The name of the asset. It has a labeling purpose.

loop
boolean

Enable or disable the loop on the audio file. If true, the audio auto-restarts when reaching the end of the track.

autoplay
boolean

Enable or disable the autoplay on the audio file. If true, the audio automatically starts once scene is loaded if campaign type is 'storytelling'. On campaign type 'random' the audio starts once the campaign is loaded.

media
string

The id of a pre-created audio media object. Please note: You can either select a 'media' field or upload a new file, not both.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "audio",
  • "loop": false,
  • "autoplay": false,
  • "media": {},
  • "actions": []
}

Edit Button Asset

Given a button asset inside a scene, the endpoint allows to edit its properties. Please note that all unspecified properties will be left unchanged.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to edit the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to edit the asset.

asset
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the asset you want to edit.

Request Body schema: application/json
text
string

The displayed label of a button.

background_color
string

Hex color code of button's background.

text_color
string

Hex color code of button's text.

border_radius
string

The pixel amount value of border-radius css property.

font_family
string

The value of font-family css property. Please take note: the font_family is just a string containing the font family name, it's not bound to the provided font_url.

font_variant
string

The value of font-weight css property.

font_url
string

The URL to the .ttf font file.

button_type
string
Enum: "phone" "email" "link"

The type of link to assign to the button. It can be a URL, a call or a mailto link.

Array of objects (ActionArray)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Edit Image Asset

Given an image asset inside a scene, the endpoint allows to edit its properties or to replace the whole source file. Please note that all unspecified properties will be left unchanged.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to edit the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to edit the asset.

asset
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the asset you want to edit.

Request Body schema: multipart/form-data
file
string <binary>

The image file you want to upload. Max size available 40MB. Please note: You can either select a 'media' field or upload a new file, not both.

name
string

The name of the asset. It has a labeling purpose.

position[x]
integer

The position on the x of the asset into a three-dimensional space.

position[y]
integer

The position on the y of the asset into a three-dimensional space.

position[z]
integer

The position on the z of the asset into a three-dimensional space.

rotation[x]
integer

The rotation on the x of the asset into a three-dimensional space.

rotation[y]
integer

The rotation on the y of the asset into a three-dimensional space.

rotation[z]
integer

The rotation on the z of the asset into a three-dimensional space.

scale[x]
integer

The scale on the x of the asset into a three-dimensional space.

scale[y]
integer

The scale on the y of the asset into a three-dimensional space.

scale[z]
integer

The scale on the z of the asset into a three-dimensional space.

media
string

The id of a pre-created image media object. Please note: You can either select a 'media' field or upload a new file, not both.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "image",
  • "name": "My 3D asset",
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}

Edit Text Asset

Given a text asset inside a scene, the endpoint allows to edit its properties. Please note that all unspecified properties will be left unchanged.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to edit the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to edit the asset.

asset
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the asset you want to edit.

Request Body schema: application/json
name
string

The name of the asset. It has a labeling purpose.

text
string

The displayed text value.

text_color
string

Hex color code of text.

text_align
string

The value of text-align css property.

font_family
string

The value of font-family css property. Please take note: the font_family is just a string containing the font family name, it's not bound to the provided font_url.

font_variant
string

The value of font-weight css property.

font_url
string

The URL to the .ttf font file.

object (CartesianAxe)
object (CartesianAxe)
object (CartesianAxe)
Array of objects (ActionArray)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "text",
  • "name": "My 3D asset",
  • "text": "string",
  • "text_color": "string",
  • "text_align": "string",
  • "font_family": "Roboto",
  • "font_variant": "100",
  • "font_url": "https://fonts.gstatic.com/s/roboto/v30/KFOkCnqEu92Fr1MmgWxPKTM1K9nz.ttf",
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "actions": []
}

Edit Video Asset

Given a video asset inside a scene, the endpoint allows to edit its properties or to replace the whole source file. Please note that all unspecified properties will be left unchanged.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to edit the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to edit the asset.

asset
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the asset you want to edit.

Request Body schema: multipart/form-data
file
string <binary>

The video file you want to uplaod. Max size available 40MB. Please note: You can either select a 'media' field or upload a new file, not both.

name
string

The name of the asset. It has a labeling purpose.

loop
boolean

Enable or disable the loop on the video file. If true, the video auto-restarts when reaching the end of the track.

object
position[x]
integer

The position on the x of the asset into a three-dimensional space.

position[y]
integer

The position on the y of the asset into a three-dimensional space.

position[z]
integer

The position on the z of the asset into a three-dimensional space.

rotation[x]
integer

The rotation on the x of the asset into a three-dimensional space.

rotation[y]
integer

The rotation on the y of the asset into a three-dimensional space.

rotation[z]
integer

The rotation on the z of the asset into a three-dimensional space.

scale[x]
integer

The scale on the x of the asset into a three-dimensional space.

scale[y]
integer

The scale on the y of the asset into a three-dimensional space.

scale[z]
integer

The scale on the z of the asset into a three-dimensional space.

media
string

The id of a pre-created video media object. Please note: You can either select a 'media' field or upload a new file, not both.

Array of objects (ActionArray)

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "video",
  • "name": "My 3D asset",
  • "look_at_camera": false,
  • "loop": false,
  • "chromakey": {
    },
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}

Campaign / Variables

The variables are used to insert dynamic values and conditions inside of the interactions of the campaign.

Create

This endpoint allows to create an arbitrary number of new variables for a campaign, given their input body.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to add the variable(s).

Request Body schema: application/json
Array
vartype
string
Enum: "boolean" "string" "number"

The type of the variable that you're inserting.

name
string

The name of the variable. It's used as a label and not as an identifier. It still must be unique.

string or boolean or number

The default value of the variable, before any operation is performed on it during the experiences.

query_param
boolean

If this value is set to true, then the experiences using this variable will be capable of getting the value of the variable through the query params inside of the URL.

Responses

Request samples

Content type
application/json
{
  • "vartype": "string",
  • "name": "test_var",
  • "default_value": "Hello world!",
  • "query_param": true
}

Response samples

Content type
application/json
[
  • {
    }
]

List

This endpoint allows to get the data of all the variables inside of the given campaign.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to get the variables.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

This endpoint allows to get the data of the given variable inside of the given campaign.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to get the variable.

variable
required
string
Example: 63a47e22ec3f551fe544f08e

The id of the variable that you want to get.

Responses

Response samples

Content type
application/json
{
  • "vartype": "boolean",
  • "name": "string",
  • "default_value": "string",
  • "query_param": true
}

Delete

This endpoint allows to delete the given variable from the given campaign.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to delete the variable.

variable
required
string
Example: 63a47e22ec3f551fe544f08e

The id of the variable that you want to delete.

query Parameters
hardDelete
string

If set to true, then all the actions related to this variable will be deleted. Otherwise, if set to false (or not set at all), the endpoint will give an error if the variable is used in any action.

Responses

Response samples

Content type
application/json
{
  • "message": "Access forbidden to this feature.",
  • "payload": { }
}

Update

This endpoint allows to update the data of the given variable inside of the given campaign.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to update a variable.

variable
required
string
Example: 63a47e22ec3f551fe544f08e

The id of the variable that you want to update.

query Parameters
hardDelete
string

If set to true, and if the body has a new ‘vartype' for the given variable, then all the actions related to this variable will be deleted. Otherwise, if set to false (or not set at all), the endpoint will give an error if the variable is used in any action.

Request Body schema: application/json
Array
vartype
string
Enum: "boolean" "string" "number"

The type of the variable that you're inserting.

name
string

The name of the variable. It's used as a label and not as an identifier. It still must be unique.

string or boolean or number

The default value of the variable, before any operation is performed on it during the experiences.

query_param
boolean

If this value is set to true, then the experiences using this variable will be capable of getting the value of the variable through the query params inside of the URL.

Responses

Request samples

Content type
application/json
{
  • "vartype": "string",
  • "name": "test_var",
  • "default_value": "Hello world!",
  • "query_param": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Campaign / Variables / Conditions

The conditions are used to trigger certain actions, based on some logical conditions that rely on variables value.

Create

This endpoint allows to create new conditions for an action.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to create the conditions.

scene
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the scene where you want to create the conditions.

asset
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the asset where you want to create the conditions.

action
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the action where you want to create the conditions.

Request Body schema: application/json
Array
variable
string

The id of the variable that is related to this condition.

operator
string
Enum: "equal" "not_equal" "greater_than" "less_than" "greater_than_or_equal" "less_than_or_equal" "contains" "not_contains"

The name of the operator that is applied to the selected variable and the fixed operand.

string or boolean or number

The value of the fixed operand, that is used in the condition check.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List

This endpoint allows to get the conditions of a given action.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to get the conditions.

scene
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the scene where you want to get the conditions.

asset
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the asset where you want to get the conditions.

action
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the action where you want to get the conditions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

This endpoint allows to get the data of a condition of a certain action, of a certain asset.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to get the condition.

scene
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the scene where you want to get the condition.

asset
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the asset where you want to get the condition.

action
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the action where you want to get the condition.

condition
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the condition that you want to get.

Responses

Response samples

Content type
application/json
{
  • "variable": "string",
  • "operator": "equal",
  • "value": "string"
}

Delete

This endpoint allows to delete the given condition from the given action.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to delete the condition.

scene
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the scene where you want to delete the condition.

asset
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the asset where you want to delete the condition.

action
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the action where you want to delete the condition.

condition
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the condition that you want to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Access forbidden to this feature.",
  • "payload": { }
}

Update

This endpoint allows to update the data of the given condition inside of the given action.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to update the condition.

scene
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the scene where you want to update the condition.

asset
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the asset where you want to update the condition.

action
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the action where you want to update the condition.

condition
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the condition that you want to update.

Request Body schema: application/json
Array
variable
string

The id of the variable that is related to this condition.

operator
string
Enum: "equal" "not_equal" "greater_than" "less_than" "greater_than_or_equal" "less_than_or_equal" "contains" "not_contains"

The name of the operator that is applied to the selected variable and the fixed operand.

string or boolean or number

The value of the fixed operand, that is used in the condition check.

Responses

Request samples

Content type
application/json
{
  • "value": "test",
  • "variable": "63a47e22ec3f551fe544f08b",
  • "operator": "equal"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update Match Rule

This endpoint allows to update the match rule of an action, in order to modify how the system interprets the conditions.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign where you want to update the match rule.

scene
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the scene where you want to update the match rule.

asset
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the asset where you want to update the match rule.

action
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the action where you want to update the match rule.

Request Body schema: application/json
match
required
string
Enum: "or" "and"

If set to OR, the action will be triggered if one of the given conditions is true. If set to AND, the condition will be triggered if and only if ALL the conditions are true.

Responses

Request samples

Content type
application/json
{
  • "match": "or"
}

Response samples

Content type
application/json
{
  • "message": "Access forbidden to this feature.",
  • "payload": { }
}

Domain

A third (or higher) level domain can be connected to a campaign.

List Deprecated

This endpoint is specifically designed to return an array of domains that are associated with an account

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show Deprecated

Authorizations:
bearerAuth
path Parameters
domain
required
string

The id of the domain.

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "name": "ar.my-site.com",
  • "active_from": "2023-01-02T14:44:19.882Z",
  • "created_at": "2023-01-02T14:44:19.882Z",
  • "status": "active"
}

Dynamic URL

A dynamic URL is a path reference to a campaign. This path will be maintained and a different campaign can be associate to it.

Create

Authorizations:
bearerAuth
header Parameters
Authorization
string
Example: {{auth}}
Content-Type
string
Example: application/json
Request Body schema: application/json
name
required
string

The dynamic URL name. It has a labeling purpose.

campaign
string

The id of the campaign to associate.

domain
string

The id of the domain to associate.

Responses

Request samples

Content type
application/json
{
  • "name": "my dynamic URL",
  • "campaign": "63a47e22ec3f551fe544f08b",
  • "domain": "631765f1b3820a117e8915c9"
}

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "name": "my dynamic URL",
  • "campaign": "63a47e22ec3f551fe544f08b",
  • "code": "sW3gF90i",
  • "created_at": "2023-01-02T14:44:19.882Z",
  • "updated_at": "2023-01-02T14:44:19.882Z",
  • "domain": "63b311b0ea06c19bf81455ac",
  • "status": "active"
}

Update

Authorizations:
bearerAuth
path Parameters
dynamicurl
required
string
Request Body schema: application/json
name
string

The dynamic URL name. It has a labeling purpose.

campaign
string

The id of the campaign to associate.

domain
string

The id of the domain to associate.

Responses

Request samples

Content type
application/json
{
  • "name": "my dynamic URL",
  • "campaign": "63a47e22ec3f551fe544f08b",
  • "domain": "631765f1b3820a117e8915c9"
}

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "name": "my dynamic URL",
  • "campaign": "63a47e22ec3f551fe544f08b",
  • "code": "sW3gF90i",
  • "created_at": "2023-01-02T14:44:19.882Z",
  • "updated_at": "2023-01-02T14:44:19.882Z",
  • "domain": "63b311b0ea06c19bf81455ac",
  • "status": "active"
}

Show

Authorizations:
bearerAuth
path Parameters
dynamicurl
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "name": "my dynamic URL",
  • "campaign": "63a47e22ec3f551fe544f08b",
  • "code": "sW3gF90i",
  • "created_at": "2023-01-02T14:44:19.882Z",
  • "updated_at": "2023-01-02T14:44:19.882Z",
  • "domain": "63b311b0ea06c19bf81455ac",
  • "status": "active"
}

Delete

Authorizations:
bearerAuth
path Parameters
dynamicurl
required
string

Responses

Brand Kit

A package that includes personalized domain(s) and style kit(s) tailored to customize the campaigns of the account.

List

This endpoint is specifically designed to return an array of brand kits that are associated with an account.

Authorizations:
bearerAuth
query Parameters
search
string

Query parameter for filtering brand kits by name.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

This endpoint is designed to retrieve a specific brand kit based on its unique ID.

Authorizations:
bearerAuth
path Parameters
brand_kit
required
string

The id of the brand kit.

Responses

Response samples

Content type
application/json
{
  • "id": "631765f1b3820a117e8915c9",
  • "name": "My new Brand kit",
  • "domains": {
    },
  • "style_kit": {
    },
  • "demo_style_kit": {
    },
  • "account": "631765f1b3820a117e8915c9",
  • "status": {
    },
  • "from": "2024-01-17T00:00:00.000Z",
  • "until": "2025-01-17T00:00:00.000Z",
  • "deletable": true,
  • "style_kit_campaigns_count": 17
}

Update

The Update endpoint is designed to modify the 'name' field of an existing brand kit entity within the system. By providing the brand kit's unique ID and the new 'name' value in the request, the endpoint will process the change and update the brand kit's name in the database.

Authorizations:
bearerAuth
path Parameters
brand_kit
required
string

The id of the brand kit.

Request Body schema: application/json
name
string

The name of the brand kit.

Responses

Request samples

Content type
application/json
{
  • "name": "My new Brand kit"
}

Response samples

Content type
application/json
{
  • "id": "631765f1b3820a117e8915c9",
  • "name": "My new Brand kit",
  • "domains": {
    },
  • "style_kit": {
    },
  • "demo_style_kit": {
    },
  • "account": "631765f1b3820a117e8915c9",
  • "status": {
    },
  • "from": "2024-01-17T00:00:00.000Z",
  • "until": "2025-01-17T00:00:00.000Z",
  • "deletable": true,
  • "style_kit_campaigns_count": 17
}

Style Kit

A pre-composed kit customizable with brand colors, font and logos, that can then be applied limitless to the account campaigns.

Create

The Create endpoint is specifically designed for the creation of a new style kit. Upon making a POST request to this endpoint, a new style kit is generated with all default values pre-set. This new style kit is immediately ready for further modifications as needed.

Authorizations:
bearerAuth
path Parameters
brand_kit
required
string

The id of the brand kit.

Responses

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

List

The output will be a list of style kits associated with a specific brand kit.

Authorizations:
bearerAuth
path Parameters
brand_kit
required
string

The id of the brand kit.

query Parameters
search
string

Query parameter for filtering style kits by name.

status
string

Query parameter for filtering style kits by type status, it must be 'active' or 'demo'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List All

This endpoint is specifically designed to return an array of style kits that are associated with an account.

Authorizations:
bearerAuth
query Parameters
search
string

Query parameter for filtering style kits by name.

status
string

Query parameter for filtering style kits by type status, it must be 'active' or 'demo'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

This endpoint is designed to retrieve a specific style kit based on its unique ID.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Responses

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Delete

The Delete endpoint is designed for the removal of a style kit from the system. To successfully delete a style kit, it must meet the criteria of having the is_deletable field set to true and the type field set to demo. When these conditions are satisfied, a DELETE request can be made to this endpoint, which will then permanently remove the specified style kit.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Update

The PATCH endpoint is specifically tailored for updating a style kit. It allows users to modify the attributes of a style kit, such as its visual elements or configurations, to ensure that the style kit remains up-to-date with the latest design standards or personal preferences.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Request Body schema: application/json
is_default
boolean

Indicates whether the object is the default one.

name
string

The name of the style kit.

domain
string

The id of the domain you want to associate.

object

Responses

Request samples

Content type
application/json
{
  • "is_default": false,
  • "name": "My default style kit",
  • "domain": "581765f1b2460a117e34115f2",
  • "styles": {
    }
}

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Activate

The Activate endpoint is a POST operation that changes the type of a style kit from 'demo' to 'active'. This transition is contingent upon the availability of slots within the associated brand kit: it's irreversible.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Responses

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Duplicate

The Duplicate endpoint is a POST operation that creates a copy of an existing style kit. Upon duplication, the word 'copy' is appended to the end of the style kit's name to distinguish the new version from the original. The 'type' field of the duplicated style kit is automatically set to 'demo'.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Responses

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Load Favicon

The Load Favicon endpoint is a POST operation that allows the uploading of a file within the field named 'file'. The file must be of type JPG, JPEG or PNG. Upon successful upload, the endpoint processes the file and integrates it into the favicon image of the style kit, ensuring that the resource is properly loaded and stored.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Request Body schema: application/json
file
string <binary>

The file you want to uplaod, max size available 3MB.

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Load Experience Logo

The Load Experience Logo endpoint is a POST operation that allows the uploading of a file within the field named 'file'. The file must be of type JPG, JPEG or PNG. Upon successful upload, the endpoint processes the file and integrates it into the experience logo image of the style kit, ensuring that the resource is properly loaded and stored.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Request Body schema: application/json
file
string <binary>

The file you want to uplaod, max size available 3MB.

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Load Launcher Background

The Load Launcher Background endpoint is a POST operation that allows the uploading of a file within the field named 'file'. The file must be of type JPG, JPEG or PNG. Upon successful upload, the endpoint processes the file and integrates it into the launcher background image of the style kit, ensuring that the resource is properly loaded and stored.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Request Body schema: application/json
file
string <binary>

The file you want to uplaod, max size available 3MB.

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Load Launcher Logo

The Load Launcher Logo endpoint is a POST operation that allows the uploading of a file within the field named 'file'. The file must be of type JPG, JPEG or PNG. Upon successful upload, the endpoint processes the file and integrates it into the launcher logo image of the style kit, ensuring that the resource is properly loaded and stored.

Authorizations:
bearerAuth
path Parameters
style_kit
required
string

The id of the style kit.

Request Body schema: application/json
file
string <binary>

The file you want to uplaod, max size available 3MB.

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "id": "081765a1b3820a117e6515c9",
  • "name": "My new style kit",
  • "account": "631765f1b3820a117e8915c9",
  • "type": "demo",
  • "deletable": false,
  • "is_default": true,
  • "style_kit_campaigns_count": 12,
  • "brand_kit": {
    },
  • "domain": {
    },
  • "styles": {
    }
}

Brand Kit Domain

A third (or higher) level domain can be connected to a campaign.

Create

The Create endpoint is a POST operation designed to create a new domain. It requires two parameters: 'txt_token' and 'name'. The 'txt_token' can be obtained from the corresponding GET operation (brandkit-domains-ticket), and the 'name' represents the subdomain (for example, test.subdomain.com). Upon successful creation, the domain may not be immediately verified and could get into a 'pending' state. In this case, the domain can be verified using a specific Verify endpoint.

Authorizations:
bearerAuth
path Parameters
brand_kit
required
string

The id of the brand kit.

Request Body schema: application/json
name
string

The domain name.

txt_token
string

The txt_token

Responses

Request samples

Content type
application/json
{
  • "name": "domain.example.com",
  • "txt_token": "58176$af2%5f1b2460a!117@e34115f2"
}

Response samples

Content type
application/json
{
  • "id": "581765f1b2460a117e34115f2",
  • "account": "581765f1b2460a117e34115f2",
  • "brand_kit": {
    },
  • "name": "domain.example.com",
  • "status": {
    },
  • "error": "string",
  • "created_at": "2024-01-29T09:27:57.333Z",
  • "active_from": "2024-01-29T09:27:57.333Z",
  • "txt_token": "58176$af2%5f1b2460a!117@e34115f2"
}

List

This endpoint is specifically designed to return an array of domains that are linked to a specific brand kit.

Authorizations:
bearerAuth
path Parameters
brand_kit
required
string

The id of the brand kit.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List All

The complete list of domains associated with the account.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show

This endpoint is designed to retrieve a specific domain based on its unique ID.

Authorizations:
bearerAuth
path Parameters
domain
required
string

The id of the domain.

Responses

Response samples

Content type
application/json
{
  • "id": "581765f1b2460a117e34115f2",
  • "account": "581765f1b2460a117e34115f2",
  • "brand_kit": {
    },
  • "name": "domain.example.com",
  • "status": {
    },
  • "error": "string",
  • "created_at": "2024-01-29T09:27:57.333Z",
  • "active_from": "2024-01-29T09:27:57.333Z",
  • "txt_token": "58176$af2%5f1b2460a!117@e34115f2"
}

Delete

Authorizations:
bearerAuth
path Parameters
domain
required
string

The id of the domain.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Get Ticket

The Get Ticket endpoint is a GET operation designed to retrieve a 'txt_token' necessary to create a new domain. This token is a crucial piece of information required as part of the domain creation process. Once obtained, the 'txt_token' remains unchanged until it is used, ensuring that users can securely proceed with the domain registration at their convenience.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "581765f1b2460a117e34115f2",
  • "account": "581765f1b2460a117e34115f2",
  • "domain": "domain.example.com",
  • "createdAt": "2024-01-29T09:27:57.333Z",
  • "txt_token": "58176$af2%5f1b2460a!117@e34115f2"
}

Verify

The Verify endpoint is a PATCH operation that performs a new verification check on a domain if it was not verified at the time of creation.

Authorizations:
bearerAuth
path Parameters
domain
required
string

The id of the domain.

brand_kit
required
string

The id of the brand kit.

Responses

Response samples

Content type
application/json
{
  • "id": "581765f1b2460a117e34115f2",
  • "account": "581765f1b2460a117e34115f2",
  • "brand_kit": {
    },
  • "name": "domain.example.com",
  • "status": {
    },
  • "error": "string",
  • "created_at": "2024-01-29T09:27:57.333Z",
  • "active_from": "2024-01-29T09:27:57.333Z",
  • "txt_token": "58176$af2%5f1b2460a!117@e34115f2"
}

Campaign / Scene / Asset / Textures

Edit 3D Asset Textures

Given a 3D asset inside a scene and one of its textures, the endpoint allows to substitute it with another texture file.

Authorizations:
bearerAuth
path Parameters
campaign
required
string
Example: 63a47e22ec3f551fe544f08b

The id of the campaign containing the scene where you want to edit the asset.

scene
required
string
Example: 63a47e27ec3f551fe544f0af

The id of the scene where you want to edit the asset.

asset
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the asset you want to edit.

texture
required
string
Example: 63a47e27ec3f551fe544c25e

The id of the texture you want to edit.

Request Body schema: multipart/form-data
files
string <binary>

The Image file you want to upload. Max size available 2MB.

deep_copy
boolean

If set to true, the asset will be duplicated and the new texture will be applied to the copy.

Responses

Response samples

Content type
application/json
{
  • "_id": "63b2f787a9a128f1dd1b6951",
  • "id": "63b2f787a9a128f1dd1b6951",
  • "type": "3d",
  • "gestures": true,
  • "position": {
    },
  • "rotation": {
    },
  • "scale": {
    },
  • "media": {},
  • "actions": []
}