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

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

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

  • CaContact

  • CnContact

  • CoContact

  • MxContact

  • NlContact

  • NycContact

  • 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

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 .ASIA domain name, the input can be:

    attr-name1=locality&attr-value1={Two-lettered Country code} attr-name2=legalentitytype&attr-value2={naturalPerson | corporation | cooperative | partnership | government | politicalParty | society | institution | other} attr-name3=otherlegalentitytype&attr-value3={Mention legal entity type. Mandatory if legalentitytype chosen as 'other'} attr-name4=identform&attr-value4={passport | certificate | legislation | societyRegistry | politicalPartyRegistry | other} attr-name5=otheridentform&attr-value5={Mention Identity form. Mandatory if identform chosen as 'other'} attr-name6=identnumber&attr-value6={Mention Identification Number}]
    Note

    This information can be associated with any one of the Contacts of the domain name.

  • 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 .CA domain name, the input can be:

    • attr-name1=CPR&attr-value1={Three-letter CPR code mentioned below}
      CPR Description Type
      CCO Corporation (Canada or Canadian province or territory) Non-individual
      CCT Canadian citizen Individual
      RES Permanent Resident of Canada Individual
      GOV Government or government entity in Canada Non-individual
      EDU Canadian Educational institution Non-individual
      ASS Canadian Unincorporated Association Non-individual
      HOP Canadian Hospital Non-individual
      PRT Partnership Registered in Canada Non-individual
      TDM Trade-mark registered in Canada (by a non-Canadian owner) Non-individual
      TRD Canadian Trade union Non-individual
      PLT Canadian Political party Non-individual
      LAM Canadian Library, Archive or Museum Non-individual
      TRS Trust established in Canada Non-individual
      ABO Aboriginal Peoples (individuals or groups) indigenous to Canada Individual
      INB Indian Band recognized by the Indian Act of Canada Non-individual
      LGR Legal Representative of a Canadian Citizen or Permanent Resident Individual
      OMK Official mark registered in Canada Non-individual
      MAJ Her Majesty the Queen Non-individual
    • attr-name2=AgreementVersion&attr-value2={Value of the GetRegistrantAgreement version}
    • attr-name3=AgreementValue&attr-value3={'y' indicating that the Registrant has agreed to the .CA Registrant Agreement}
      Note

      This information should be associated with the Registrant Contact of the domain name.

  • 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}
  • To associate the Contact with a .JOBS domain name, the input can be:

    attr-name1=title&attr-value1={Title of the Contact in the Company} attr-name2=website&attr-value2={Company Website} attr-name3=industry_type&attr-value3={Type / Classification of the industry in which the company conducts its business} attr-name4=is_admin_contact&attr-value4={true | false} attr-name5=is_association_member&attr-value5={true | false}
    Note

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

  • 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 .PRO domain name, input should have professional information to be associated with the Contact ID as follows:

    attr-name1=profession&attr-value1={Any of the values mentioned below}
    • Acupuncturists

    • Allied Health Professionals

    • Ambulance Services

    • Architects

    • Asbestos Removal Professionals

    • Barbers and Barber Shops

    • Certified Financial Analysts

    • Certified Financial Planners

    • Certified Public Accountants

    • Check Cashers

    • Chiropractors

    • Contractors, Home Improvement

    • Cosmetologists and Aestheticians

    • Debt Collectors

    • Dentists and Dental Hygienists

    • Dieticians and Nutritionists

    • Doctors

    • Educators

    • Electricians

    • Electrologists

    • Emergency Medical Technician

    • Engineers and Land Surveyors

    • Finance Companies

    • Financial Professional

    • Funeral Services

    • Health Care

    • Hearing Instrument Specialists

    • Home Inspectors

    • HVAC Technicians

    • Insurance

    • Investment Advisors

    • Landscape Architects

    • Lawyers

    • Lead Paint Inspectors

    • Manufactured Building Producers

    • Massage Therapy

    • Money Transmitters

    • Mortgage Lenders and Brokers

    • Municipal Building Inspectors

    • Nurses and Nurse Aides

    • Nursing Home Administrators

    • Nutritionists

    • Opticians

    • Optometrists

    • Perfusionist

    • Pharmacists

    • Physical Therapists

    • Physician Assistants

    • Physicians

    • Plumbers and Gas Fitters

    • Podiatrists

    • Psychologists

    • Public Relations

    • Radio and TV Technicians

    • Real Estate

    • Real Estate Appraisers

    • Respiratory Therapists

    • Sanitarians

    • Social Workers

    • Speech Pathologists and Audiologists

    • Veterinarians

    • Water Plant Operator

    • X-Ray Technicians

    • Internet Professional

    • Medical Professional

    • Legal Professional

    • Other (If your profession does not match any of the above mentioned values, you may provide your own value and it will be included under Other in our system.)

    Note

    This information has to be associated with Registrant Contact of the domain name.

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}"}