Skip to main content

contacts

Creates, updates, deletes, gets or lists a contacts resource.

Overview​

Namecontacts
TypeResource
Idovh.domain.contacts

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idintegerUnique identifier
accreditation_idstringLawyer accreditation number (wire: accreditationId)
enterprise_idstringEnterprise identifier (wire: enterpriseId)
trademark_idstringTrademark related to the contact (wire: trademarkId)
first_namestringFirst name (wire: firstName)
last_namestringLast name (wire: lastName)
organisation_namestringName of organisation (wire: organisationName)
accreditation_countrystringCountry of lawyer accreditation (AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, UNKNOWN, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW) (wire: accreditationCountry)
accreditation_organismstringOrganism of lawyer accreditation (wire: accreditationOrganism)
accreditation_yearintegerYear of lawyer accreditation (wire: accreditationYear)
addressobjectThe address of the contact
birth_citystringCity of birth (wire: birthCity)
birth_countrystringBirth Country (AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, UNKNOWN, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW) (wire: birthCountry)
birth_daystring (date)Birth date (wire: birthDay)
birth_zipstringBirth Zipcode (wire: birthZip)
cell_phonestring (phone-number)Cellphone number (wire: cellPhone)
company_national_identification_numberstringCompany National Identification Number (wire: companyNationalIdentificationNumber)
emailstringEmail address
faxstringFax number
genderstringGender (female, male)
inseestringINSEE identifier
languagestringLanguage (cs_CZ, de_DE, en_AU, en_CA, en_GB, en_IE, en_US, es_ES, fi_FI, fr_CA, fr_FR, fr_MA, fr_SN, fr_TN, it_IT, lt_LT, nl_NL, pl_PL, pt_PT)
legal_formstringLegal forms a nichandle can be registered as (administration, association, corporation, individual, other, personalcorporation) (wire: legalForm)
legal_form_categorystringcategory of legalForm (wire: legalFormCategory)
national_identification_numberstringNational Identification Number (wire: nationalIdentificationNumber)
nationalitystringNationality (AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, UNKNOWN, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW)
organisation_accountablestringTo whom is the organisation accountable (wire: organisationAccountable)
organisation_fundingstringWhat is the source of funding (wire: organisationFunding)
organisation_funding_otherstringExplain the source of funding if organisationFunding is other (wire: organisationFundingOther)
organisation_rolestringRole of your organisation (wire: organisationRole)
organisation_role_otherstringExplain the role of your organisation if organisationRole is other (wire: organisationRoleOther)
organisation_staff_statusstringStatus of the staff (wire: organisationStaffStatus)
organisation_staff_status_otherstringExplain the status of the staff if organisationStaffStatus is other (wire: organisationStaffStatusOther)
organisation_typestringtype of organisation (wire: organisationType)
organisation_type_otherstringExplain the type of organisation if organisationType is other (wire: organisationTypeOther)
phonestring (phone-number)Phone number
registrant_document_typestringType of registrant document (wire: registrantDocumentType)
registrant_document_type_otherstringExplain the type of registrant document if registrantDocumentType is other (wire: registrantDocumentTypeOther)
role_in_organisationstringThe role in the organisation (wire: roleInOrganisation)
vatstringVAT number
websitestringWebsite

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcontact_idGet details about a contact
listselectList all contacts
createinsertCreate a contact
updateupdatecontact_idUpdate a contact

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
contact_idintegerContact ID (wire: contactId)

SELECT examples​

Get details about a contact

SELECT
id,
accreditation_id,
enterprise_id,
trademark_id,
first_name,
last_name,
organisation_name,
accreditation_country,
accreditation_organism,
accreditation_year,
address,
birth_city,
birth_country,
birth_day,
birth_zip,
cell_phone,
company_national_identification_number,
email,
fax,
gender,
insee,
language,
legal_form,
legal_form_category,
national_identification_number,
nationality,
organisation_accountable,
organisation_funding,
organisation_funding_other,
organisation_role,
organisation_role_other,
organisation_staff_status,
organisation_staff_status_other,
organisation_type,
organisation_type_other,
phone,
registrant_document_type,
registrant_document_type_other,
role_in_organisation,
vat,
website
FROM ovh.domain.contacts
WHERE contact_id = '{{ contact_id }}' -- required
;

INSERT examples​

Create a contact

