Contacts : Create

Aangemaakt : 01-03-2023
Laatste update: 01-12-2023

Omschrijving

Maak een nieuw contact aan

Endpoint

POST https://api.nextname.nl/v2/contacts/handle
Content-type: application/json

Parameters

Parameter	Datatype	Verplicht	Omschrijving
handle	String	Nee	Unieke handle (identifier) voor het contact, als deze parameter niet wordt opgegeven genereert het systeem automatisch een handle. • Lengte min: 5 karakter • Lengte max: 20 karakters • Toegestane karakters: Letters, cijfers en - • Regexp: ^[a-zA-Z0-9\-]{5,20}$
company_name	String	Nee	Bedrijfsnaam van het contact • Lengte min: 1 karakter • Lengte max: 100 karakters
name	String	Ja	Naam van het contact Voor de compatibiliteit met de verschillende registries raden we aan om voornamen i.p.v. voorletters te gebruiken en geen punten op te nemen • Lengte min: 1 karakter • Lengte max: 100 karakters
address_1	String	Ja	Adresregel 1 van contact • Lengte min: 1 karakter • Lengte max: 100 karakters
address_2	String	Nee	Adresregel 2 van contact • Lengte min: 1 karakter • Lengte max: 100 karakters
postal_code	String	Ja	Postcode van contact • Lengte min: 1 karakter • Lengte max: 12 karakters
city	String	Ja	Woonplaats van contact • Lengte min: 1 karakter • Lengte max: 100 karakters
state	String	Nee	Staat/provincie van contact • Lengte min: 1 karakter • Lengte max: 100 karakters
country	String	Ja	Landcode van contact 2-Letterige landcode volgens ISO_3166-1 • Lengte: 2 karakters
phone	String	Ja	Telefoonnummer in e164a formaat • Voorbeeld: +31.612345678 • Regexp: \+[0-9]{1,3}\.[0-9]{1,14}$
email	String	Ja	E-mailadres van het contact
auto_delete	Boolean	Nee	Ruim het contact automatisch op indien er geen connecties met domeinnamen meer zijn. Indien deze parameters niet wordt opgegeven dan wordt standaard true gebruikt.
reference	String	Nee	Vrij veld voor eigen referentie Bijvoorbeeld een ID van de klant uit je eigen klantensysteem • Lengte max: 50 karakters

Antwoord

HTTP status code: 201 Created

Voorbeeld

Beschrijving:
Nieuw contact aanmaken

PHP
cURL

Opdracht in PHP:

<?php
$env      = "test"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/contacts/SOME-HANDLE-1";
$api_host = $env === "live" ? "https://api.nextname.nl" : "https://api-test.nextname.nl";

$a_data = [ "company_name" => "Test bedrijf",
	    "name" => "A Jansen",
	    "address_1" => "Markerkant 13 18",
            "address_2" => "gebouw 1-A",
	    "postal_code" => "1234 AB",
	    "city" => "Almere",
            "state" => "Flevoland",
	    "country" => "NL",
	    "phone" => "+31.612345678",
	    "email" => "info@nextname.nl",
	    "auto_delete" => true,
            "reference" => "123"
	  ];

$json_data = json_encode($a_data);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data );
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key","Content-Type: application/json"));
$output = curl_exec($ch);

if(curl_getinfo($ch, CURLINFO_HTTP_CODE) === 201) {
  echo "Contact successfully created";
}

curl_close($ch);

Opdracht in cURL:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-d '{"company_name":"Test bedrijf","name":"A Jansen","address_1":"Markerkant 13 18","address_2":"Gebouw 1-A","postal_code":"1234 AB","city":"Almere","state":"Flevoland","country":"NL","phone":"+31.367851370","email":"info@nextname.nl","auto_delete":true,"reference":"123"}' \
https://api-test.nextname.nl/v2/contacts/SOME-HANDLE-1

Antwoord:

HTTP/1.1 201 Created