Design Builder API v2

Base URL: https://design-builder-api.epilot.io
API Docs: https://docs.epilot.io/api/design

Quick Start

# List available operations
epilot design

# Call an operation
epilot design getAllDesigns

Common Flags

Flag	Description
`-p key=value`	Set a named parameter
`-d '{...}'`	Request body JSON
`-H 'Key: Value'`	Custom header
`-t, --token <token>`	Bearer token for authentication
`--profile <name>`	Use a named profile
`-s, --server <url>`	Override server base URL
`-i, --include`	Include response headers in output
`--json`	Output raw JSON (no formatting)
`-v, --verbose`	Verbose output (show request details)
`--jsonata <expr>`	JSONata expression to transform response
`--definition <file>`	Override OpenAPI spec file/URL
`--guided`	Prompt for all parameters interactively
`--no-interactive`	Disable interactive prompts

Operations

design-builder

getAllDesigns — Scan all designs linked to a organization, based in orgId attribute from JWT auth token
addDesign — Create a brand new design linked to a organization, based in orgId attribute from JWT auth token
getDesign — Search for a especific design owned by user organization
updateDesign — Update a especific design owned by user organization
deleteDesign — Search and delete for a especific design owned by user organization
getThemeFromDesign — Search for a especific design owned by user organization and parse them to a new or old theme
getFiles — List all files for the user organization bucket
uploadFile — Upload a new file for the user organization bucket
getConsumerDesign — Search for a especific design owned by user organization
addConsumer — Add a consumer that uses a specific design
removeConsumer — Remove a consumer that uses a specific design

`getAllDesigns`

Scan all designs linked to a organization, based in orgId attribute from JWT auth token

GET /v1/designs

Sample Call

epilot design getAllDesigns

With JSONata filter:

epilot design getAllDesigns --jsonata '$'

Sample Response

[
  {
    "designs": [
      {}
    ]
  }
]

`addDesign`

Create a brand new design linked to a organization, based in orgId attribute from JWT auth token

POST /v1/designs

Request Body (required)

Sample Call

epilot design addDesign

With request body:

epilot design addDesign \
  -d '{
  "design": {
    "brand_id": "string",
    "brand_name": "string",
    "user": {
      "emailaddress": "string",
      "fullname": "string",
      "name": "string",
      "userid": "string"
    },
    "style_name": "string",
    "style": {
      "logo": {
        "main": {
          "name": "string",
          "display_name": "string",
          "file_type": "LOGO",
          "s3_object_key": "string",
          "url": "string"
        }
      },
      "palette": {
        "primary": "string",
        "secondary": "string",
        "error": "string",
        "background": "string",
        "paper": "string",
        "navbar": "string",
        "portal_login_background": "string"
      },
      "typography": {
        "font": {
          "font_id": "string",
          "font_name": "string",
          "font_family": "string",
          "font_weight_regular": "string",
          "font_weight_medium": "string",
          "font_weight_bold": "string",
          "urls": [
            {
              "type": "WOFF2",
              "url": "string"
            }
          ]
        },
        "primary": "string",
        "secondary": "string"
      },
      "shape": {
        "border_radius": 0
      },
      "consumer": {
        "widgets": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "customer_portals": [
          {
            "id": "string",
            "name": "string"
          }
        ]
      }
    },
    "is_default": true,
    "custom_theme": "string",
    "use_custom_theme": true,
    "design_tokens": {
      "coupon": "string",
      "cashback": "string",
      "custom_css": "string"
    }
  }
}'

Using stdin pipe:

cat body.json | epilot design addDesign

With JSONata filter:

epilot design addDesign --jsonata 'design'

Sample Response

{
  "design": {
    "id": "string",
    "created_at": "2021-01-30T08:30:00Z",
    "created_by": "string",
    "edited": true,
    "last_modified_at": "string",
    "brand_id": "string",
    "brand_name": "string",
    "user": {
      "emailaddress": "string",
      "fullname": "string",
      "name": "string",
      "userid": "string"
    },
    "style_name": "string",
    "style": {
      "logo": {},
      "palette": {},
      "typography": {},
      "shape": {},
      "consumer": {}
    },
    "is_default": true,
    "custom_theme": "string",
    "use_custom_theme": true,
    "design_tokens": {
      "coupon": "string",
      "cashback": "string",
      "custom_css": "string"
    }
  }
}

`getDesign`

Search for a especific design owned by user organization

