Update Community Personal Information

PUT 
/community/:communityId/personal-info

Updates a community member’s personal or company information.

A community member can be either a person or a company. This API will update the personal information or company information of the selected community member, based on their record type.

For a list of all titles, go to Lookup - Title

For a list of all genders, go to Lookup - Gender

The following fields are auto generated using community configurations. If they are set to null, then the system will auto generate the fields. Set this field only when you want to override the system generated fields:

1. displayName
2. displayNameForList
3. externalNameFormat
4. familyNameFormat
5. internalNameFormat
6. legalNameFormat
7. mailNameFormat
8. mailNameJoint
9. salutationFormat
10. salutationJoint
11. salutationPreferredFormat
12. salutationPreferredJoint

Request

Path Parameters

communityId uuidrequired
Community id
Example: 46cb5481-6e20-4f17-b947-db81cdce9a4f

application/json

Body

oneOf
PersonalInfoRequestDto
type stringrequired
Possible values: [Person]
schoolId stringrequired
Possible values: non-empty
givenName stringrequired
Possible values: non-empty
surname stringnullablerequired
otherGivenName stringnullablerequired
prefName stringnullablerequired
title objectnullablerequired
Lookup - Title
id uuidrequired
birthDate datenullablerequired
gender objectnullablerequired
Lookup - Gender
id uuidrequired
deceasedDate datenullablerequired
The deceased date property for a community member can only be set if they are not linked with a spouse.
deceased booleanrequired
The deceased property for a community member can only be set if they are not linked with a spouse.
overrideLegalSurname stringnullablerequired
nameSuffix stringnullablerequired
maidenName stringnullablerequired
familyNamePrevious stringnullablerequired
displayName stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
displayNameForList stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
mailNameFormat stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
externalNameFormat stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
legalNameFormat stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
salutationFormat stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
familyNameFormat stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
salutationJoint stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
salutationPreferredFormat stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
salutationPreferredJoint stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
internalNameFormat stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
mailNameJoint stringnullablerequired
This field is auto generated using community configurations. If this is set to null, then the system will auto generate it. Set this field only when you want to override the system generated fields.
CompanyInfoRequestDto
type stringrequired
Possible values: [Company]
schoolId stringrequired
Possible values: non-empty
companyName stringrequired
Possible values: non-empty
companyAttention stringnullablerequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
oneOf
CompanyInfoDto
schoolId stringrequired
companyName stringrequired
companyAttention stringnullablerequired
CommunityPersonalInfoDto
spouseCommunityId uuidnullablerequired
schoolId stringrequired
givenName stringrequired
surname stringnullablerequired
prefName stringnullablerequired
otherGivenName stringnullablerequired
nameSuffix stringnullablerequired
overrideLegalSurname stringnullablerequired
overrideMailFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationPreferredFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
familyNamePrevious stringnullablerequired
maidenName stringnullablerequired
isPrimary booleanrequired
initials stringrequired
title objectnullablerequired
id stringnullablerequired
description stringnullablerequired
displayName stringrequired
displayNameForList stringrequired
birthDate daterequired
gender objectnullablerequired
id stringnullablerequired
description stringnullablerequired
deceasedDate datenullablerequired
deceased booleanrequired

Example (from schema)

{
  "code": "OK",
  "data": {
    "schoolId": "string",
    "companyName": "string",
    "companyAttention": "string"
  }
}

Company

{
  "schoolId": "101",
  "companyName": "Honda corp.",
  "companyAttention": "CEO"
}

Person

{
  "spouseCommunityId": "ef1cfa9c-af9d-461d-9a62-7404633cb441",
  "schoolId": "100",
  "givenName": "Jane",
  "surname": "Abbot",
  "prefName": "Jane",
  "otherGivenName": null,
  "nameSuffix": null,
  "overrideLegalSurname": null,
  "overrideMailFormat": null,
  "overrideSalutationFormat": null,
  "overrideSalutationPreferredFormat": null,
  "familyNamePrevious": null,
  "maidenName": null,
  "isPrimary": false,
  "initials": "JA",
  "title": {
    "id": "f54c7b12-67dd-41ba-9e2d-4261bef2bb57",
    "description": "Ms"
  },
  "displayName": "ABBOT Ms Jane",
  "displayNameForList": "ABBOT Jane",
  "birthDate": "1978-09-17",
  "gender": {
    "id": "f54b66eb-bcc0-48f5-99e4-21e561c1ff13",
    "description": "Female"
  },
  "deceasedDate": null,
  "deceased": false
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...