Skip to main content

Update Project

PATCH/v2/project/{project_key}

Update mutable fields on a project. Only the whitelisted fields below are accepted — anything else in the body is silently ignored, so the API surface stays predictable.

Body (any subset)

FieldTypeDescription
website_namestringDisplay name
namestringAlias for website_name
widget_namestringInternal alias (usually mirrors website_name)
allowed_websitestringDomain(s) the script may run on (* = any)
widget_allowed_websitestringAlias for allowed_website
monthly_average_trafficintegerHint used for plan suggestions

At least one updatable field must be supplied — empty body returns 400.

Example

curl -X PATCH "https://api-{region}.mida.so/v2/project/YOUR_PROJECT_KEY" \
-H "Authorization: Bearer YOUR_GENERATED_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"website_name": "store.example.com (EU)",
"monthly_average_traffic": 120000
}'

Success response

{
"success": true,
"project": {
"project_key": "PROJECT_KEY_AAAAAAAAAA",
"name": "store.example.com (EU)",
"website_name": "store.example.com (EU)",
"monthly_average_traffic": 120000,
"...": "..."
}
}

The full project object is returned with the new values applied.

Error responses

StatusMeaning
400No updatable fields supplied
401Invalid or missing API key
403Project is inactive
404Project not found