Skip to main content
POST
Error

Path Parameters

id
string
required

Body

application/x-www-form-urlencoded
confirmation_channel
string
required
notes
string

Response

OK

id
string
required
active
boolean
required
address
string
required
authorization_form
object
required
can_be_revoked
boolean
required
channel
enum<string>
required
Available options:
fax,
email,
mail,
portal
confirmation_channel
enum<string>
required
Available options:
phone_call,
email_response,
portal_check,
in_person,
other
confirmation_notes
string | null
required
confirmation_required
boolean
required
confirmation_retry_count
integer
required
confirmed_at
string
required
created_at
string
required
cross_channel_confirmation
boolean
required
days_until_expiration
integer | null
required
delivered_at
string | null
required
expired
boolean
required
expires_at
string | null
required
expiring_soon
boolean
required
external_id
string
required
form_type
string
required
meets_requirement
boolean
required
metadata
object
required
recipient_name
string
required
recipient_type
string
required
revocation_discovered_via
enum<string> | null
required
Available options:
phone_call,
email_response,
portal_check,
in_person,
other
revocation_reason
string | null
required
revoked_at
string | null
required
sent_at
string
required
status
enum<string>
required
Available options:
pending,
sent,
delivered,
confirmed,
failed,
expired,
revoked
suggested_follow_up_date
string | null
required
updated_at
string
required