curl --request POST \
--url https://api.comstruct.com/v1/project-regions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
[
{
"title": "North Region",
"number": "REG-NORTH"
}
]
'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "North Region",
"number": "REG-NORTH",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]Master data
Create or update project region
Erforderliche Berechtigungen: project_regions:write
Erstellt oder aktualisiert eine oder mehrere Projektregionen für den aktuellen Mandanten.
Verwendet das number-Feld zum Abgleich bestehender Projektregionen für Aktualisierungen.
POST
/
project-regions
curl --request POST \
--url https://api.comstruct.com/v1/project-regions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
[
{
"title": "North Region",
"number": "REG-NORTH"
}
]
'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "North Region",
"number": "REG-NORTH",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]Overview
This endpoint creates new project regions or updates existing ones. Project regions help organize projects by geographical or organizational boundaries.Region Description Field
Thedescription field is an optional free-text field that provides additional context about the project region. It’s useful for:
- Documenting the geographical coverage (e.g., ‘Northern operations covering warehouses A and B’)
- Adding organizational notes (e.g., ‘Regional office Hamburg, managed by Team North’)
- Recording special handling instructions for the region
The
description field is optional and can be added during creation or updated later using the PATCH endpoint.Example: Creating a Region with Description
{
"title": "North",
"number": "REG-001",
"description": "Northern operations covering warehouses A and B"
}
Example: Creating a Region without Description
{
"title": "South",
"number": "REG-002"
}
Authorizations
API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.
Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.
Body
application/json