Skip to main content
POST
/
contact
Create Contact
curl --request POST \
  --url https://api.dev.uselevers.com/api-service/v1/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "nameAr": "<string>",
  "firstName": "<string>",
  "firstNameAr": "<string>",
  "lastName": "<string>",
  "lastNameAr": "<string>",
  "phoneNumber": "<string>",
  "vatNumber": "<string>",
  "email": "[email protected]",
  "building": "<string>",
  "buildingAr": "<string>",
  "street": "<string>",
  "streetAr": "<string>",
  "district": "<string>",
  "districtAr": "<string>",
  "city": "<string>",
  "cityAr": "<string>",
  "country": "<string>",
  "countryAr": "<string>",
  "postalCode": "<string>",
  "additionalNumber": "<string>",
  "otherId": "<string>",
  "bankName": "<string>",
  "bankContactName": "<string>",
  "iban": "<string>",
  "accountNumber": "<string>",
  "emailTone": "FRIENDLY",
  "sendEmailNotif": true,
  "sendEmailNotifLang": "ENGLISH",
  "sendSmsNotif": true,
  "sendSmsNotifLang": "ENGLISH",
  "remindersEnabled": true,
  "extPlatformId": "<string>",
  "extCompanyId": "<string>",
  "hasErrors": true,
  "errorDetail": {},
  "secondaryContacts": [
    {
      "name": "<string>",
      "nameAr": "<string>",
      "firstName": "<string>",
      "firstNameAr": "<string>",
      "lastName": "<string>",
      "lastNameAr": "<string>",
      "phoneNumber": "<string>",
      "vatNumber": "<string>",
      "email": "[email protected]",
      "building": "<string>",
      "buildingAr": "<string>",
      "street": "<string>",
      "streetAr": "<string>",
      "district": "<string>",
      "districtAr": "<string>",
      "city": "<string>",
      "cityAr": "<string>",
      "country": "<string>",
      "countryAr": "<string>",
      "postalCode": "<string>",
      "additionalNumber": "<string>",
      "otherId": "<string>",
      "bankName": "<string>",
      "bankContactName": "<string>",
      "iban": "<string>",
      "accountNumber": "<string>",
      "emailTone": "FRIENDLY",
      "sendEmailNotif": true,
      "sendEmailNotifLang": "ENGLISH",
      "sendSmsNotif": true,
      "sendSmsNotifLang": "ENGLISH",
      "remindersEnabled": true,
      "extPlatformId": "<string>",
      "extCompanyId": "<string>",
      "hasErrors": true,
      "errorDetail": {},
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "role": "PRIMARY",
  "paymentInstructions": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customFields": [
    "<unknown>"
  ]
}
'
{
  "name": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nameAr": "<string>",
  "firstName": "<string>",
  "firstNameAr": "<string>",
  "lastName": "<string>",
  "lastNameAr": "<string>",
  "phoneNumber": "<string>",
  "vatNumber": "<string>",
  "email": "[email protected]",
  "building": "<string>",
  "buildingAr": "<string>",
  "street": "<string>",
  "streetAr": "<string>",
  "district": "<string>",
  "districtAr": "<string>",
  "city": "<string>",
  "cityAr": "<string>",
  "country": "<string>",
  "countryAr": "<string>",
  "postalCode": "<string>",
  "additionalNumber": "<string>",
  "otherId": "<string>",
  "bankName": "<string>",
  "bankContactName": "<string>",
  "iban": "<string>",
  "accountNumber": "<string>",
  "emailTone": "FRIENDLY",
  "sendEmailNotif": true,
  "sendEmailNotifLang": "ENGLISH",
  "sendSmsNotif": true,
  "sendSmsNotifLang": "ENGLISH",
  "remindersEnabled": true,
  "extPlatformId": "<string>",
  "extCompanyId": "<string>",
  "hasErrors": true,
  "errorDetail": {},
  "totalAmount": 123,
  "totalPaid": 123,
  "outstandingAmount": 123,
  "totalInvoices": 123,
  "countUnpaidInvoices": 123,
  "risk": "LOW",
  "role": "PRIMARY",
  "secondaryContacts": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>"
    }
  ],
  "paymentInstructions": {
    "bankName": "<string>",
    "iban": "<string>",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bankAddress": "<string>",
    "accountNumber": "<string>",
    "bankCompanyName": "<string>",
    "bankCompanyAddress": "<string>"
  },
  "workflow": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "customFields": [
    "<unknown>"
  ],
  "promiseToPayDate": "2023-12-25",
  "promiseToPaySwitchWorkflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reminderStatus": "<string>",
  "reminderLabel": "<string>"
}

​
Authorization

All endpoints require Bearer token authentication.
HeaderTypeRequiredDescription
AuthorizationstringYesBearer authentication header of the form Bearer <token>

​
Getting Your API Key

See the Quickstart guide for instructions on obtaining your API credentials.

​
Request Body

ParameterTypeRequiredDescription
namestringYesContact name (max 255 characters)
emailstringNoContact email address
phoneNumberstringNoContact phone number
buildingstringNoBuilding name/address
streetstringNoStreet address
districtstringNoDistrict
citystringNoCity
countrystringNoCountry
postalCodestringNoPostal code
vatNumberstringNoVAT number
ibanstringNoIBAN for bank transfers
accountNumberstringNoBank account number
bankNamestringNoBank name
remindersEnabledbooleanNoEnable payment reminders (default: true)
sendEmailNotifbooleanNoSend email notifications
sendSmsNotifbooleanNoSend SMS notifications
genderstringNoGender: male or female
customFieldsarrayNoCustom field key-value pairs
secondaryContactsarrayNoArray of secondary contact objects

