Skip to main content
POST
Handle anlegen

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Body

application/json

The new Handle resource

address
string
default:""
required
Required string length: 2 - 255
Example:

"Mainstreet 1"

city
string
default:""
required
Required string length: 2 - 255
Example:

"Cologne"

zipcode
string
default:""
required
Required string length: 2 - 255
Example:

"12345"

countryCode
string
default:""
required

ISO 3166-1 alpha-2 country code

Required string length: 2 - 255
Example:

"DE"

email
string<email>
default:""
required
Required string length: 2 - 255
Example:

"acme@example.com"

type
enum<string>
default:PERS
required

Handle-Typ, explizit: PERS (Person), ORG (Organisation) oder ROLE. ORG erfordert company, PERS erfordert firstname+lastname.

Available options:
ORG,
PERS,
ROLE
Example:

"PERS"

firstname
string
default:""

Pflicht bei type=PERS.

Required string length: 2 - 255
Example:

"John"

lastname
string
default:""

Pflicht bei type=PERS.

Required string length: 2 - 255
Example:

"Doe"

company
string | null

Pflicht bei type=ORG.

Required string length: 2 - 255
Example:

"ACME Inc."

addressLine2
string | null

Adresszeile 2 (Zusatz).

Maximum string length: 255
Example:

"c/o Musterfirma"

state
string | null

Bundesstaat/Region. Pflicht für Adressen in US/CA/AU.

Maximum string length: 255
Example:

"NY"

language
string | null

Sprache des Kontakts, ISO 639-1.

Pattern: ^([a-z]{2})$
Example:

"de"

phone
string | null

Telefonnummer, freies Format (+49 89 123456, +49-89-123456, +49.89123456, 0049..., national "089/123456" zusammen mit countryCode). Wird beim Speichern in E.164 normalisiert. Bevorzugt gegenüber phone1/2/3.

Example:

"+49 89 123456"

fax
string | null

Faxnummer, freies Format. Wird in E.164 normalisiert.

Example:

"+49 89 123457"

phone1
string
default:""
deprecated

DEPRECATED: Ländervorwahl. Stattdessen "phone" nutzen.

Pattern: ^(\+\d{1,3})$
Example:

"+49"

phone2
string
default:""
deprecated

DEPRECATED: Ortsvorwahl. Stattdessen "phone" nutzen.

Pattern: ^(\d{0,5})$
Example:

"221"

phone3
string
default:""
deprecated

DEPRECATED: Rufnummer. Stattdessen "phone" nutzen.

Pattern: ^(\d{0,15})$
Example:

"1234567"

fax1
string | null
deprecated

DEPRECATED: Fax-Ländervorwahl. Stattdessen "fax" nutzen.

Pattern: ^(\+\d{1,3})$
Example:

"+49"

fax2
string | null
deprecated

DEPRECATED: Fax-Ortsvorwahl. Stattdessen "fax" nutzen.

Pattern: ^(\d{0,5})$
Example:

"221"

fax3
string | null
deprecated

DEPRECATED: Fax-Rufnummer. Stattdessen "fax" nutzen.

Pattern: ^(\d{0,15})$
Example:

"1234567"

Response

Handle resource created

id
string
read-only
Example:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

firstname
string
Example:

"John"

lastname
string
Example:

"Doe"

company
string | null
Example:

"ACME Inc."

address
string

Adresszeile 1 (Straße + Hausnummer)

Example:

"Mainstreet 1"

addressLine2
string | null

Adresszeile 2 (Zusatz). Registrare ohne zweite Zeile bekommen sie angehängt.

Maximum string length: 255
Example:

"c/o Musterfirma"

city
string
Example:

"Cologne"

state
string | null

Bundesstaat/Region (ISO-3166-2-Subcode wo vorhanden). Pflicht für US/CA/AU.

Maximum string length: 255
Example:

"NY"

zipcode
string
Example:

"12345"

countryCode
string

ISO 3166-1 alpha-2 country code

Example:

"DE"

email
string
Example:

"acme@example.com"

language
string | null

Sprache des Kontakts, ISO 639-1 (klein).

Pattern: ^([a-z]{2})$
Example:

"de"

note
string | null
Example:

"Some internal note"

verified
boolean
phone
string | null
read-only

Telefonnummer in E.164-Kanonform (maßgeblich).

Example:

"+4989123456"

fax
string | null
read-only

Faxnummer in E.164-Kanonform (maßgeblich).

Example:

"+4989123457"

phone1
string

DEPRECATED: Ländervorwahl. Abgeleitet aus phone (E.164).

Pattern: ^(\+\d{1,3})$
Example:

"+49"

phone2
string

DEPRECATED: Ortsvorwahl. Leer, wenn unbekannt.

Pattern: ^(\d{0,5})$
Example:

"221"

phone3
string

DEPRECATED: Rufnummer. Abgeleitet aus phone (E.164).

Pattern: ^(\d{1,15})$
Example:

"1234567"

fax1
string | null

DEPRECATED: Fax-Ländervorwahl. Abgeleitet aus fax (E.164).

Pattern: ^(\+\d{1,3})$
Example:

"+49"

fax2
string | null

DEPRECATED: Fax-Ortsvorwahl. Leer, wenn unbekannt.

Pattern: ^(\d{0,5})$
Example:

"221"

fax3
string | null

DEPRECATED: Fax-Rufnummer. Abgeleitet aus fax (E.164).

Pattern: ^(\d{1,15})$
Example:

"1234567"

type
enum<string>
Available options:
ORG,
PERS,
ROLE
Example:

"PERS"

registrarRelations
object[]
read-only

Zuordnung: bei welchem Registrar der Handle angelegt ist und welche ID er dort hat (z. B. InternetX Contact-ID, nic.ch Handle).

warnings
string[]

Hinweise auf fehlende Pflichtfelder (nur bei POST/PUT gefüllt).