Account

Create a workspace

Changed on

Same as POST /v1/workspaces. attribution is optional. When it is omitted, the rmcp_attr cookie from the first visit is stored instead.

No authentication.

post/v1/signup

Request

  • Base URL: https://api.recruitmcp.com
  • URL: https://api.recruitmcp.com/v1/signup
  • Auth: none required

Request body

namestring required
emailstring required

Owner email. Required: the confirmation link goes there, and the free credits are added once it is opened. A missing or malformed address is 400 invalid_request with details.field email.

first_namestring nullable

Owner first name. Optional. Not taken from the workspace name.

marketing_opt_inboolean

Optional. Leave false, or omit it, until the person ticks the product-updates checkbox.

Response

Created.

idstring required
namestring
api_keystring required

Shown once. Store it.

balance_creditsinteger
scopesstring[]
email_verification'not_required' | 'sent'
signup_credits_pendinginteger
signup_credits_pending_reason'email_already_claimed' | 'normalized_email_used' nullable

Why the free grant is 0. Null when it is still pending or already on the balance. email_already_claimed is the same address. normalized_email_used is a plus-tag or dotted Gmail form of an address that already received it.

Example response

{
  "id": "ws_01J0WORKSPACE0EXAMPLE",
  "name": "Northwind Search",
  "api_key": "rmcp_live_examplekeyexamplekeyexample",
  "balance_credits": 0,
  "scopes": [
    "sourcing:read",
    "sourcing:spend",
    "lists:write",
    "contacts:spend",
    "outreach:read",
    "outreach:write",
    "outreach:send",
    "outreach:approve",
    "privacy:write",
    "account:read",
    "account:manage",
    "billing:manage"
  ],
  "email_verification": "sent",
  "signup_credits_pending": 1250
}

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