Creer une personne

Create person

curl --request POST \
  --url https://api.withallo.com/v2/api/crm/people \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John",
  "last_name": "Doe",
  "job_title": "CEO",
  "website": "https://example.com",
  "address": "123 Main St",
  "numbers": [
    "+33612345678"
  ],
  "emails": [
    "[email protected]"
  ],
  "company_id": "com-xyz789",
  "custom_attributes": {
    "lead_source": "Webinar",
    "budget": 5000
  }
}
'

import requests

url = "https://api.withallo.com/v2/api/crm/people"

payload = {
    "name": "John",
    "last_name": "Doe",
    "job_title": "CEO",
    "website": "https://example.com",
    "address": "123 Main St",
    "numbers": ["+33612345678"],
    "emails": ["[email protected]"],
    "company_id": "com-xyz789",
    "custom_attributes": {
        "lead_source": "Webinar",
        "budget": 5000
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John',
    last_name: 'Doe',
    job_title: 'CEO',
    website: 'https://example.com',
    address: '123 Main St',
    numbers: ['+33612345678'],
    emails: ['[email protected]'],
    company_id: 'com-xyz789',
    custom_attributes: {lead_source: 'Webinar', budget: 5000}
  })
};

fetch('https://api.withallo.com/v2/api/crm/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withallo.com/v2/api/crm/people",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'John',
    'last_name' => 'Doe',
    'job_title' => 'CEO',
    'website' => 'https://example.com',
    'address' => '123 Main St',
    'numbers' => [
        '+33612345678'
    ],
    'emails' => [
        '[email protected]'
    ],
    'company_id' => 'com-xyz789',
    'custom_attributes' => [
        'lead_source' => 'Webinar',
        'budget' => 5000
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withallo.com/v2/api/crm/people"

	payload := strings.NewReader("{\n  \"name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"job_title\": \"CEO\",\n  \"website\": \"https://example.com\",\n  \"address\": \"123 Main St\",\n  \"numbers\": [\n    \"+33612345678\"\n  ],\n  \"emails\": [\n    \"[email protected]\"\n  ],\n  \"company_id\": \"com-xyz789\",\n  \"custom_attributes\": {\n    \"lead_source\": \"Webinar\",\n    \"budget\": 5000\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.withallo.com/v2/api/crm/people")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"job_title\": \"CEO\",\n  \"website\": \"https://example.com\",\n  \"address\": \"123 Main St\",\n  \"numbers\": [\n    \"+33612345678\"\n  ],\n  \"emails\": [\n    \"[email protected]\"\n  ],\n  \"company_id\": \"com-xyz789\",\n  \"custom_attributes\": {\n    \"lead_source\": \"Webinar\",\n    \"budget\": 5000\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withallo.com/v2/api/crm/people")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"job_title\": \"CEO\",\n  \"website\": \"https://example.com\",\n  \"address\": \"123 Main St\",\n  \"numbers\": [\n    \"+33612345678\"\n  ],\n  \"emails\": [\n    \"[email protected]\"\n  ],\n  \"company_id\": \"com-xyz789\",\n  \"custom_attributes\": {\n    \"lead_source\": \"Webinar\",\n    \"budget\": 5000\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "per-abc123",
    "name": "John",
    "last_name": "Doe",
    "job_title": "CEO",
    "website": "https://example.com",
    "address": "123 Main St",
    "numbers": [
      "+33612345678"
    ],
    "emails": [
      "[email protected]"
    ],
    "company": {
      "id": "com-xyz789",
      "name": "Acme Corp"
    },
    "interactions": 5,
    "last_activity_at": "2026-04-28T10:30:00",
    "created_at": "2026-04-01T09:00:00",
    "updated_at": "2026-04-28T10:30:00",
    "custom_attributes": {
      "lead_source": "Webinar",
      "budget": 5000
    }
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

POST

api

crm

people

Create person

curl --request POST \
  --url https://api.withallo.com/v2/api/crm/people \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John",
  "last_name": "Doe",
  "job_title": "CEO",
  "website": "https://example.com",
  "address": "123 Main St",
  "numbers": [
    "+33612345678"
  ],
  "emails": [
    "[email protected]"
  ],
  "company_id": "com-xyz789",
  "custom_attributes": {
    "lead_source": "Webinar",
    "budget": 5000
  }
}
'

import requests

url = "https://api.withallo.com/v2/api/crm/people"

