Add Contact

post

https://sandbox-api.getbrass.co/contacts

Add a new contact record

Query Params

include

string

Optional comma-separated list of relationships to include

Body Params

tag

string

required

Resource id of the contact tag to apply on the record

bank

string

required

Resource id of the bank for the receiving account of this contact

account_number

string

required

The NUBAN account number for the contact's receiving account

name

string

required

The name on the contact's receiving account. You can get this by calling the "Resolve Name on Account" endpoint

alias

string

A custom name for the contact - the record is also searchable by this alias

string

Contact email address for the contact

phone

string

Contact phone number for the contact

Headers

Authorization

string

required

Defaults to Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhdXRoLmdldGJyYXNzLmNvIiwiZXhwIjoxNjA4ODkwMzY2LCJpYXQiOjE2MDg4ODY3NjYsIm5iZiI6MTYwODg4Njc2NiwiYXBpX2NsaWVudCI6ImFwcF82OEQ0eTJ3d1V0aENNV3BrTXZ5WjRZIiwiY3VzdG9tZXIiOiJjdXNfMUdkbDNjQzE0eTZuVU9veE9QaFBjeiIsInVzZXIiOiJ1c3JfdndyVnNIckh3cnluWE85c01yZHB4In0.kfovIfs42zECgTC3k2wLh3gTq8mYN-nU9aL13U-EJZ_fN1GHd1N8Tid2vpF-ZJ-UwUdEKc2eFJjfe94u_NFIE1vs1Gh-Wr-kzC3OY5X4ADesPEQ1OFPsBknnQmMpE8-KHydza_V19eetgClhX8YytWuFNGBByLPYtD5h2Fw-FCk

An auth level 2 token to authorize the call

Response

Language

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200