Update contact name

Update safe contact metadata.

PATCH /api/v1/user/contacts/{contact_id}

Update contact name

cURL

curl --request PATCH \
  --url https://api.hevn.finance/api/v1/user/contacts/{contact_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "walletAddress": "<string>",
  "chainId": "<string>",
  "currency": "<string>",
  "address": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  }
}
'

import requests

url = "https://api.hevn.finance/api/v1/user/contacts/{contact_id}"

payload = {
    "name": "<string>",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "walletAddress": "<string>",
    "chainId": "<string>",
    "currency": "<string>",
    "address": {
        "streetAddress": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    walletAddress: '<string>',
    chainId: '<string>',
    currency: '<string>',
    address: {
      streetAddress: '<string>',
      addressLine2: '<string>',
      city: '<string>',
      state: '<string>',
      zip: '<string>'
    }
  })
};

fetch('https://api.hevn.finance/api/v1/user/contacts/{contact_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Path Parameters

contact_id · string<uuid> · required

Body

application/json

Request to update a contact.

name · string | null

Required string length: 1 - 200

userId · string<uuid> | null

walletAddress · string | null

chainId · string | null

currency · string | null

Required string length: 3

priorityMethod · enum<string> | null

Transaction type - payment rail.

Includes all FiatPaymentType values (sepa/swift/ach/uaefts) plus extended fiat variants (wire/swift-usd/swift-eur/fedwire/pix) and non-fiat rails (crypto/card/internal/refund).

Available options: sepa, swift, ach, uaefts, fedwire, swift-usd, swift-eur, wire, pix, crypto, card, internal, refund

address · UserAddress · object | null

Address schema for user.

Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.

Show child attributes

relationship · enum<string> | null

Relationship between the current user and the contact.

Available options: self, external

Response

200

application/json

Successful Response