curl --request POST \
--url https://api.getmaxim.ai/v1/workflows \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"type": "HTTP",
"folderId": "<string>",
"description": "<string>",
"environmentId": "<string>",
"config": {
"language": "<string>"
}
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"accountId": "<string>",
"name": "<string>",
"type": "HTTP",
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"folderId": "<string>",
"config": null
}
}Create a new workflow. Only minimal metadata is set at creation time — name, type, optional folderId, description, environmentId, and config.language. To set HTTP fields (method, url, headers, scripts, authentication) or VOICE fields (phoneNumber, dialCode, countryCode), follow up with PUT /v1/workflows.
curl --request POST \
--url https://api.getmaxim.ai/v1/workflows \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"type": "HTTP",
"folderId": "<string>",
"description": "<string>",
"environmentId": "<string>",
"config": {
"language": "<string>"
}
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"accountId": "<string>",
"name": "<string>",
"type": "HTTP",
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"folderId": "<string>",
"config": null
}
}API key for authentication
Unique identifier for the workspace
1Name of the workflow
1Type of workflow (HTTP or VOICE)
HTTP, VOICE Unique identifier for the folder
Description of the workflow
Default environment identifier for the workflow
Optional workflow configuration overrides
Show child attributes
Workflow created successfully
Show child attributes
Was this page helpful?