Presets

>>>

GET /api/v4/presets
List of preset. Last update: 27/02/24

Request headers ↑

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

Success response body ↑

{
  "presets": [
    {
      "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": 0,
      "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,
          ...
        },
        is_blocked: false (NOTE: add 18/03/24)
      }
    },
    ...
  ],
  "meta": {
    "total_count": 1,
    graphics_total_count: 1,
    newsletter_total_count: 0
  }
}

Params

Param name Description
saved
required

saved or shared

Validations:

  • Must be one of: true, false.
folder_id
optional

ID of folder

Validations:

  • Must be a Integer
q
optional

Search by name

Validations:

  • Must be a String
search_in_folders
optional , nil allowed

Send true if need to search in folders

Validations:

  • Must be one of: true, false.
preset_type
optional

filtering by preset type. Last update: 11/10/23

Validations:

  • Must be one of: graphic, newsletter.
sort_by
optional

Sort by created_at

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
page
optional

Validations:

  • Must be a String
>>>

GET /api/v4/presets/:id
Get 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"

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,
  "shared": false,
  "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
id
required

ID of preset

Validations:

  • Must be a Integer
team_id
optional

Team ID if preset shared for team

Validations:

  • Must be a Integer
>>>

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.
>>>

PUT /api/v4/presets/:id
Update 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_image_url",
    "additional_media": false,
    "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
id
required

ID of updated preset

Validations:

  • Must be a Integer
preset
required

Validations:

  • Must be a Hash
preset[name]
optional

Name of preset

Validations:

  • Must be a String
preset[s3_key]
optional

S3 bucket token

Validations:

  • Must be a String
preset[preview_s3_key]
optional

S3 bucket token for preview

Validations:

  • Must be a String
preset[preset_folder_id]
optional

ID of preset_folder

Validations:

  • Must be a String
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[published]
optional

Validations:

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

DELETE /api/v4/presets/:id
Delete preset

Request headers ↑

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

Success response body ↑

{
  success: true
}

Params

Param name Description
id
required

ID of updated preset

Validations:

  • Must be a Integer
>>>

PUT /api/v4/presets/move
Move presets to other folder

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_folder_id": 1,
  "ids": [2, 3, ...]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
preset_folder_id
optional

Preset folder to wich we want to move presets (Can be nil if user move to root folder)

Validations:

  • Must be a Integer
ids
optional

IDs of presets wich we want to move

Validations:

  • Must be an array of Integer
>>>

GET /api/v4/presets/check_for_scheduled_posts
Check presets for having scheduled posts

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 ↑

/api/v4/presets/check_for_scheduled_posts?ids[]=12&ids[]=13&preset_folder_ids[]=2&preset_folder_ids[]=3

Success response body ↑

{
  "with_scheduled_posts": 3
}

Params

Param name Description
preset_folder_ids
optional

IDs of preset folders wich we want to check

Validations:

  • Must be an array of Integer
ids
optional

IDs of presets wich we want to check

Validations:

  • Must be an array of Integer
>>>

GET /api/v4/presets/:id/public_show
Get published newsletter preset. Last update: 05/03/24

Request headers ↑

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

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,
  "shared": false,
  "preset_type": "graphic" (NOTE: updated 11/10/23),
  "published": false,
  "additional_media": false,
  "workspace_current_plan": ["Premier"] (NOTE: added 05/03/24),
  "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
id
required

ID of preset

Validations:

  • Must be a Integer