contacts

Update a contact by ID

Update a single contact. Returns the updated contact. Omitting a top-level field in the request body will leave it unchanged.

patch/contacts/{id}

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/contacts/{id}
  • Auth: none declared

Path parameters

idstring required

ID of contact to update

Request body

firststring

The contact's first name

middlestring

The contact's middle name

laststring

The contact's last name

dobstring

Date of birth (YYYY-MM-DD)

Example request

{
  "first": "John",
  "last": "Doe",
  "dob": "1990-02-23",
  "address": {
    "id": "182c2e54-3494-4b85-aba5-038cf539d5bf"
  },
  "contactPoints": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf"
    }
  ]
}

Response

success

idstring
firststring
middlestring
laststring
dobstring

Date of birth

mrnstring

Ritten Medical Record Number (if applicable)

emailstring

The contact's primary email address. Falls back to their most recently added email when none is marked primary, and is omitted when they have none.

createdAtstring date-time

Contact record creation timestamp.

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "first": "John",
  "last": "Doe",
  "dob": "1990-02-23",
  "email": "john@example.com",
  "createdAt": "2024-01-01T00:00:00Z",
  "organizations": [
    {
      "id": "9a5e64b0-0a73-4cb5-ab32-44fea16da4e1",
      "name": "Sunrise Recovery Center",
      "relationshipType": "member"
    }
  ],
  "contactPoints": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf"
    }
  ],
  "address": {
    "id": "182c2e54-3494-4b85-aba5-038cf539d5bf"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.