Updating profile for an Individual

The API provides feature to update contact profile which includes first name, last name, middle name, birth date, nick name, prefix, suffix, gender and source of contact, the API expects the contact id in URL.

Request Information

URI Parameters

In order to make a call integrate the below parameters into Url while calling the API from an integration.

NameDescriptionTypeAdditional information
contactId

integer

Required

Body Parameters

Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.

NameDescriptionTypeAdditional information
FirstName

First Name of the Individual

string

Required

String length: inclusive between 0 and 510

MiddleName

string

String length: inclusive between 0 and 510

LastName

string

Required

String length: inclusive between 0 and 510

BirthDate

Birthdate of Individual.

date

None.

NickName

Nick name for Individual

string

String length: inclusive between 0 and 100

PrefixId

Prefix Id of the Indivdiual

integer

None.

SuffixId

Suffix ID of the Individual

integer

None.

GenderId

Gender Id of the Individual

integer

None.

ContactSourceId

Gets or sets the contact source identifier.

integer

None.

Request Format

Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.

{
  "FirstName": "String Parameter 1",
  "MiddleName": "String Parameter 2",
  "LastName": "String Parameter 3",
  "BirthDate": "2024/08/31 13:34:11",
  "NickName": "String Parameter 4",
  "PrefixId": 1,
  "SuffixId": 1,
  "GenderId": 1,
  "ContactSourceId": 1
}

Updating the profile

In order to update the contact profile, pass first name, last name, middle name, birth date, nick name, prefix, suffix, gender and source of contact along with the contact Id in URL, below is the sample:

{
  "FirstName": "Keaton",
  "MiddleName": "Ray",
  "LastName": "Jennings",
  "BirthDate": "1992/12/08 13:53:32",
  "NickName": "Kea",
  "PrefixId": 23,
  "SuffixId": 160,
  "GenderId": 1,
  "ContactSourceId": 2
}

and request as:

admin/contact/update/profile/individual/9856828

Response Information

Resource Description

ITypedResponseOfString
NameDescriptionTypeAdditional information
Result

string

None.

Category

string

None.

Response Formats

Sample not available.