Add Contact

Description

Adds a Contact to the domain using the details provided.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
name String Required

Name of the Contact

Note
  • Max length 255 characters

company String Required

Name of the Company

Note
  • Max length 255 characters

  • In case of RuContact, the Company Name should have at least 2 words.

    If there is no associated Company, you may mention N A or Not Applicable for this parameter. You will encounter the following error message, if values containing a single word such as NA or N/A are mentioned:

    Attention

    Company Name should contain at least two words.

email String Required Email address of the Contact
address-line-1 String Required First line of address of the Contact
Note
  • Max length 64 characters

  • For NycContact Contact type, a physical street address in the New York City must be provided.

city String Required Name of the City
Note

Max length 64 characters

country String Required

Country code as per ISO 3166-1 alpha-2

Note

For UkServiceContact Contact type, the country code can only be GB (United Kingdom), IM (Isle of Man), JE (Jersey) or GG (Guernsey).

zipcode String Required ZIP code
Note

Max length 10 characters

Attention

ZIP Code will be validated against the Country selected during the contact create process. An invalid zipcode will return an error message.

phone-cc String Required Telephone number country code
Note

Between 1-3 digits

Attention

Only valid telephone number country code will be accepted.

phone String Required Telephone number
Note

Between 4-12 digits (general) or between 4-13 digits (.RU)

customer-id Integer Required The Customer under whom you want to create the Contact
type String Required

The Contact Type. This can take following values:

  • Contact

  • BrContact or BrOrgContact

  • CnContact

  • MxContact

  • NlContact

  • NycContact

  • RuContact

  • UkContact or UkServiceContact

address-line-2 String Optional Second line of address of the Contact
address-line-3 String Optional Third line of address of the Contact
state String Optional

Name of the State

Note
  • Max length 64 characters

fax-cc String Optional Fax number country code
Note

Between 1-3 digits

fax String Optional Fax number
Note

Between 4-12 digits (general) or between 4-13 digits (.RU)

attr-name Map[name] Optional Mapping key of any extra information to be associated for the contact that is being added. Refer the description of attr-value.
attr-value Map[value] Required

Mapping value of the extra details required to be associated with a particular Contact before registering a domain name. This together with attr-name shall contain the extra details.

  • To associate the Contact with a .BR domain name, the input can be:

    attr-name1=organisationId&attr-value1={Organisation ID}

    Note
    • Organisation ID: Only Brazilian nationals or organizations can register .BR domains. Hence, a tax ID (CPF in case of an individual contact) or an organisation ID (CNPJ in case of a company contact) of the person/organisation needs to be supplied for the Registrant contact (BrOrgContact). The tax/organization ID must either not be currently registered in our database or it should be a transferred authority to the registrar through the .BR registry web interface.

    • In addition, depending on the contact, you will need to specify the “type” as BrOrgContact (for the Registrant contact) or BrContact (for the Admin/technical/Billing contact). The Admin, technical and Billing contact should not be associated with the organization ID mentioned above. This is only needed for the Registrant contact.

  • To associate the Contact with a .CN domain name, the input can be:

    • attr-name1=organisationVerificationId&attr-value1={Mention any ID associated with the organization}
  • You need to pass the country of citizenship if the registrant is an individual/natural person and the country of residence is not one of the EU/EEA countries or in EU territories:

    attr-name1=countryOfCitizenship&attr-value1={Two-lettered country code}

    Note

    List of two-letter country codes

    • AT,BE, BG, CY, CZ, DE, DK, ES, EE, FI, FR, GR, HR, HU, IE, IT, LT, LU, LV, MT, NL, PL, PT, RO, SE, SI, SK
  • To associate the Contact with a .NL domain name, the input can be:

    attr-name1=legalForm&attr-value1={PERSOON | ANDERS}

    Note

    This information has to be associated with all Contacts of the .NL domain name.

  • To associate the Contact with a .RU domain name, the input can be:

    • contract-type: This value indicates that the Contact Type is an Organization. Use PRS for Individual. It is mandatory to send this name-value pair.

       

      attr-name1=contract-type&attr-value1=ORG

    • birth-date: The value needs to be sent as numerals in DD.MM.YYYY format. It is mandatory to send this name-value pair for Individual Contact Type.

       

      attr-name2=birth-date&attr-value2=08.08.1900

    • org-r: This value indicates the legally registered company name as mentioned in the Company Formation documents. This value needs to include at least 2 words and is mandatory for the Organization Contact Type.

       

      attr-name3=org-r&attr-value3=some company

    • person-r: This is the Registrant's full name (preferably in Russian). It is mandatory to send this name-value pair for Individual Contact Type.

       

      attr-name4=person-r&attr-value4=FirstName LastName

    • address-r: This value indicates the Registrant's address (preferably in Russian). This value needs to include at least 2 words and is mandatory for the Organization Contact Type.

       

      attr-name5=address-r&attr-value5=Some Address

    • kpp: This value is the Territory-linked Taxpayer number. This is a 9 digit number and is mandatory for the Organization Contact Type, when the Country is Russia.

       

      attr-name6=kpp&attr-value6=123456789

    • code: This value is the Taxpayer Identification Number (TIN). This is a 10 digit number and is mandatory for Organization Contact Type, when the Country is Russia.

       

      attr-name7=code&attr-value7=0987654321

    • passport: This is value needs to include the Document number, Issued by, Issued Date details. It is mandatory to send this name-value pair for Individual Contact Type.

       

      attr-name8=passport&attr-value8=12 34 567890, issued by the 123 police station of Moscow, 30.01.1990

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&email=urname@domain.com&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0&type=Contact

Response

Returns the Contact Id (Integer) of newly added Contact. Multiple Contacts can be added for the same Name and Company Name behavior.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Sample error message when Single Field is invalid {"status":"ERROR","message":"{telnocc=TelephoneNo Country Code is invalid}"}

Sample error message when Multiple Fields are invalid {"status":"ERROR","message":"{telnocc=TelephoneNo Country Code is invalid, zip=Postal Code is invalid}"}