GET /v1/designs/{designId}

Parameters

Name	In	Type	Required	Description
`designId`	path	string	Yes	Id of the design

Sample Call

epilot design getDesign \
  -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a

Using positional args for path parameters:

epilot design getDesign 4a062990-a6a3-11eb-9828-4f3da7d4935a

With JSONata filter:

epilot design getDesign -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a --jsonata 'design'

Sample Response

{
  "design": {
    "id": "string",
    "created_at": "2021-01-30T08:30:00Z",
    "created_by": "string",
    "edited": true,
    "last_modified_at": "string",
    "brand_id": "string",
    "brand_name": "string",
    "user": {
      "emailaddress": "string",
      "fullname": "string",
      "name": "string",
      "userid": "string"
    },
    "style_name": "string",
    "style": {
      "logo": {},
      "palette": {},
      "typography": {},
      "shape": {},
      "consumer": {}
    },
    "is_default": true,
    "custom_theme": "string",
    "use_custom_theme": true,
    "design_tokens": {
      "coupon": "string",
      "cashback": "string",
      "custom_css": "string"
    }
  }
}

`updateDesign`

Update a especific design owned by user organization

PUT /v1/designs/{designId}

Parameters

Name	In	Type	Required	Description
`designId`	path	string	Yes	Id of the design

Request Body (required)

Sample Call

epilot design updateDesign \
  -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a

With request body:

epilot design updateDesign \
  -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a \
  -d '{
  "design": {
    "brand_id": "string",
    "brand_name": "string",
    "user": {
      "emailaddress": "string",
      "fullname": "string",
      "name": "string",
      "userid": "string"
    },
    "style_name": "string",
    "style": {
      "logo": {
        "main": {
          "name": "string",
          "display_name": "string",
          "file_type": "LOGO",
          "s3_object_key": "string",
          "url": "string"
        }
      },
      "palette": {
        "primary": "string",
        "secondary": "string",
        "error": "string",
        "background": "string",
        "paper": "string",
        "navbar": "string",
        "portal_login_background": "string"
      },
      "typography": {
        "font": {
          "font_id": "string",
          "font_name": "string",
          "font_family": "string",
          "font_weight_regular": "string",
          "font_weight_medium": "string",
          "font_weight_bold": "string",
          "urls": [
            {
              "type": "WOFF2",
              "url": "string"
            }
          ]
        },
        "primary": "string",
        "secondary": "string"
      },
      "shape": {
        "border_radius": 0
      },
      "consumer": {
        "widgets": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "customer_portals": [
          {
            "id": "string",
            "name": "string"
          }
        ]
      }
    },
    "is_default": true,
    "custom_theme": "string",
    "use_custom_theme": true,
    "design_tokens": {
      "coupon": "string",
      "cashback": "string",
      "custom_css": "string"
    }
  }
}'

Using positional args for path parameters:

epilot design updateDesign 4a062990-a6a3-11eb-9828-4f3da7d4935a

Using stdin pipe:

cat body.json | epilot design updateDesign -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a

With JSONata filter:

epilot design updateDesign -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a --jsonata '$'

`deleteDesign`

Search and delete for a especific design owned by user organization

DELETE /v1/designs/{designId}

Parameters

Name	In	Type	Required	Description
`designId`	path	string	Yes	Id of the design

Sample Call

epilot design deleteDesign \
  -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a

Using positional args for path parameters:

epilot design deleteDesign 4a062990-a6a3-11eb-9828-4f3da7d4935a

With JSONata filter:

epilot design deleteDesign -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a --jsonata '$'

`getThemeFromDesign`

Search for a especific design owned by user organization and parse them to a new or old theme

GET /v1/designs/{designId}/parse

Parameters

Name	In	Type	Required	Description
`designId`	path	string	Yes	Id of the design
`orgId`	query	string	No	Organization id of the user
`theme`	query	"NEW" \| "OLD"	Yes	Type of theme to be parsed and returned

Sample Call

epilot design getThemeFromDesign \
  -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a \
  -p theme=NEW

Using positional args for path parameters:

epilot design getThemeFromDesign 4a062990-a6a3-11eb-9828-4f3da7d4935a

With JSONata filter:

epilot design getThemeFromDesign -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a -p theme=NEW --jsonata '$'

Sample Response

{}

`getFiles`

List all files for the user organization bucket

GET /v1/designs/files

Parameters

