PUT api/Contact/{handle}?user={user}
Update the contact specified by handle
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| handle |
Contact handle |
string |
Required |
| user |
Optional user handle - if empty logged in user will be used |
string |
None. |
Body Parameters
Details to update
Dictionary of string [key] and Object [value]Request Formats
application/json, text/json
{
"IsIndividual": true,
"Password": "sample string 1",
"Birthday": "2025-12-12T19:15:10.1690251+01:00",
"PlaceOfBirth": "sample string 2",
"Siren": "sample string 3",
"Intracom": "sample string 4",
"Mark": "sample string 5",
"Passport": "sample string 6",
"Identitycard": "sample string 7",
"Duns": "sample string 8",
"AssoWaldec": "sample string 9",
"AssoCreDate": "2025-12-12T19:15:10.1690251+01:00",
"AssoDecDate": "2025-12-12T19:15:10.1690251+01:00",
"AssoPubPage": 1,
"AssoPubAnnounce": 1,
"LocalNumber": "sample string 10",
"ExternalId": "sample string 11",
"NexusCat": "sample string 12",
"NexusPurpose": "sample string 13",
"CaLegalType": "sample string 14",
"CaTradeMark": true,
"Status": 1,
"Handle": "sample string 15",
"Entity": 16,
"OrgName": "sample string 17",
"LastName": "sample string 18",
"FirstName": "sample string 19",
"Address": "sample string 20",
"Address2": "sample string 21",
"City": "sample string 22",
"Pc": "sample string 23",
"Cc": "sample string 24",
"Sp": "sample string 25",
"Phone": "sample string 26",
"Fax": "sample string 27",
"MailAddress": "sample string 28",
"groupePrixID": 1.0
}
application/xml, text/xml
<EditContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact"> <Address>sample string 20</Address> <Address2>sample string 21</Address2> <Cc>sample string 24</Cc> <City>sample string 22</City> <Entity>16</Entity> <Fax>sample string 27</Fax> <FirstName>sample string 19</FirstName> <Handle>sample string 15</Handle> <LastName>sample string 18</LastName> <MailAddress>sample string 28</MailAddress> <OrgName>sample string 17</OrgName> <Pc>sample string 23</Pc> <Phone>sample string 26</Phone> <Sp>sample string 25</Sp> <groupePrixID>1</groupePrixID> <AssoCreDate>2025-12-12T19:15:10.1690251+01:00</AssoCreDate> <AssoDecDate>2025-12-12T19:15:10.1690251+01:00</AssoDecDate> <AssoPubAnnounce>1</AssoPubAnnounce> <AssoPubPage>1</AssoPubPage> <AssoWaldec>sample string 9</AssoWaldec> <Birthday>2025-12-12T19:15:10.1690251+01:00</Birthday> <CaLegalType>sample string 14</CaLegalType> <CaTradeMark>true</CaTradeMark> <Duns>sample string 8</Duns> <ExternalId>sample string 11</ExternalId> <Identitycard>sample string 7</Identitycard> <Intracom>sample string 4</Intracom> <IsIndividual>true</IsIndividual> <LocalNumber>sample string 10</LocalNumber> <Mark>sample string 5</Mark> <NexusCat>sample string 12</NexusCat> <NexusPurpose>sample string 13</NexusPurpose> <Passport>sample string 6</Passport> <Password>sample string 1</Password> <PlaceOfBirth>sample string 2</PlaceOfBirth> <Siren>sample string 3</Siren> <Status>1</Status> </EditContact>
application/x-www-form-urlencoded
Response Information
Resource Description
A contact object on success
Collection of errors on failure
Return codes
200 - ok
300 - ambiguous
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error
650 - OrgName is mandatory for non - individuals
651 - Postcode and city don't match
652 - Value cannot be nullified
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Contact name (firstname surname for individual else orgname) |
string |
None. |
| Birthday |
Date of birth |
date |
None. |
| PlaceOfBirth |
Place of birth |
string |
None. |
| CleTitulaire |
Registry contact password |
string |
None. |
| Siren | string |
None. |
|
| Intracom | string |
None. |
|
| Mark | string |
None. |
|
| Passport | string |
None. |
|
| Identitycard | string |
None. |
|
| Duns | string |
None. |
|
| AssoWaldec |
Association WALDEC number |
string |
None. |
| AssoCreDate |
Association create date |
date |
None. |
| AssoDecDate |
Association declaration date |
date |
None. |
| AssoPubPage | integer |
None. |
|
| AssoPubAnnounce | integer |
None. |
|
| LocalNumber | string |
None. |
|
| ExternalId | string |
None. |
|
| IsActive | boolean |
None. |
|
| Account | decimal number |
None. |
|
| AuthorizedBank | decimal number |
None. |
|
| VerifyAutoRenew |
When false the autorenews pass without account verification. Default is true |
boolean |
None. |
| HasTva |
Is the contact subject to tva |
boolean |
None. |
| RateTva |
The tva rate for this contact |
decimal number |
None. |
| Extension |
List of extension |
Collection of Object_Extension |
None. |
| Handle |
Contact handle |
string |
None. |
| Entity |
Entity type, 1 organization, 2 individual |
integer |
None. |
| OrgName |
Organization name |
string |
Matching regular expression pattern: [A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&@[\]\/^_`|}{]{1,150} String length: inclusive between 1 and 150 |
| LastName |
Last name |
string |
Matching regular expression pattern: [A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&@[\]\/^_`|}{]{1,150} String length: inclusive between 1 and 150 |
| FirstName |
First name |
string |
Matching regular expression pattern: [A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&@[\]\/^_`|}{]{1,150} String length: inclusive between 1 and 150 |
| Address |
Address line 1 |
string |
Matching regular expression pattern: ^(?![A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*\b([bB][pP]|[cC][eE][dD][eE][xX])\b)[A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*$ String length: inclusive between 1 and 250 |
| Address2 |
Address line 2 |
string |
Matching regular expression pattern: ^(?![A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*\b([bB][pP]|[cC][eE][dD][eE][xX])\b)[A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*$ String length: inclusive between 1 and 250 |
| City | string |
Matching regular expression pattern: ^(?![A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*\b([bB][pP]|[cC][eE][dD][eE][xX])\b)[A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*$ String length: inclusive between 1 and 150 |
|
| Pc |
Post code |
string |
Matching regular expression pattern: [ a-zA-Z0-9._/-]{1,30} String length: inclusive between 1 and 30 |
| Cc |
ISO 2 char country code |
string |
Matching regular expression pattern: [A-Za-z]{2} String length: inclusive between 2 and 2 |
| Sp | string |
Matching regular expression pattern: [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]\/^_`|}{]{0,80} String length: inclusive between 1 and 80 |
|
| Phone |
Phone number |
string |
Matching regular expression pattern: \+[0-9]{1,3}\.[0-9]{1,15} |
| Fax |
Fax number |
string |
Matching regular expression pattern: \+[0-9]{1,3}\.[0-9]{1,15} |
| MailAddress |
Email address |
string |
Matching regular expression pattern: [0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z][A-Z0-9a-z-]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,20}) String length: inclusive between 1 and 200 |
| groupePrixID |
Price group id |
decimal number |
None. |
Response Formats
application/json, text/json
{
"Name": "sample string 1",
"Birthday": "2025-12-12T19:15:10.2158649+01:00",
"PlaceOfBirth": "sample string 2",
"CleTitulaire": "sample string 3",
"Siren": "sample string 4",
"Intracom": "sample string 5",
"Mark": "sample string 6",
"Passport": "sample string 7",
"Identitycard": "sample string 8",
"Duns": "sample string 9",
"AssoWaldec": "sample string 10",
"AssoCreDate": "2025-12-12T19:15:10.2158649+01:00",
"AssoDecDate": "2025-12-12T19:15:10.2158649+01:00",
"AssoPubPage": 1,
"AssoPubAnnounce": 1,
"LocalNumber": "sample string 11",
"ExternalId": "sample string 12",
"IsActive": true,
"Account": 14.0,
"AuthorizedBank": 15.0,
"VerifyAutoRenew": true,
"HasTva": true,
"RateTva": 18.1,
"Extension": [
{
"Id": 1,
"Key": "sample string 2",
"Value": "sample string 3"
},
{
"Id": 1,
"Key": "sample string 2",
"Value": "sample string 3"
}
],
"Handle": "sample string 19",
"Entity": 20,
"OrgName": "sample string 21",
"LastName": "sample string 22",
"FirstName": "sample string 23",
"Address": "sample string 24",
"Address2": "sample string 25",
"City": "sample string 26",
"Pc": "sample string 27",
"Cc": "sample string 28",
"Sp": "sample string 29",
"Phone": "sample string 30",
"Fax": "sample string 31",
"MailAddress": "sample string 32",
"groupePrixID": 1.0
}
application/xml, text/xml
<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">
<Address>sample string 24</Address>
<Address2>sample string 25</Address2>
<Cc>sample string 28</Cc>
<City>sample string 26</City>
<Entity>20</Entity>
<Fax>sample string 31</Fax>
<FirstName>sample string 23</FirstName>
<Handle>sample string 19</Handle>
<LastName>sample string 22</LastName>
<MailAddress>sample string 32</MailAddress>
<OrgName>sample string 21</OrgName>
<Pc>sample string 27</Pc>
<Phone>sample string 30</Phone>
<Sp>sample string 29</Sp>
<groupePrixID>1</groupePrixID>
<Account>14</Account>
<AssoCreDate>2025-12-12T19:15:10.2158649+01:00</AssoCreDate>
<AssoDecDate>2025-12-12T19:15:10.2158649+01:00</AssoDecDate>
<AssoPubAnnounce>1</AssoPubAnnounce>
<AssoPubPage>1</AssoPubPage>
<AssoWaldec>sample string 10</AssoWaldec>
<AuthorizedBank>15</AuthorizedBank>
<Birthday>2025-12-12T19:15:10.2158649+01:00</Birthday>
<CleTitulaire>sample string 3</CleTitulaire>
<Duns>sample string 9</Duns>
<Extension>
<Object_Extension>
<Id>1</Id>
<Key>sample string 2</Key>
<Value>sample string 3</Value>
</Object_Extension>
<Object_Extension>
<Id>1</Id>
<Key>sample string 2</Key>
<Value>sample string 3</Value>
</Object_Extension>
</Extension>
<ExternalId>sample string 12</ExternalId>
<HasTva>true</HasTva>
<Identitycard>sample string 8</Identitycard>
<Intracom>sample string 5</Intracom>
<IsActive>true</IsActive>
<LocalNumber>sample string 11</LocalNumber>
<Mark>sample string 6</Mark>
<Name>sample string 1</Name>
<Passport>sample string 7</Passport>
<PlaceOfBirth>sample string 2</PlaceOfBirth>
<RateTva>18.1</RateTva>
<Siren>sample string 4</Siren>
<VerifyAutoRenew>true</VerifyAutoRenew>
</Contact>