Create Contacts

Creates a new contact.

Resource Information

Scope	contacts Deprecated scope name: create_contacts
App Type	All
Authorization Type	Access token
URI	/v4/contacts?lang={lang}
HTTP Method	POST
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
lang	String	No	�	Indicates the language applied.	7.3.2
address	address{}	No	�	The citizen user's address.	7.3.2
address.addressLine1	string	No	�	The first line of the address.	7.3.2
address.addressLine2	string	No	�	The second line of the address.	7.3.2
address.addressLine3	string	No	�	The third line of the address.	7.3.2
address.city	string	No	�	The name of the city.	7.3.2
address.country	address.country{}	No	Get All Address Countries	The name of the country.	7.3.2
address.country.text	string	No	�	The localized display text.	7.3.2
address.country.value	string	No	�	The value for the specified parameter.	7.3.2
address.postalCode	string	No	�	The postal ZIP code for the address.	7.3.2
address.state	address.state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.2
address.state.text	string	No	�	The localized display text.	7.3.2
address.state.value	string	No	�	The value for the specified parameter.	7.3.2
birthCity	birthCity{}	No	�	The city of birth for an individual.	7.3.2
birthCity.text	string	No	�	The localized display text.	7.3.2
birthCity.value	string	No	�	The value for the specified parameter.	7.3.2
birthDate	dateTime	No	�	The birth date of an individual.	7.3.2
birthRegion	birthRegion{}	No	�	The country of birth or region of birth for an individual.	7.3.2
birthRegion.text	string	No	�	The localized display text.	7.3.2
birthRegion.value	string	No	�	The value for the specified parameter.	7.3.2
birthState	birthState{}	No	Get All Address States	The state of birth for an individual.	7.3.2
birthState.text	string	No	�	The localized display text.	7.3.2
birthState.value	string	No	�	The value for the specified parameter.	7.3.2
businessName	string	No	�	A secondary business name for the applicable individual.	7.3.2
comment	string	No	�	Comments or notes about the current context.	7.3.2
deceasedDate	dateTime	No	�	The date of death. This field is active only when the Contact Type selected is Individual.	7.3.2
driverLicenseNumber	string	No	�	The driver's license number of the contact. This field is active only when the Contact Type selected is Individual.	7.3.2
driverLicenseState	driverLicenseState{}	No	Get All Address States	The state that issued the driver's license.	7.3.2
driverLicenseState.text	string	No	�	The localized display text.	7.3.2
driverLicenseState.value	string	No	�	The value for the specified parameter.	7.3.2
email	string	No	�	The contact's email address.	7.3.2
fax	string	No	�	The fax number for the contact.	7.3.2
faxCountryCode	string	No	�	Fax Number Country Code	7.3.2
federalEmployerId	string	No	�	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.2
firstName	string	No	�	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
fullName	string	No	�	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.2
gender	gender{}	No	�	The gender (male or female) of the individual.	7.3.2
gender.text	string	No	�	The localized display text.	7.3.2
gender.value	string	No	�	The value for the specified parameter.	7.3.2
id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
individualOrOrganization	string	No	�	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.2
lastName	string	No	�	The last name (surname).	7.3.2
middleName	string	No	�	The middle name.	7.3.2
organizationName	string	No	�	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.2
passportNumber	string	No	�	The contact's passport number. This field is only active when the Contact Type selected is Individual.	7.3.2
phone1	string	No	�	The primary telephone number of the contact.	7.3.2
phone1CountryCode	string	No	�	Phone Number 1 Country Code	7.3.2
phone2	string	No	�	The secondary telephone number of the contact.	7.3.2
phone2CountryCode	string	No	�	Phone Number 2 Country Code	7.3.2
phone3	string	No	�	The tertiary telephone number for the contact.	7.3.2
phone3CountryCode	string	No	�	Phone Number 3 Country Code	7.3.2
postOfficeBox	string	No	�	The post office box number.	7.3.2
preferredChannel	preferredChannel{}	No	Get All Contact Preferred Channels	The method by which the contact prefers to be notified, by phone for example.	7.3.2
preferredChannel.text	string	No	�	The localized display text.	7.3.2
preferredChannel.value	string	No	�	The value for the specified parameter.	7.3.2
race	race{}	No	Get All Contact Races	The contact's race/ethnicity.	7.3.2
race.text	string	No	�	The localized display text.	7.3.2
race.value	string	No	�	The value for the specified parameter.	7.3.2
relation	relation{}	No	�	The contact's relationship to the application or service request.	7.3.2
relation.text	string	No	�	The localized display text.	7.3.2
relation.value	string	No	�	The value for the specified parameter.	7.3.2
salutation	salutation{}	No	Get All Contact Salutations	The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.	7.3.2
salutation.text	string	No	�	The localized display text.	7.3.2
salutation.value	string	No	�	The value for the specified parameter.	7.3.2
serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
socialSecurityNumber	string	No	�	The individual's social security number. This field is only active when the Contact Type selected is Individual.	7.3.2
stateIdNumber	string	No	�	The contact's state ID number. This field is only active when the Contact Type selected is Individual.	7.3.2
status	status{}	No	�	The contact status.	7.3.2
status.text	string	No	�	The localized display text.	7.3.2
status.value	string	No	�	The value for the specified parameter.	7.3.2
suffix	string	No	�	The contact name suffix.	7.3.2
title	string	No	�	The individual's business title.	7.3.2
tradeName	string	No	�	The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.	7.3.2
type	type{}	No	Get All Contact Types	The type of people to contact.	7.3.2
type.text	string	No	�	The localized display text.	7.3.2
type.value	string	No	�	The value for the specified parameter.	7.3.2

Example

Sample Request Body

[{"email":"apitester@accela.com","individualOrOrganization":"individual","phone1":"9256593200","firstName":"API","lastName":"Tester","type":{"value":"Individual","text":"Individual"},"preferredChannel":{"value":"1","text":"Email"},"status":{"value":"A","t

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.code	string	A code identifying an associated item	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isSuccess	boolean	Indicates whether or not the operation on the item is successful.	7.3.2
result.message	string	A text message related to the operation.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "253",
      "isSuccess": true
    }
  ]
}