TAG LINE
SMALL TITLE
This entity represents a type of a Contact in the system. Examples would "Billing", "Shipping" etc.
identity READ-ONLY | "identity": 1 Type: Number This is the unique numeric identifier for the ContactType |
name | "name": "Shipping" Type: String User defined name for the Contact Type |
ownerId READ-ONLY | "ownerId": 16 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
isRequired | "isRequired": true Type: Boolean Whether or not this Contact Type is required. |
contactTypeTypeId | "contactTypeTypeId": 20 Type: Number Unique identifier for the associated ContactTypeType object. |
contactTypeTypeName | "contactTypeTypeName": "Sample Name" Type: String The name of the object associated with the contactTypeTypeId property. |
description | "description": "Shipping contact for the account" Type: String User defined description for the Contact Type |
sendEmail | "sendEmail": true Type: Boolean Unused |
showOnOverview | "showOnOverview": true Type: Boolean Unsued |
showOnNewAccount | "showOnNewAccount": true Type: Boolean Whether or not to make this Contact Type available for convenience when adding a new Account through the user interface. |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.
PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the ContactType object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v3/ContactType/{id} |
| Delete an instance of the ContactType object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the ContactType object. |
Delete an instance of the ContactType object. DELETE api/v3/ContactType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "contactType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v3/ContactType/ |
| Retrieve all of the ContactType objects. | |
Retrieve all of the ContactType objects. GET api/v3/ContactType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Shipping",
"ownerId": 24,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 5,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}
]
} | |
| GET | api/v3/ContactType/Paged |
| Retrieve all of the ContactType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the ContactType objects in a paged fashion. GET api/v3/ContactType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Shipping",
"ownerId": 0,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 2,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}
]
}
} | |
| GET | api/v3/ContactType/Paged/Detail |
| Retrieve all of the ContactType objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the ContactType objects in a paged fashion with all object details. GET api/v3/ContactType/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Shipping",
"ownerId": 1,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 27,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v3/ContactType/{id} |
| Retrieve an instance of the ContactType object by its ID. | |
| {id} | Unique identifier for the ContactType object. |
Retrieve an instance of the ContactType object by its ID. GET api/v3/ContactType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Shipping",
"ownerId": 8,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 0,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}
} | |
| GET | api/v3/ContactType/{id}/Detail |
| Retrieve deep detail of the ContactType object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the ContactType object. |
Retrieve deep detail of the ContactType object by its ID. GET api/v3/ContactType/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Shipping",
"ownerId": 26,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 14,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| PATCH | api/v3/ContactType/{id} |
| Update or Add the ContactType object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the ContactType object. |
Update or Add the ContactType object and optionally make changes to any child objects. PATCH api/v3/ContactType/{id}
{
"details": {},
"contactTypes": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "Shipping",
"isRequired": true,
"contactTypeTypeId": 0,
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "contactType",
"instance": {
"identity": 1,
"name": "Shipping",
"ownerId": 7,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 3,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}
}
]
}
} | |
| POST | api/v3/ContactType/ |
| Create a new instance of the ContactType object. | |
Create a new instance of the ContactType object. POST api/v3/ContactType/
{
"name": "Shipping",
"isRequired": true,
"contactTypeTypeId": 17,
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Shipping",
"ownerId": 19,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 24,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}
]
}
} | |
| PUT | api/v3/ContactType/{id} |
| Update an existing instance of the ContactType object. | |
Update an existing instance of the ContactType object. PUT api/v3/ContactType/{id}
{
"identity": 1,
"name": "Shipping",
"isRequired": true,
"contactTypeTypeId": 1,
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Shipping",
"ownerId": 16,
"ownerName": "Sample Text Data",
"isRequired": true,
"contactTypeTypeId": 26,
"contactTypeTypeName": "Sample Text Data",
"description": "Shipping contact for the account",
"sendEmail": true,
"showOnOverview": true,
"showOnNewAccount": true
}
]
}
} | |