Error

A valid request URL is required to generate request examples

{
  "message": "<string>"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Hosted auth

Sign up a contact

Hosted mode only. Always answers 202 — the response never reveals whether the address already has an account. What the 202 hides:

A new address: the contact is created with the password attached and a verification email goes out.
An address that already has a password: an “you already have an account” notice goes to the inbox.
An address on a contact the developer’s server minted, with no password yet: the chosen password waits on the verification token and attaches only when the link proves the email. Attaching it earlier would let anyone capture the accounts a developer pre-created — the classic takeover, closed structurally.

Rate limited to 10 requests per hour per IP.

POST

contact-auth

signup

Error

A valid request URL is required to generate request examples

{
  "message": "<string>"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

application/json

publishable_key

string

required

string<email>

required

password

string

required

At least 8 characters, with a lowercase letter, an uppercase letter and a digit.

name

string

anonymous_id

string

Folds the visitor this person was into the new contact.

attribution

object

First touch, captured on the visitor at first load and preserved through a merge. All fields optional; empty means unknown.

Show child attributes

Accepted, unconditionally.

message

string

⌘I