Skip to main content
POST
/
create
/
contact
Create contact
curl --request POST \
  --url https://staging-api.usetyms.com/v1/adam/create/contact \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Acme Supplies Ltd",
  "type": "vendor",
  "business_name": "Acme Supplies Limited",
  "email": "billing@acmesupplies.example",
  "phone": "+2348012345678",
  "address": "12 Industrial Avenue, Lagos",
  "tax_id": "RC-123456",
  "country": "NG",
  "contact_number": "VND-0091",
  "payment_terms": 14,
  "receivable_account": "Accounts Receivable",
  "payable_account": "Accounts Payable",
  "opening_balance": 0
}
'
import requests

url = "https://staging-api.usetyms.com/v1/adam/create/contact"

payload = {
"name": "Acme Supplies Ltd",
"type": "vendor",
"business_name": "Acme Supplies Limited",
"email": "billing@acmesupplies.example",
"phone": "+2348012345678",
"address": "12 Industrial Avenue, Lagos",
"tax_id": "RC-123456",
"country": "NG",
"contact_number": "VND-0091",
"payment_terms": 14,
"receivable_account": "Accounts Receivable",
"payable_account": "Accounts Payable",
"opening_balance": 0
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Supplies Ltd',
type: 'vendor',
business_name: 'Acme Supplies Limited',
email: 'billing@acmesupplies.example',
phone: '+2348012345678',
address: '12 Industrial Avenue, Lagos',
tax_id: 'RC-123456',
country: 'NG',
contact_number: 'VND-0091',
payment_terms: 14,
receivable_account: 'Accounts Receivable',
payable_account: 'Accounts Payable',
opening_balance: 0
})
};

fetch('https://staging-api.usetyms.com/v1/adam/create/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "status": "success",
  "message": "Contacts imported successfully",
  "data": {
    "imported": 1,
    "contacts": [
      {
        "uuid": "v8e7d6c5b4a3418290f0e9d8c7b6a5947",
        "name": "Acme Supplies Ltd",
        "type": "vendor"
      }
    ]
  }
}
{
"status": "failed",
"message": "<string>"
}

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Body

application/json
name
string
required

Contact display name.

type
enum<string>
Available options:
customer,
vendor,
both
email
string

Used to match existing contacts.

phone
string
business_name
string
address
string
tax_id
string
country
string
contact_number
string
payment_terms
number
receivable_account
string
payable_account
string
opening_balance
number
opening_balance_date
string<date>
opening_balance_exchange_rate
number

Response

Contact created

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.