Header Reseller Branding

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 (general) or 50 characters (.EU)

company

String

Required

Name of the Company

Note

Max length 255 characters (general) or 100 characters (.EU)
In case of EuContact, if there is no associated Company, you may mention NA for this parameter.
the contact ID created for a natural person should have the company name listed as 'N/A'

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 (general) or 16 characters (.EU)

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
CaContact
CoContact
EuContact
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

Required

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 .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.

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 .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 .US domain name:
- Pipe-separated values are the Registry defined constants. Select any one of the given set of values.
  
  You have to mention the values where the set of pre-defined values are not provided.
  
  Example:
  
  attr-name1=purpose&attr-value1={P1 | P2 | P3 | P4 | P5}&attr-name2=category&attr-value2={C11 | C12 | C21 | C31 | C32}]
- Following is the mapping of the .US Nexus Category (category):
  - C11: A natural person who is a United States citizen.
  - C12: A natural person who is a permanent resident of the United States of America, or any of its possessions or territories.
  - C21: A US-based organization or company (A US-based organization or company formed within one of the fifty (50) U.S. states, the District of Columbia, or any of the United States possessions or territories, or organized or otherwise constituted under the laws of a state of the United States of America, the District of Columbia or any of its possessions or territories or a U.S. federal, state, or local government entity or a political subdivision thereof).
  - C31: A foreign entity or organization (A foreign entity or organization that has a bona fide presence in the United States of America or any of its possessions or territories who regularly engages in lawful activities (sales of goods or services or other business, commercial or non-commercial, including not-for-profit relations in the United States)).
  - C32: Entity has an office or other facility in the United States.
- Following is the mapping of the .US Nexus Application Purpose (purpose):
  - P1 : Business use for profit.
  - P2: Non-profit business, club, association, religious organization, etc.
  - P3: Personal use.
  - P4: Education purposes.
  - P5: Government purposes
  Note
  This information has to be associated with the 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 protected]&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}"}