​
Bilingual Support

The API supports Arabic translations for address fields. Use the Ar suffix for Arabic values:
  • nameAr, firstNameAr, lastNameAr
  • buildingAr, streetAr, districtAr, cityAr, countryAr

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
nameAr
string
Required string length: 1 - 255
​
firstName
string
Required string length: 1 - 255
​
firstNameAr
string
Required string length: 1 - 255
​
lastName
string
Required string length: 1 - 255
​
lastNameAr
string
Required string length: 1 - 255
​
phoneNumber
string
Required string length: 1 - 255
​
vatNumber
string
Required string length: 1 - 255
​
email
string<email>
​
building
string
Required string length: 1 - 255
​
buildingAr
string
Required string length: 1 - 255
​
street
string
Required string length: 1 - 255
​
streetAr
string
Required string length: 1 - 255
​
district
string
Required string length: 1 - 255
​
districtAr
string
Required string length: 1 - 255
​
city
string
Required string length: 1 - 255
​
cityAr
string
Required string length: 1 - 255
​
country
string
Required string length: 1 - 255
​
countryAr
string
Required string length: 1 - 255
​
postalCode
string
Required string length: 1 - 255
​
additionalNumber
string
Required string length: 1 - 255
​
otherId
string
Required string length: 1 - 255
​
bankName
string
Required string length: 1 - 255
​
bankContactName
string
Required string length: 1 - 255
​
iban
string
Required string length: 1 - 255
​
accountNumber
string
Required string length: 1 - 255
​
emailTone
enum<string>

An enumeration.

Available options:
FRIENDLY,
NEUTRAL,
REALESTATE
​
sendEmailNotif
boolean
​
sendEmailNotifLang
enum<string>

An enumeration.

Available options:
ENGLISH,
ARABIC,
ENGLISH_ARABIC
​
sendSmsNotif
boolean
​
sendSmsNotifLang
enum<string>

An enumeration.

Available options:
ENGLISH,
ARABIC
​
remindersEnabled
boolean
​
extPlatformId
string
​
extCompanyId
string
​
hasErrors
boolean
​
errorDetail
Errordetail · object
​
secondaryContacts
CreateOrUpdateSecondaryContact · object[]
​
role
enum<string>

An enumeration.

Available options:
PRIMARY,
SECONDARY
​
paymentInstructions
string<uuid>
​
workflowUuid
string<uuid>
​
customFields
any[]

Response

Successful Response

​
name
string
required
Required string length: 1 - 255
​
uuid
string<uuid>
required
​
nameAr
string
Required string length: 1 - 255
​
firstName
string
Required string length: 1 - 255
​
firstNameAr
string
Required string length: 1 - 255
​
lastName
string
Required string length: 1 - 255
​
lastNameAr
string
Required string length: 1 - 255
​
phoneNumber
string
Required string length: 1 - 255
​
vatNumber
string
Required string length: 1 - 255
​
email
string<email>
​
building
string
Required string length: 1 - 255
​
buildingAr
string
Required string length: 1 - 255
​
street
string
Required string length: 1 - 255
​
streetAr
string
Required string length: 1 - 255
​
district
string
Required string length: 1 - 255
​
districtAr
string
Required string length: 1 - 255
​
city
string
Required string length: 1 - 255
​
cityAr
string
Required string length: 1 - 255
​
country
string
Required string length: 1 - 255
​
countryAr
string
Required string length: 1 - 255
​
postalCode
string
Required string length: 1 - 255
​
additionalNumber
string
Required string length: 1 - 255
​
otherId
string
Required string length: 1 - 255
​
bankName
string
Required string length: 1 - 255
​
bankContactName
string
Required string length: 1 - 255
​
iban
string
Required string length: 1 - 255
​
accountNumber
string
Required string length: 1 - 255
​
emailTone
enum<string>

An enumeration.

Available options:
FRIENDLY,
NEUTRAL,
REALESTATE
​
sendEmailNotif
boolean
​
sendEmailNotifLang
enum<string>

An enumeration.

Available options:
ENGLISH,
ARABIC,
ENGLISH_ARABIC
​
sendSmsNotif
boolean
​
sendSmsNotifLang
enum<string>

An enumeration.

Available options:
ENGLISH,
ARABIC
​
remindersEnabled
boolean
​
extPlatformId
string
​
extCompanyId
string
​
hasErrors
boolean
​
errorDetail
Errordetail · object
​
totalAmount
number
​
totalPaid
number
​
outstandingAmount
number
​
totalInvoices
integer
​
countUnpaidInvoices
integer
​
risk
enum<string>

An enumeration.

Available options:
LOW,
MEDIUM,
HIGH
​
role
enum<string>

An enumeration.

Available options:
PRIMARY,
SECONDARY
​
secondaryContacts
GetContactRespShort · object[]
​
paymentInstructions
PaymentInstructionResp · object
​
workflow
GetWorkflowResponseShort · object
​
customFields
any[]
​
promiseToPayDate
string<date>
​
promiseToPaySwitchWorkflowUuid
string<uuid>
​
reminderStatus
string
​
reminderLabel
string