About API Reference
Linked Account
Integration Schema
Config
Config Fields
Webhooks
Public Workflows
Schedule
Session Token
Cobalt Hosted
curl --request POST \
--url https://api.gocobalt.io/api/v2/public/config \
--header 'Content-Type: application/json' \
--header 'linked_account_id: <linked_account_id>' \
--header 'x-api-key: <api-key>' \
--data '{
"slug": "<string>",
"config_id": "<string>",
"labels": {}
}'{
"slug": "mailerlite",
"config_id": "config_4",
"fields": [
{
"required": false,
"id": "646473c7e7b74deee820458f",
"name": "MailerLite Field Mapping",
"field_type": "map",
"options": [
{
"name": "City",
"value": "city"
},
{
"name": "Company",
"value": "company"
},
{
"name": "Country",
"value": "country"
},
{
"name": "Last name",
"value": "last_name"
},
{
"name": "Name",
"value": "name"
},
{
"name": "Phone",
"value": "phone"
}
],
"labels": [
{
"name": "Customer Name",
"value": "name"
},
{
"name": "Customer Last Name",
"value": "last_name"
},
{
"name": "Customer's Company",
"value": "company"
}
]
}
],
"workflows": [
{
"id": "649d230c2ce6b9b07b163e61",
"name": "Add a Subscriber to Mailerlite",
"description": "",
"enabled": false,
"fields": []
}
]
}
Upsert Config
curl --request POST \
--url https://api.gocobalt.io/api/v2/public/config \
--header 'Content-Type: application/json' \
--header 'linked_account_id: <linked_account_id>' \
--header 'x-api-key: <api-key>' \
--data '{
"slug": "<string>",
"config_id": "<string>",
"labels": {}
}'{
"slug": "mailerlite",
"config_id": "config_4",
"fields": [
{
"required": false,
"id": "646473c7e7b74deee820458f",
"name": "MailerLite Field Mapping",
"field_type": "map",
"options": [
{
"name": "City",
"value": "city"
},
{
"name": "Company",
"value": "company"
},
{
"name": "Country",
"value": "country"
},
{
"name": "Last name",
"value": "last_name"
},
{
"name": "Name",
"value": "name"
},
{
"name": "Phone",
"value": "phone"
}
],
"labels": [
{
"name": "Customer Name",
"value": "name"
},
{
"name": "Customer Last Name",
"value": "last_name"
},
{
"name": "Customer's Company",
"value": "company"
}
]
}
],
"workflows": [
{
"id": "649d230c2ce6b9b07b163e61",
"name": "Add a Subscriber to Mailerlite",
"description": "",
"enabled": false,
"fields": []
}
]
}
This API checks for an existing config based on a specified config_id (if not provided, the config_id defaults to the linked_account_id.) If the config exists, it returns the existing setup or else creates a new config.
Request description
Headers
Unique customer identification id. For Eg: markwood@some_email.com
Body Parameters
Application slug. Eg: mailerlite
A unique id for the config. If not provided, linked_account_id is considered as the config_id by default.
Response description
Application slug
Unique ID of the created config
Global input fields of an application
Show properties
Show properties
Unique field id
Field display name
Field input type. Expected values: text, number, select, map
If the field is a required field.
Published workflows of the application
Show properties
Show properties
Workflow ID
Workflow name
Workflow description
If the workflow is enabled for the linked account
Workflow specific input fields
Show properties
Show properties
Unique field id
Field display name
Field input type. Expected values: text, number, select, map
If the field is a required field.
Application slug
Unique ID of the created config
Global input fields of an application
Show properties
Show properties
Unique field id
Field display name
Field input type. Expected values: text, number, select, map
If the field is a required field.
Published workflows of the application
Show properties
Show properties
Workflow ID
Workflow name
Workflow description
If the workflow is enabled for the linked account
Workflow specific input fields
Show properties
Show properties
Unique field id
Field display name
Field input type. Expected values: text, number, select, map
If the field is a required field.
{
"slug": "mailerlite",
"config_id": "config_4",
"fields": [
{
"required": false,
"id": "646473c7e7b74deee820458f",
"name": "MailerLite Field Mapping",
"field_type": "map",
"options": [
{
"name": "City",
"value": "city"
},
{
"name": "Company",
"value": "company"
},
{
"name": "Country",
"value": "country"
},
{
"name": "Last name",
"value": "last_name"
},
{
"name": "Name",
"value": "name"
},
{
"name": "Phone",
"value": "phone"
}
],
"labels": [
{
"name": "Customer Name",
"value": "name"
},
{
"name": "Customer Last Name",
"value": "last_name"
},
{
"name": "Customer's Company",
"value": "company"
}
]
}
],
"workflows": [
{
"id": "649d230c2ce6b9b07b163e61",
"name": "Add a Subscriber to Mailerlite",
"description": "",
"enabled": false,
"fields": []
}
]
}