Submit confirmed column mappings for a pending template
PUT/templates/:id
Records the consumer-confirmed column-to-field mappings for an in-progress template by creating a column record for every entry in fields. This is step 2 of the legacy three-step upload flow: it must follow POST /templates and precede PUT /templates/{id}/approve.
When to use: Call this after reviewing the suggestions returned by POST /templates and constructing the final mapping payload. Do not use it on templates created via the single-step or scratch flows - those are already approved; use PATCH /templates/{id}/single-step or PATCH /templates/{id}/scratch to change them.
How: Supply {id} and the required tenant-id header. The body's fields must map every header column of the template's stored template.csv (unmapped columns cause a 400; columns to ignore must be sent with the [skipped] sentinel as mappedKey), and each non-skipped entry's mappedKey must be a known system field unless mappedEntity is provided. jobType selects the system-field catalog used for validation, so it must match the template's own type; GROUP requires the tenant's supportGroupRosters configuration.
Returns: An echo of the confirmed fields in a TemplateUpdateRequest-shaped object whose jobType is always null - this is the endpoint's actual, intentional response shape. Side effect: one roster-template-column record is created per entry; repeat calls append further column records rather than replacing earlier ones, so this endpoint should be called once per template.
Request
Responses
- 200
- 400
- 401
- 403
- 500
The confirmed column mappings, echoed back. jobType is always null on the response.
A column of the stored template.csv is missing from fields, a mappedKey is not a known system field, or the requested GROUP type is not enabled for the tenant. Each entry in errors names the offending column in title and the cause in reason; fix the payload and retry.
Authentication required - supply a valid bearer token.
The authenticated user lacks the UPDATE_TEMPLATE permission.
Unexpected server-side failure (for example a GCS or data-layer outage). Retrying after a partial failure may duplicate column records; verify with GET /templates/{id}/columns before retrying.