POST /api/v4/presets
Create preset. Last update: 04/10/23

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "preset": {
    "template_id": 100,
    "name": "preset",
    "s3_key": "s3_key",
    "preview_s3_key": "preview_s3_key",
    "additional_media": false,
    "preset_type": "graphic",
    "published": false
  }
}

Success response body ↑

{
  "id": 3731,
  "name": "preset",
  "s3_key": "s3_key",
  "preview_image_url": "https://gipper-college-logos-development.s3.amazonaws.com/preview_s3_key.jpeg",
  "favorites_count": null,
  "preset_type": "graphic" (NOTE: updated 11/10/23),
  "published": false,
  "additional_media": false,
  "template": {
    "id": 2778,
    "name": "MatchDay",
    "class_name": "template_two_thousand_five_hundred_two",
    "preview_image_url": "https://gipper-static-assets.s3.amazonaws.com/preview_for_templates/template_2502_preview.jpg",
    "social_media": "portrait",
    "has_video": true,
    "has_motion": false,
    "active_for": "all_platforms",
    "parent_template": "template_two_thousand_four_hundred_ninety_nine",
    "preview_aspect_ratio": "4:5",
    "favorites_count": null,
    "canvas_to_backend": false (NOTE: add 24/08/23),
    "plans": [
        "Free",
        "Basic",
        ...
    ],
    "relative_templates": {
        "instagram": 2775,
        ...
    }
  }
}

Params

Param name Description
preset
required

Validations:

  • Must be a Hash
preset[template_id]
required

ID of template

Validations:

  • Must be a Integer
preset[name]
required

Name of preset_folder

Validations:

  • Must be a String
preset[s3_key]
required

S3 bucket token

Validations:

  • Must be a String
preset[preview_s3_key]
required

S3 bucket token for preview

Validations:

  • Must be a String
preset[preset_folder_id]
optional

ID of folder

Validations:

  • Must be a Integer
preset[team_ids]
optional

Array of team_ids

Validations:

  • Must be an array of Integer
preset[additional_media]
optional

Validations:

  • Must be one of: true, false, 1, 0.
preset[preset_type]
optional

Required only for Newsletter presets

Validations:

  • Must be one of: graphic, newsletter.
preset[published]
optional

Validations:

  • Must be one of: true, false, 1, 0.