---
title: "Create consumer"
method: POST
path: "/api/v1/projects/{projectId}/consumers"
tags: ["Consumers"]
---

# Create consumer

`POST /api/v1/projects/{projectId}/consumers`

## Request

- Base URL: `http://localhost:8080`
- URL: `http://localhost:8080/api/v1/projects/{projectId}/consumers`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Registers one of your users, identified by your own id

## Path parameters

- `projectId` string, uuid, required

## Request body

- ConsumerRequest
  - `externalId` string, required: Your own identifier for this user, unique within the project — typically the user or tenant id in your database.
  - `name` string: Shown at the top of the portal. Absent: the externalId on create, unchanged on update.

## Response `201`

Consumer created

## Other responses

- `409`: A consumer with this externalId already exists

---

[API](https://skmtc.dev/railhook/apis/railhook-api.md) · [All operations](https://skmtc.dev/railhook/apis/railhook-api/llms.txt) · [OpenAPI document](https://skmtc.dev/railhook/apis/railhook-api/revisions/4e2c76dfc33d?raw)