Request Information
URI Parameters :
None.
Body Parameters :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
company of the contact |
globally unique identifier | |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_title_id | globally unique identifier | ||
| db_functionbis_id | globally unique identifier | ||
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| notes | string | ||
| phone |
Phone number of the contact |
string |
Max length: 255 |
| mobile |
Mobile number of the contact |
string |
Max length: 255 |
|
|
string |
Max length: 255 |
|
| e_login |
e_login |
string |
Max length: 50 |
| e_servicedesk |
e_servicedesk |
boolean | |
| e_new_password |
new_e_password |
string |
Max length: 50 |
| e_commerce | boolean | ||
| e_document | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| contact_picture | Collection of byte |
Request Formats :
application/json, text/json
{
"id": "c764d395-ea6c-4624-a4ac-8f356b1bf797",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5038c251-4444-4904-b318-55e685465504",
"db_language_id": "10ff5617-0a49-402a-8fb7-afc412f7dfeb",
"db_title_id": "ada5b12e-a07e-4b91-8398-dbfab41e3c89",
"db_functionbis_id": "d062f667-2da6-4a26-9ff3-369ebdb79dfa",
"archived": true,
"functions": "sample string 9",
"notes": "sample string 10",
"phone": "sample string 11",
"mobile": "sample string 12",
"email": "sample string 13",
"e_login": "sample string 14",
"e_servicedesk": true,
"e_new_password": "sample string 16",
"e_commerce": true,
"e_document": true,
"modified_dateutc": "2026-03-07T13:15:10.4147701+00:00",
"contact_picture": "QEA="
}
application/xml, text/xml
<contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <company_id>5038c251-4444-4904-b318-55e685465504</company_id> <contact_picture>QEA=</contact_picture> <db_functionbis_id>d062f667-2da6-4a26-9ff3-369ebdb79dfa</db_functionbis_id> <db_language_id>10ff5617-0a49-402a-8fb7-afc412f7dfeb</db_language_id> <db_title_id>ada5b12e-a07e-4b91-8398-dbfab41e3c89</db_title_id> <e_commerce>true</e_commerce> <e_document>true</e_document> <e_login>sample string 14</e_login> <e_new_password>sample string 16</e_new_password> <e_servicedesk>true</e_servicedesk> <email>sample string 13</email> <firstname>sample string 2</firstname> <functions>sample string 9</functions> <id>c764d395-ea6c-4624-a4ac-8f356b1bf797</id> <lastname>sample string 3</lastname> <mobile>sample string 12</mobile> <modified_dateutc>2026-03-07T13:15:10.414Z</modified_dateutc> <notes>sample string 10</notes> <phone>sample string 11</phone> </contact>
Response Information
Resource Description :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
company of the contact |
globally unique identifier | |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_title_id | globally unique identifier | ||
| db_functionbis_id | globally unique identifier | ||
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| notes | string | ||
| phone |
Phone number of the contact |
string |
Max length: 255 |
| mobile |
Mobile number of the contact |
string |
Max length: 255 |
|
|
string |
Max length: 255 |
|
| e_login |
e_login |
string |
Max length: 50 |
| e_servicedesk |
e_servicedesk |
boolean | |
| e_new_password |
new_e_password |
string |
Max length: 50 |
| e_commerce | boolean | ||
| e_document | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| contact_picture | Collection of byte |
Response Formats
application/json, text/json
{
"id": "bb7e70d1-bb4f-4f0f-a9bf-f8f14c71a734",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1ea4940a-5203-472c-80d2-ee236aac2ace",
"db_language_id": "44cba22b-d74c-436b-9856-dd072debf71f",
"db_title_id": "1701b4d8-7e79-4b61-8eb4-c68475ef40bf",
"db_functionbis_id": "543fb050-22fc-486e-9053-0e99f70bb579",
"archived": true,
"functions": "sample string 9",
"notes": "sample string 10",
"phone": "sample string 11",
"mobile": "sample string 12",
"email": "sample string 13",
"e_login": "sample string 14",
"e_servicedesk": true,
"e_new_password": "sample string 16",
"e_commerce": true,
"e_document": true,
"modified_dateutc": "2026-03-07T13:15:10.4147701+00:00",
"contact_picture": "QEA="
}
application/xml, text/xml
<contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <company_id>1ea4940a-5203-472c-80d2-ee236aac2ace</company_id> <contact_picture>QEA=</contact_picture> <db_functionbis_id>543fb050-22fc-486e-9053-0e99f70bb579</db_functionbis_id> <db_language_id>44cba22b-d74c-436b-9856-dd072debf71f</db_language_id> <db_title_id>1701b4d8-7e79-4b61-8eb4-c68475ef40bf</db_title_id> <e_commerce>true</e_commerce> <e_document>true</e_document> <e_login>sample string 14</e_login> <e_new_password>sample string 16</e_new_password> <e_servicedesk>true</e_servicedesk> <email>sample string 13</email> <firstname>sample string 2</firstname> <functions>sample string 9</functions> <id>bb7e70d1-bb4f-4f0f-a9bf-f8f14c71a734</id> <lastname>sample string 3</lastname> <mobile>sample string 12</mobile> <modified_dateutc>2026-03-07T13:15:10.414Z</modified_dateutc> <notes>sample string 10</notes> <phone>sample string 11</phone> </contact>