Updating profile for an organization

The API provides feature to update contact profile which includes name, website, no of employees, year founded and contact info, 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
organizationId

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
OrganizationName

The Organization Name

string

Required

String length: inclusive between 0 and 510

WebsiteUrl

Website URL of the Organization

string

String length: inclusive between 0 and 510

NoOfEmployees

No. of Employees in the Organization

integer

None.

YearFounded

Specify the Year Founded

integer

None.

JobContactInfo

The Job-Contact Information of the Organization-Employee

JobContact

None.

ContactSourceId

integer

None.

PrimaryNonProfitContactId

integer

None.

Request Format

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

{
  "OrganizationName": "String Parameter 1",
  "WebsiteUrl": "String Parameter 2",
  "NoOfEmployees": 1,
  "YearFounded": 1,
  "JobContactInfo": {
    "JobTitle": "String Parameter 1",
    "ContactFor": "String Parameter 2"
  },
  "ContactSourceId": 1,
  "PrimaryNonProfitContactId": 1
}

Updating the profile

In order to update the contact profile, pass name, website, no of employees, year founded and contact info along with the contact Id in URL, below is the sample:

{
  "OrganizationName": "Vinayak Media",
  "WebsiteUrl": "http://www.vinayakarts.com",
  "NoOfEmployees": 10,
  "YearFounded": 2005,
  "JobContactInfo": {
    "JobTitle": "Owner",
    "ContactFor": "James Anderson"
  }
}

and request as:
admin/contact/update/profile/organization/9856826

Response Information

Resource Description

ITypedResponseOfString
NameDescriptionTypeAdditional information
Result

string

None.

Category

string

None.

Response Formats

Sample not available.