Updating contact profile picture

The API provides feature to update the contact profile picture using base64 string converted from an image(for more info about base64: https://en.wikipedia.org/wiki/Base64), the API works for both individual contact and organization contact, in order to update the contact profile picture pass the base 64 string along with file name and contact id in related to Id field.

Request Information

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.

Pass the profile picture object

NameDescriptionTypeAdditional information
FileName

string

None.

Data

string

None.

Id

integer

None.

RelatedToId

integer

None.

MergedWith_Or_Secondary_Id

integer

None.

MergeType

string

None.

SortOrder

integer

None.

Request Format

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

{
  "FileName": "String Parameter 1",
  "Data": "String Parameter 2",
  "Id": 3,
  "RelatedToId": 1,
  "MergedWith_Or_Secondary_Id": 1,
  "MergeType": "String Parameter 4",
  "SortOrder": 1
}

Update profile picture

Below is the sample to update the contact profile picture.

{
FileName:"profile.png",
Data:"[valid base64 image data]",
RelatedToId:9831292
}

Response Information

Resource Description

A Wrapped base64 string of the image.

ITypedResponseOfString
NameDescriptionTypeAdditional information
Result

string

None.

Category

string

None.

Response Formats

Sample not available.