Contact Mappings

Create ContactMapping

Creates a new ContactMapping

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
parent_Contact_Key
required
integer <int32>
child_Contact_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/contact-mappings
Request samples
{
  • "parent_Contact_Key": 0,
  • "child_Contact_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ContactMapping

Lists all ContactMapping

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/contact-mappings
Request samples 
Response samples 
No sample
Get ContactMapping
Gets ContactMapping


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
parentContactKey
required
integer <int32> 
Parent Contact Key


 
childContactKey
required
integer <int32> 
Child Contact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/contact-mappings/{parentContactKey}/{childContactKey}
Request samples 
Response samples 
No sample
Delete ContactMapping
Deletes an ContactMapping


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
parentContactKey
required
integer <int32> 
Parent Contact Key


 
childContactKey
required
integer <int32> 
Child Contact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/contact-mappings/{parentContactKey}/{childContactKey}
Request samples 
Create or Update Batch ContactMapping
Create or Update multiple ContactMapping at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
parent_Contact_Key
required
integer <int32> 
 
child_Contact_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/contact-mappings-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}