payload = {
    "name": "John",
    "last_name": "Doe",
    "job_title": "CEO",
    "website": "https://example.com",
    "address": "123 Main St",
    "numbers": ["+33612345678"],
    "emails": ["[email protected]"],
    "company_id": "com-xyz789",
    "custom_attributes": {
        "lead_source": "Webinar",
        "budget": 5000
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John',
    last_name: 'Doe',
    job_title: 'CEO',
    website: 'https://example.com',
    address: '123 Main St',
    numbers: ['+33612345678'],
    emails: ['[email protected]'],
    company_id: 'com-xyz789',
    custom_attributes: {lead_source: 'Webinar', budget: 5000}
  })
};

fetch('https://api.withallo.com/v2/api/crm/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withallo.com/v2/api/crm/people",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'John',
    'last_name' => 'Doe',
    'job_title' => 'CEO',
    'website' => 'https://example.com',
    'address' => '123 Main St',
    'numbers' => [
        '+33612345678'
    ],
    'emails' => [
        '[email protected]'
    ],
    'company_id' => 'com-xyz789',
    'custom_attributes' => [
        'lead_source' => 'Webinar',
        'budget' => 5000
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withallo.com/v2/api/crm/people"

	payload := strings.NewReader("{\n  \"name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"job_title\": \"CEO\",\n  \"website\": \"https://example.com\",\n  \"address\": \"123 Main St\",\n  \"numbers\": [\n    \"+33612345678\"\n  ],\n  \"emails\": [\n    \"[email protected]\"\n  ],\n  \"company_id\": \"com-xyz789\",\n  \"custom_attributes\": {\n    \"lead_source\": \"Webinar\",\n    \"budget\": 5000\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.withallo.com/v2/api/crm/people")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"job_title\": \"CEO\",\n  \"website\": \"https://example.com\",\n  \"address\": \"123 Main St\",\n  \"numbers\": [\n    \"+33612345678\"\n  ],\n  \"emails\": [\n    \"[email protected]\"\n  ],\n  \"company_id\": \"com-xyz789\",\n  \"custom_attributes\": {\n    \"lead_source\": \"Webinar\",\n    \"budget\": 5000\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withallo.com/v2/api/crm/people")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"job_title\": \"CEO\",\n  \"website\": \"https://example.com\",\n  \"address\": \"123 Main St\",\n  \"numbers\": [\n    \"+33612345678\"\n  ],\n  \"emails\": [\n    \"[email protected]\"\n  ],\n  \"company_id\": \"com-xyz789\",\n  \"custom_attributes\": {\n    \"lead_source\": \"Webinar\",\n    \"budget\": 5000\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "per-abc123",
    "name": "John",
    "last_name": "Doe",
    "job_title": "CEO",
    "website": "https://example.com",
    "address": "123 Main St",
    "numbers": [
      "+33612345678"
    ],
    "emails": [
      "[email protected]"
    ],
    "company": {
      "id": "com-xyz789",
      "name": "Acme Corp"
    },
    "interactions": 5,
    "last_activity_at": "2026-04-28T10:30:00",
    "created_at": "2026-04-01T09:00:00",
    "updated_at": "2026-04-28T10:30:00",
    "custom_attributes": {
      "lead_source": "Webinar",
      "budget": 5000
    }
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

Scope requis : CRM_WRITE

Champs du body

Champ	Type	Requis	Defaut	Description
`name`	string	non		Prenom
`last_name`	string	non		Nom de famille
`job_title`	string	non		Poste
`website`	string	non		URL du site web
`address`	string	non		Adresse
`numbers`	array	oui		Numéros de téléphone au format E.164. Au moins un numéro
`emails`	array	non		Adresses email
`company_id`	string	non		ID de l’entreprise associee
`allow_duplicate_number`	boolean	non	`false`	Autorise la creation meme si un ou plusieurs numeros sont deja attribues a une autre personne
`custom_attributes`	object	non		Valeurs de vos champs personnalisés, indexées par clé de champ

Au moins un des champs name ou last_name est requis. Une requête sans numbers, ou avec une liste vide, échoue avec 400 MISSING_FIELD.

Associations

Passez un company_id pour lier la personne a une entreprise existante. L’entreprise doit exister, sinon la requete retourne une erreur.

Numeros de telephone en double

Par defaut, creer une personne avec des numeros deja attribues a une autre personne de votre equipe retourne une erreur 409 Conflict. La reponse inclut les IDs des personnes existantes pour que vous puissiez les mettre a jour. Pour creer la personne malgre tout, passez allow_duplicate_number a true.

{
  "name": "John",
  "numbers": ["+33612345678"],
  "allow_duplicate_number": true
}

Pour trouver la personne existante par numero, utilisez Rechercher des personnes avec le filtre phone_number.

Attributs personnalisés

custom_attributes définit les valeurs de vos champs personnalisés. Créez d’abord le champ, puis utilisez sa key ici.

Type d’attribut	Valeur acceptée
`TEXT`	Une chaîne
`NUMBER`	Un nombre JSON fini. Les chaînes sont rejetées. Relu comme un décimal : `180` est renvoyé sous la forme `180.0`
`BOOLEAN`	Un booléen JSON
`DATE`	`YYYY-MM-DD` ou une date-heure ISO. Stockée comme date et renvoyée au format `YYYY-MM-DD`
`DROPDOWN`	Une clé ou un label d’option, sans distinction de casse. Toujours renvoyée sous forme de clé d’option

Envoyez null pour une clé afin d’effacer sa valeur.
Les clés absentes de la requête ne changent pas. {}, ou l’absence de custom_attributes, ne change rien.
Une clé inconnue ou archivée renvoie 400 CUSTOM_ATTRIBUTE_KEY_UNKNOWN. Une valeur du mauvais type renvoie 400 CUSTOM_ATTRIBUTE_VALUE_INVALID. Dans les deux cas, param vaut custom_attributes.<key>.
La requête entière est validée avant toute écriture : une requête rejetée ne crée rien.
La réponse inclut toujours custom_attributes, {} si la personne n’en a pas. Les attributs archivés et les valeurs vides sont omis.
Les valeurs sont aussi synchronisées vers vos CRM connectés qui créent des contacts. Une valeur d’un attribut synchronisé depuis un CRM peut être écrasée par la prochaine synchronisation du CRM.

Exemple

Le nombre budget est relu comme un décimal.

{
  "name": "John",
  "numbers": ["+33612345678"],
  "custom_attributes": {
    "lead_source": "Webinar",
    "budget": 5000
  }
}

{
  "data": {
    "id": "per-abc123",
    "name": "John",
    "numbers": ["+33612345678"],
    "custom_attributes": {
      "lead_source": "Webinar",
      "budget": 5000.0
    }
  }
}

Autorisations

Authorization

string

header

requis

Corps

application/json

Request body for creating a person

numbers

string[]

requis

Phone numbers in E.164 format. At least one number is required.

Minimum array length: 1

Exemple:

["+33612345678"]

name

string | null

First name

Exemple:

"John"

last_name

string | null

Last name

Exemple:

"Doe"

job_title

string | null

Job title

Exemple:

"CEO"

website

string | null

Website URL

Exemple:

"https://example.com"

address

string | null

Postal address

Exemple:

"123 Main St"

emails

string[] | null

Email addresses

Exemple:

["[email protected]"]

company_id

string | null

ID of the company to associate with

Exemple:

"com-xyz789"

allow_duplicate_number

boolean

défaut:false

When true, allows creating a person even if the phone numbers are already assigned to another person. Defaults to false.

custom_attributes

object | null

Values for the person's custom attributes, keyed by attribute key. TEXT takes a string, NUMBER a finite JSON number (numeric strings are rejected), BOOLEAN a JSON boolean, DATE a YYYY-MM-DD string or ISO datetime, and DROPDOWN an option key or label (case-insensitive). Send null to clear a value; keys you omit are left untouched, and {} or omitting the field changes nothing. An unknown or archived key, or a value of the wrong type, rejects the whole request with CUSTOM_ATTRIBUTE_KEY_UNKNOWN or CUSTOM_ATTRIBUTE_VALUE_INVALID.

Exemple:

{ "lead_source": "Webinar", "budget": 5000 }

Réponse

Person created

data

object

A person in the CRM

Show child attributes

API

Webhooks

Conversations

CRM

Personnes

Champs personnalisés

Vues

Entreprises

Deals

Notes

Fils de discussion

Numéros de téléphone

Réceptionniste IA

Tags

Modèles de résumé

Utilisateurs

SMS

Analytiques

Power Dialer

Partner

Champs du body

Associations

Numeros de telephone en double

Attributs personnalisés

Exemple

Autorisations

Corps

Réponse

​Champs du body

​Associations

​Numeros de telephone en double

​Attributs personnalisés

​Exemple

Autorisations

Corps

Réponse

Champs du body

Associations

Numeros de telephone en double

Attributs personnalisés

Exemple