Name	In	Type	Required	Description
`type`	query	"LOGO" \| "FONT"	No	Type of files to be returned

Sample Call

epilot design getFiles

With JSONata filter:

epilot design getFiles --jsonata '$'

Sample Response

[
  {
    "name": "string",
    "display_name": "string",
    "file_type": "LOGO",
    "s3_object_key": "string",
    "url": "string"
  }
]

`uploadFile`

Upload a new file for the user organization bucket

POST /v1/designs/files

Sample Call

epilot design uploadFile

With JSONata filter:

epilot design uploadFile --jsonata '$'

Sample Response

{
  "name": "string",
  "display_name": "string",
  "file_type": "LOGO",
  "s3_object_key": "string",
  "url": "string"
}

`getConsumerDesign`

Search for a especific design owned by user organization

GET /v1/designs/consumer/{application}/{consumerId}

Parameters

Name	In	Type	Required	Description
`consumerId`	path	string	Yes	Id of the design
`application`	path	string	Yes	Type of application that uses the design

Sample Call

epilot design getConsumerDesign \
  -p consumerId=4a062990-a6a3-11eb-9828-4f3da7d4935a \
  -p application=journey

Using positional args for path parameters:

epilot design getConsumerDesign 4a062990-a6a3-11eb-9828-4f3da7d4935a journey

With JSONata filter:

epilot design getConsumerDesign -p consumerId=4a062990-a6a3-11eb-9828-4f3da7d4935a -p application=journey --jsonata 'design'

Sample Response

{
  "design": {
    "id": "string",
    "created_at": "2021-01-30T08:30:00Z",
    "created_by": "string",
    "edited": true,
    "last_modified_at": "string",
    "brand_id": "string",
    "brand_name": "string",
    "user": {
      "emailaddress": "string",
      "fullname": "string",
      "name": "string",
      "userid": "string"
    },
    "style_name": "string",
    "style": {
      "logo": {},
      "palette": {},
      "typography": {},
      "shape": {},
      "consumer": {}
    },
    "is_default": true,
    "custom_theme": "string",
    "use_custom_theme": true,
    "design_tokens": {
      "coupon": "string",
      "cashback": "string",
      "custom_css": "string"
    }
  }
}

`addConsumer`

Add a consumer that uses a specific design

PUT /v1/designs/addConsumer/{application}/{designId}

Parameters

Name	In	Type	Required	Description
`designId`	path	string	Yes	Id of the design
`application`	path	string	Yes	Type of application that uses the design

Request Body (required)

Sample Call

epilot design addConsumer \
  -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a \
  -p application=journey \
  -d '{"consumer_id":"string","consumer_name":"string","should_delete":"string"}'

Using positional args for path parameters:

epilot design addConsumer 4a062990-a6a3-11eb-9828-4f3da7d4935a journey

Using stdin pipe:

cat body.json | epilot design addConsumer -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a -p application=journey

With JSONata filter:

epilot design addConsumer -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a -p application=journey --jsonata '$'

`removeConsumer`

Remove a consumer that uses a specific design

PUT /v1/designs/removeConsumer/{application}/{designId}

Parameters

Name	In	Type	Required	Description
`designId`	path	string	Yes	Id of the design
`application`	path	string	Yes	Type of application that uses the design

Request Body (required)

Sample Call

epilot design removeConsumer \
  -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a \
  -p application=journey \
  -d '{"consumer_id":"string","consumer_name":"string","should_delete":"string"}'

Using positional args for path parameters:

epilot design removeConsumer 4a062990-a6a3-11eb-9828-4f3da7d4935a journey

Using stdin pipe:

cat body.json | epilot design removeConsumer -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a -p application=journey

With JSONata filter:

epilot design removeConsumer -p designId=4a062990-a6a3-11eb-9828-4f3da7d4935a -p application=journey --jsonata '$'

Design Builder API v2

Quick Start​

Common Flags​

Operations​

getAllDesigns​

addDesign​

getDesign​

updateDesign​

deleteDesign​

getThemeFromDesign​

getFiles​

uploadFile​

getConsumerDesign​

addConsumer​

removeConsumer​

Quick Start

Common Flags

Operations

`getAllDesigns`

`addDesign`

`getDesign`

`updateDesign`

`deleteDesign`

`getThemeFromDesign`

`getFiles`

`uploadFile`

`getConsumerDesign`

`addConsumer`

`removeConsumer`