Accounts

Update account name or settings

name is required: an omitted or empty value is refused with 422 VALIDATION_ERROR.

Requires account:m.

patch/v1/accounts/{id}

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/accounts/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Request body

namestring

Required.

Response

The updated account.

idstring required
namestring required
emailstring required
stripe_customer_idstring nullable required
email_verified_atstring date-time nullable required
status'PENDING_PAYMENT' | 'ACTIVE' | 'SUSPENDED' | 'CLOSED' required
balance_centsinteger required

Credit balance in cents CAD.

verified_phonestring nullable required
phone_verified_atstring date-time nullable required
email_undeliverableboolean required

True when platform email to this address is bouncing or being marked as spam.

email_undeliverable_atstring date-time nullable required

The bounce or complaint that made the address unreachable.

email_undeliverable_reasonstring nullable required

BOUNCE or COMPLAINT.

terms_accepted_atstring date-time nullable required

When the owner accepted the Terms of Service and Privacy Policy.

terms_versionstring nullable required

The Terms version (last-updated date) that was accepted.

created_atstring date-time required

Changes

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