Uploading master template files

Uploading master template files via the CreateTOTALLY API can be done using the following flow:

1. Create a master template
2. Upload master template files

For the smoothest integration, we recommend using the below queries and mutations in conjunction with webhooks.

See webhooks for full details of how to subscribe to webhook events.

Create a master template

You can create a master template by using the createMasterTemplate mutation.

Example

mutation CreateMasterTemplate($data: MasterTemplateData!) {
  createMasterTemplate(data: $data) {
    id
  }
}

Variables

{
  "data": {
    "name": "Master Template Name",
    "creativeId": "id-here",
    "contentTypeId": "id-here",
    "mediaTypeId": "id-here"
  }
}

Upload master template files

You can upload the master template files by using the uploadMasterTemplateFiles mutation. The masterTemplateId field should be the id returned from the createMasterTemplate mutation.

The zipUrl should be a publicly accessible url to a zip archive. For security reasons we recommend using signed urls.

The provided archive should align with the below folder structure:

create-totally/
  automation-assets/
    asset.aepx
  preview/
    video.mp4
  thumbnail/
    image.png

The filenames can change, however the folder names should not.

Example

mutation UploadMasterTemplateFiles($data: UploadMasterTemplateFilesData!) {
  uploadMasterTemplateFiles(data: $data) {
    id
  }
}

Variables

{
  "data": {
    "masterTemplateId": "NhVh1xN3cEA7ml4GjpPFT",
    "zipUrl": "signed-url",
    "triggerAnalysis": true
  }
}

info

Without the triggerAnalysis: true flag, analysisJobs have to be triggered manually using createAnalysisJob.