Update Community Contact Information

PUT 
/community/:communityId/contact-details

Updates a community member’s contact information.

A community member can be either a person or a company. This API will update the contact information of the selected community member.

For a list of all country codes, go to Lookup - Country

For a list of all phone types, go to Lookup - Phone Type

For a list of all email types, go to Lookup - Email Type

For a list of all internet and social website types, go to Lookup - Website Type

Request

Path Parameters

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

application/json

Body

emailAddress object[]required
Array [
emailType objectnullablerequired
Lookup - Email Type
id uuidrequired
value stringrequired
default booleanrequired
]
phoneNumber object[]required
Array [
phoneType objectnullablerequired
Lookup - Phone Type
id uuidrequired
value stringrequired
Possible values: non-empty
Phone number
country objectnullablerequired
Lookup - Country
id uuidrequired
defaultSMS booleanrequired
preferred booleanrequired
confidential booleanrequired
]
internetAndSocialMedia object[]required
Array [
websiteType objectnullablerequired
Lookup - Website Type
id uuidrequired
value stringrequired
]

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
deceased booleannullable
Is this community member deceased?
emailAddress object[]nullable
List of the community member's email addresses
Array [
id uuid
UUID of the community member's email address record
emailType object
id
UUID of the email address type lookup
description
The email address type (e.g. Personal, Occupation, Company, etc)
value stringnullable
The community member's email address
default booleannullable
Is this the default email address?
sortOrder integernullable
]
internetAndSocialMedia object[]nullable
List of the community member's website/s and social media account/s
Array [
id uuid
UUID of the community member's website or social media account record
websiteType object
id
UUID for community website type lookup
description
The community website type (e.g. Facebook, LinkedIn, etc.)
value stringnullable
A URL to the website or social media account
sortOrder int32
Sort order for the website or social media account
]
phoneNumber object[]nullable
List of the community member's phone number/s
Array [
phoneType objectnullablerequired
id uuid
UUID of the phone contact type lookup
description string
The phone contact type (e.g. Home Phone, Personal Mobile, etc)
code string
The unique code indicating the phone contact type (e.g. PERSONALMOBILE)
value stringnullablerequired
Phone number
confidential booleanrequired
preferred booleanrequired
defaultSMS booleanrequired
Is this the default SMS number?
extension stringnullablerequired
Optional extension for the phone number
countryCode stringnullablerequired
The country calling code prefix for the phone number
country objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "deceased": true,
    "emailAddress": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "emailType": {},
        "value": "string",
        "default": true,
        "sortOrder": 0
      }
    ],
    "internetAndSocialMedia": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "websiteType": {},
        "value": "string",
        "sortOrder": 0
      }
    ],
    "phoneNumber": [
      {
        "phoneType": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        },
        "value": "string",
        "confidential": true,
        "preferred": true,
        "defaultSMS": true,
        "extension": "string",
        "countryCode": "string",
        "country": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        }
      }
    ]
  }
}

Successful

{
  "emailAddress": [
    {
      "id": "cde10b05-8d55-4b3a-802e-b3521aa1c540",
      "emailType": {
        "id": "49d3866a-c15a-40a1-809f-7bd03362736f",
        "description": "Personal"
      },
      "value": "personal@gmail.com",
      "sortOrder": 1,
      "default": true
    }
  ],
  "internetAndSocialMedia": [
    {
      "id": "f7e62b7a-bb2c-4582-9331-46524d8f993a",
      "websiteType": {
        "id": "8c42afd1-9081-46b2-954b-2bd52d449edb",
        "description": "Facebook"
      },
      "value": "www.facebook.com/myprofileurl",
      "sortOrder": 1
    },
    {
      "id": "fbaaa918-3180-4259-b0c1-af5c1a29995a",
      "websiteType": {
        "id": "c72569ae-83e4-4da7-a86c-c4269727f0d1",
        "description": "LinkedIn"
      },
      "value": "www.linkedin.com/in/thisismyprofile",
      "sortOrder": 4
    }
  ],
  "phoneNumber": [
    {
      "id": "ec17d7c5-c21d-40a9-a7c5-4c65ef4bc749",
      "lookup": {
        "id": "98c06b1f-c7d6-43e4-8f01-2311000bf679",
        "description": "Personal mobile"
      },
      "value": "0412345678",
      "confidential": false,
      "countryCode": "AU +61",
      "country": {
        "id": "283a7817-5c27-48bb-9650-4ccfa11a3704",
        "description": "Australia",
        "code": "AU"
      },
      "preferred": true,
      "defaultSMS": true,
      "extension": null,
      "sortOrder": 1
    }
  ],
  "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...