contacts

Update

Partial update of the caller's own contact. custom_wallet_address may only be set/cleared on a CUSTOM contact — 400 on a linked one, whose payable address is always that account's own active wallet. For both custom_wallet_address and custom_avatar_url, send "" to explicitly clear the field; omit it to leave the stored value unchanged.

put/contacts/{id}

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/contacts/{id}
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Path parameters

idstring required

id

Request body

activeboolean
blacklistedboolean
custom_avatar_urlstring

CustomAvatarURL replaces the picture override. Send "" to CLEAR it, which falls a linked contact back to that person's own profile picture; omit the field to leave it unchanged.

custom_emailstring
custom_first_namestring
custom_last_namestring
custom_phone_numberstring
custom_wallet_addressstring

CustomWalletAddress registers the pay-to wallet on a CUSTOM contact — the act that makes the contact payable, since send destinations derive from the address book. Send "" to CLEAR it, which revokes that permission; omit to leave unchanged. Rejected (400) on a linked contact, whose address is their own account's active wallet.

descriptionstring
namestring

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

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