Update a sub-entity

Rename or flip the hipaa_enabled flag. Flipping hipaa_enabled=false on an org with enrolled reputation numbers that require BAA coverage will surface a warning but succeed — audit the downstream state after.

PATCH /v1/sub-entities/{id}

Update a sub-entity

cURL

curl --request PATCH \
  --url https://api.revdesk.com/v1/sub-entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "hipaa_enabled": true
}
'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "parent_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "hipaa_enabled": true,
    "member_count": 123,
    "phone_number_count": 123,
    "created_at": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string

UUID — when present, deduplicates repeat submissions. See /api-reference/idempotency.

Path Parameters

id · string · required

Body

application/json

name · string

Required string length: 1 - 128

hipaa_enabled · boolean

Response

200

application/json

Success

data · object · required

Show child attributes