Create general card

Create a general card.

These endpoints are in beta testing. Some features may not work as documented or may behave unexpectedly.

Create general card

POST https://{{account_id}}.acquire.io/api/v1/crm/ui-component

Create a general Custom Card.

Headers

Name	Type	Description
Authorization	string	Bearer {{api_key}}

Request Body

Name	Type	Description
type	string	"tab"
config	object	Config object. The configuration of your card.
displayScope	string
area	string

200

{
    "data": {
        "success": true,
        "data": {
            "type": "tab",
            "config": {
                "label": "mix sample",
                "canvas": {
                    "content_url": true
                },
                "action_key": "test-json",
                "action_type": "initialize_tab",
                "iconImageUrl": "./assets/app-store/acquire_saml.svg",
                "initialize_url": "https://0ff32dabc277.ngrok.io/mix2-initialize"
            },
            "displayScope": "contact_action",
            "area": "backend",
            "userId": 98,
            "dateCreated": "2021-04-06T10:41:08.898Z",
            "order": 0,
            "id": 573
        },
        "message": "UI component created successfully."
    }
}

Body (raw)

{
    "type": "tab",
    "config": {
        "label": "mix sample",
        "canvas": {
            "content_url": true
        },
        "action_key": "test-json",
        "action_type": "initialize_tab",
        "iconImageUrl": "./assets/app-store/acquire_saml.svg",
        "initialize_url": "https://0ff32dabc277.ngrok.io/mix2-initialize"
    },
    "displayScope": "contact_action",
    "area": "backend"
}

Attributes

ATTRIBUTE	TYPE	DESCRIPTION
type	String	Specify the type of card. block | action | tab | script_tags | style
config	JSON object	Specify the card configuration. Value for config is a JSON object according to type.
displayScope	String	Specify the card display scope. home(For frontend widget home app list) | contact_action | case_action | message_action | picker | main (for other)
area	String