OKF template

API Endpoint OKF Template

Use this template to document one API endpoint with auth, inputs, outputs, examples, and failure cases.

Copyable Markdown

Use this as a starting point, then run it through the validator before indexing.

---
type: api-endpoint
title: Create Customer
description: Creates a customer record and returns the created customer ID.
resource: https://api.example.com/docs/customers#create
tags:
  - api
  - customers
timestamp: 2026-06-27
---

# Create Customer

## Purpose
Use this endpoint when an agent needs to create a new customer after collecting required profile fields.

## Request
- Method: POST
- Path: /v1/customers
- Required fields: name, email

## Response
Returns the created customer ID, status, and timestamps.

## Failure Cases
- 400 when required fields are missing.
- 409 when the email already exists.