Update Authorization¶

Partially update an existing authorization record. Send only the fields that need to change; omitted fields retain their current values.

Endpoint¶

POST /apis/soap-enrichment/v1/authorization/{authorizationId}

Path Parameters¶

Parameter	Type	Required	Description
`authorizationId`	string	Yes	The unique ID of the authorization record to update

Request Body¶

All fields are optional. Include only the ones you want to change.

Parameter	Type	Description
`authorization_reference_number`	string	Reference number issued by the payer
`plan_start_date`	string (datetime)	Insurance plan start date (`YYYY-MM-DDTHH:mm:ss`)
`plan_end_date`	string (datetime)	Insurance plan end date (`YYYY-MM-DDTHH:mm:ss`)
`effective_start_date`	string (datetime)	Authorization effective start date
`effective_end_date`	string (datetime)	Authorization effective end date
`insurance_payer`	object	Payer details (see Insurance Payer Object)
`authorized_visit_count`	integer	Total number of visits authorized
`current_visit_count`	integer	Visits consumed in the current period
`previous_consumed_visit_count`	integer	Visits consumed in prior periods
`phone_number`	string	Payer contact phone number
`fax_number`	string	Payer contact fax number
`comments`	string	Free-text notes
`authorization_status`	string	`ACTIVE`, `INACTIVE`, or `EXPIRED`
`icd_codes`	array	ICD-10 codes covered by this authorization (replaces entire list)
`cpt_code_authorization_details`	array	Per-CPT-code limits (replaces entire list)

Request¶

curl --location '{base_url}/apis/soap-enrichment/v1/authorization/auth_69cd0c97abc123' \
  --header 'Authorization: Bearer JWT_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "authorized_visit_count": 30,
    "comments": "Extended authorization — additional 10 visits approved",
    "effective_end_date": "2026-10-01T00:00:00",
    "authorization_status": "ACTIVE"
  }'

Response¶

Success Response¶

Code: 200 OK

{
  "code": 2000,
  "data": {
    "authorization_id": "auth_69cd0c97abc123",
    "authorization_reference_number": "AUTH-2026-001",
    "spry_case_id": "SPRY_CASE_69cd0c97e7562d613ea89bc7",
    "case_title": "Stable Burst Fracture",
    "plan_start_date": "2026-04-01T00:00:00",
    "plan_end_date": "2026-07-01T00:00:00",
    "effective_start_date": "2026-04-01T00:00:00",
    "effective_end_date": "2026-10-01T00:00:00",
    "insurance_payer": {
      "payer_reg_id": 2207,
      "name": "PEHP - Utah Public Employee Health Plan",
      "payer_id": "SX106",
      "payer_type": "COMMERCIAL"
    },
    "authorized_visit_count": 30,
    "current_visit_count": 5,
    "previous_consumed_visit_count": 0,
    "final_consumed_visit_count": 5,
    "phone_number": "8015551234",
    "fax_number": "8015555678",
    "comments": "Extended authorization — additional 10 visits approved",
    "authorization_status": "ACTIVE",
    "patient_id": 1172416,
    "patient_name": "John Doe",
    "organisation_id": 638,
    "clinic_id": 101,
    "icd_codes": [],
    "cpt_code_authorization_details": [],
    "created_at": "2026-04-01T12:00:00",
    "updated_at": "2026-04-15T10:00:00",
    "created_date": "2026-04-01T12:00:00Z"
  },
  "message": "Success"
}

Response Fields¶

Same fields as Get Authorization.

Error Response¶

Code: 200 OK

{
  "code": 4004,
  "data": null,
  "message": "Authorization not found"
}

Notes¶

Replacing icd_codes or cpt_code_authorization_details replaces the entire list — pass the complete desired set, not just additions.
authorization_status transitions: set to EXPIRED when the authorization period has passed, or INACTIVE to disable without expiring.