Skip to main content
POST
/
inventory
/
members
/
update-status
Update Status
curl --request POST \
  --url https://api.decodahealth.com/inventory/members/update-status \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "memberId": "<string>",
  "comment": "<string>",
  "unfreezeDate": "2023-11-07T05:31:56Z"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Body

application/json
​
memberId
string
required

ID of the member to update the status for

​
status
enum<string>
required

New status for the member

Available options:
ACTIVE,
EXPIRED,
CANCELLED,
DELINQUENT,
FROZEN
​
comment
string | null

Comment explaining the status change

​
unfreezeDate
string<date-time> | null

When to automatically unfreeze the membership (only for FROZEN status)

Response

Successful Response