INSERT INTO ovh.domain.contacts (
accreditation_country,
accreditation_id,
accreditation_organism,
accreditation_year,
address,
birth_city,
birth_country,
birth_day,
birth_zip,
cell_phone,
company_national_identification_number,
email,
enterprise_id,
fax,
first_name,
gender,
insee,
language,
last_name,
legal_form,
legal_form_category,
national_identification_number,
nationality,
organisation_accountable,
organisation_funding,
organisation_funding_other,
organisation_name,
organisation_role,
organisation_role_other,
organisation_staff_status,
organisation_staff_status_other,
organisation_type,
organisation_type_other,
phone,
registrant_document_type,
registrant_document_type_other,
role_in_organisation,
trademark_id,
vat,
website
)
SELECT
'{{ accreditation_country }}',
'{{ accreditation_id }}',
'{{ accreditation_organism }}',
{{ accreditation_year }},
'{{ address }}',
'{{ birth_city }}',
'{{ birth_country }}',
'{{ birth_day }}',
'{{ birth_zip }}',
'{{ cell_phone }}',
'{{ company_national_identification_number }}',
'{{ email }}',
'{{ enterprise_id }}',
'{{ fax }}',
'{{ first_name }}',
'{{ gender }}',
'{{ insee }}',
'{{ language }}',
'{{ last_name }}',
'{{ legal_form }}',
'{{ legal_form_category }}',
'{{ national_identification_number }}',
'{{ nationality }}',
'{{ organisation_accountable }}',
'{{ organisation_funding }}',
'{{ organisation_funding_other }}',
'{{ organisation_name }}',
'{{ organisation_role }}',
'{{ organisation_role_other }}',
'{{ organisation_staff_status }}',
'{{ organisation_staff_status_other }}',
'{{ organisation_type }}',
'{{ organisation_type_other }}',
'{{ phone }}',
'{{ registrant_document_type }}',
'{{ registrant_document_type_other }}',
'{{ role_in_organisation }}',
'{{ trademark_id }}',
'{{ vat }}',
'{{ website }}'
RETURNING
id,
accreditation_id,
enterprise_id,
trademark_id,
first_name,
last_name,
organisation_name,
accreditation_country,
accreditation_organism,
accreditation_year,
address,
birth_city,
birth_country,
birth_day,
birth_zip,
cell_phone,
company_national_identification_number,
email,
fax,
gender,
insee,
language,
legal_form,
legal_form_category,
national_identification_number,
nationality,
organisation_accountable,
organisation_funding,
organisation_funding_other,
organisation_role,
organisation_role_other,
organisation_staff_status,
organisation_staff_status_other,
organisation_type,
organisation_type_other,
phone,
registrant_document_type,
registrant_document_type_other,
role_in_organisation,
vat,
website
;

UPDATE examples​

Update a contact

UPDATE ovh.domain.contacts
SET
accreditation_country = '{{ accreditation_country }}',
accreditation_id = '{{ accreditation_id }}',
accreditation_organism = '{{ accreditation_organism }}',
accreditation_year = {{ accreditation_year }},
address = '{{ address }}',
birth_city = '{{ birth_city }}',
birth_country = '{{ birth_country }}',
birth_day = '{{ birth_day }}',
birth_zip = '{{ birth_zip }}',
cell_phone = '{{ cell_phone }}',
company_national_identification_number = '{{ company_national_identification_number }}',
email = '{{ email }}',
enterprise_id = '{{ enterprise_id }}',
fax = '{{ fax }}',
first_name = '{{ first_name }}',
gender = '{{ gender }}',
insee = '{{ insee }}',
language = '{{ language }}',
last_name = '{{ last_name }}',
legal_form = '{{ legal_form }}',
legal_form_category = '{{ legal_form_category }}',
national_identification_number = '{{ national_identification_number }}',
nationality = '{{ nationality }}',
organisation_accountable = '{{ organisation_accountable }}',
organisation_funding = '{{ organisation_funding }}',
organisation_funding_other = '{{ organisation_funding_other }}',
organisation_name = '{{ organisation_name }}',
organisation_role = '{{ organisation_role }}',
organisation_role_other = '{{ organisation_role_other }}',
organisation_staff_status = '{{ organisation_staff_status }}',
organisation_staff_status_other = '{{ organisation_staff_status_other }}',
organisation_type = '{{ organisation_type }}',
organisation_type_other = '{{ organisation_type_other }}',
phone = '{{ phone }}',
registrant_document_type = '{{ registrant_document_type }}',
registrant_document_type_other = '{{ registrant_document_type_other }}',
role_in_organisation = '{{ role_in_organisation }}',
trademark_id = '{{ trademark_id }}',
vat = '{{ vat }}',
website = '{{ website }}'
WHERE
contact_id = '{{ contact_id }}' --required
RETURNING
id,
accreditation_id,
enterprise_id,
trademark_id,
first_name,
last_name,
organisation_name,
accreditation_country,
accreditation_organism,
accreditation_year,
address,
birth_city,
birth_country,
birth_day,
birth_zip,
cell_phone,
company_national_identification_number,
email,
fax,
gender,
insee,
language,
legal_form,
legal_form_category,
national_identification_number,
nationality,
organisation_accountable,
organisation_funding,
organisation_funding_other,
organisation_role,
organisation_role_other,
organisation_staff_status,
organisation_staff_status_other,
organisation_type,
organisation_type_other,
phone,
registrant_document_type,
registrant_document_type_other,
role_in_organisation,
vat,
website;