Creates a new contact object
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 |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
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 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "df7d8b5f-6c10-4bbe-bd0b-b313fbf22af7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8394308f-41b3-42f0-bdf4-c6360c94e996",
"company_code": "sample string 5",
"company": {
"id": "637dab91-b04d-44ac-bf83-67e2de3a2782",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T02:59:22.7884034+00:00",
"sales_territory_id": "4f28d33b-1981-45cc-b8fb-b57918aeb586",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a1bf325d-79ea-4786-b851-f45ce46db0a9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2547dbad-73cd-4d07-9ac6-65adc0a45f1e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c13c81e-db07-48ec-a85f-37db3567a565",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e62c6c32-a927-4119-a838-121a4a542268",
"db_currency_id": "e63e37c6-f7e5-4425-97e3-9cd8ee6cd2b3",
"db_language_id": "94f2c903-fc1a-473c-96fb-88a45510492c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-09-18T02:59:22.7884034+00:00"
},
"modified_dateutc": "2025-09-18T02:59:22.7884034+00:00"
},
"marketing_segment_id": "5921a123-f53b-4cea-9089-b6347a450c7e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "45366084-ce68-4a94-8780-b5889c091ca6",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "daebc4db-b2ef-478e-89ef-26b2fc6d5e34",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "af18a4f4-6547-48e9-98e1-085f0fa0fd9b",
"db_country_code": "sample string 28",
"feelist_id": "d4069fd7-fdc7-41ea-bc27-7908e5faa981",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9275d4a1-dfc7-403c-a2c8-c46c974dd178",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "70661706-ce72-4391-9826-f47a04022f31",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T02:59:22.7884034+00:00",
"db_currency_id": "a78ffdc1-9198-4251-b44d-c91c314a3234",
"db_currency_code": "sample string 10"
},
"company_type_id": "b10bac1d-5181-4ae4-807a-2966c8df61a1",
"company_type_name": "sample string 32",
"company_type": {
"id": "efe88e4b-2ad3-45dd-85d9-0027b1fd318d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1a504452-23f6-4a60-a3ac-d20e50cd569c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ae089951-524a-4b3e-b053-d7d3edc2bdc5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "67a25868-6245-4f22-991f-093a60a1c873",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cf4c23b4-584b-44b6-9260-f26387f57ab7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2f2f194f-4af0-42b8-95e3-9fab88313d5d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T02:59:22.7884034+00:00"
},
"company_sector_id": "6a95276d-e0cc-4255-bc18-ba72ef9d4c2e",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "15a50992-d7f2-4762-a31b-5b1781aef631",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c5492d49-4fc0-4f92-91e5-286ac26e4155",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4ca45d6-0b7a-434b-9fe1-269ef7eec1ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "335326b5-fba5-4fe1-b063-20acd6fd78df",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T02:59:22.7884034+00:00",
"id2": 60
},
"db_language_id": "383856ab-ce53-43d9-86e8-a63541f4d783",
"db_language_code": "sample string 7",
"db_title_id": "057fa98e-1fb4-4fa6-b231-a882a0c4794f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T02:59:22.7884034+00:00",
"create_date": "2025-09-18T02:59:22.7884034+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2025-09-18T02:59:22.7884034+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.