Customers

Create a customer

Changed on

Select it on any request with the RecruitMCP-Customer header, or create a key bound to it.

Scope: account:manage. Acts on the account; keys bound to a customer are refused.

post/v1/customers

Request

  • Base URL: https://api.recruitmcp.com
  • URL: https://api.recruitmcp.com/v1/customers
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://recruitmcp.com/oauth/authorize, token URL https://recruitmcp.com/oauth/token, scopes: account:manage)

Headers

Idempotency-Keystring

Optional on this route. At most 128 characters. When present, the same key and body replays the first response for 24 hours. A different body is 409 idempotency_key_reused. A second call waits for the first and replays it. Omit the header to run the request normally.

RecruitMCP-Version'2026-10-13'

API version. Defaults to the version the key was created with. Supported: 2026-10-13.

Request body

namestring

Required on create.

external_idstring nullable

Your id for this tenant.

metadataobject
daily_cap_creditsinteger nullable

Credits this customer may spend per UTC day. Null for no cap.

status'active' | 'disabled'

Update only.

Example request

{
  "name": "Northwind Recruiting",
  "external_id": "tenant_42",
  "daily_cap_credits": 100
}

Response

Created.

idstring required
object'customer' required
namestring required
external_idstring nullable

Your id for this tenant.

metadataobject
daily_cap_creditsinteger nullable

Credits this customer may spend per UTC day.

status'active' | 'disabled' required
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "cus_8d1f0a2b3c4d5e6f7a",
  "object": "customer",
  "name": "Northwind Recruiting",
  "external_id": "tenant_42",
  "metadata": {
    "plan": "pro"
  },
  "daily_cap_credits": 100,
  "status": "active",
  "created_at": "2026-10-13T09:00:00Z",
  "updated_at": "2026-10-13T09:00:00Z"
}

Changes

  • ad27b35513a6Revision changes
    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status