Contact

(API Version v10)

This entity represents a Contact that has been assigned to an Account.

What can you do with Contact?

GET Contact/
Retrieve all of the Contact objects.
GET Contact/Paged
Retrieve all of the Contact objects in a paged fashion.
GET Contact/Paged/Detail
Retrieve all of the Contact objects in a paged fashion with all object details.
GET Contact/{id}
Retrieve an instance of the Contact object by its ID.
GET Contact/{id}/Detail
Retrieve deep detail of the Contact object by its ID.
PATCH Contact/{id}
Update or Add the Contact object and optionally make changes to any child objects.
POST Contact/
Create a new instance of the Contact object.
PUT Contact/{id}
Update an existing instance of the Contact object.

Properties

Property Details

identity READ-ONLY	"identity": 3 Type: Number This is the unique numeric identifier for the Contact
contactTypeId	"contactTypeId": 9 Type: Number Unique identifier for the associated ContactType object.
contactTypeName	"contactTypeName": "Sample Name" Type: String The name of the object associated with the contactTypeId property.
title	"title": "Mr." Type: String Title given to the contact.
firstName	"firstName": "John" Type: String The Contact's first name.
lastName	"lastName": "Doe" Type: String The Contact's last name.
isUsedForTax	"isUsedForTax": true Type: Boolean Whether or not this Contact's address is used as the taxation address for the account.
updated READ-ONLY	"updated": "2021-04-26T15:25:27.587Z" Type: Date The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.

Patch Types

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. Below you will find the child objects that can be updated as part of PATCH operations for the Contact object.

Standard PATCH objects:

contactPoint - create, update, delete
address - create, update, delete, attach, detach

DataFlow PATCH objects:

contact - create, update, delete
contactPoint - create, update, delete
address - create, update, delete, attach, detach

End Points

Retrieve all of the Contact objects.

GET Contact/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "contactTypeId": 27,
            "contactTypeName": "Sample Text Data",
            "title": "Mr.",
            "firstName": "John",
            "lastName": "Doe",
            "isUsedForTax": true,
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}

Retrieve all of the Contact 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 Contact objects in a paged fashion.

GET Contact/Paged

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 26,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "isUsedForTax": true,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}

Retrieve all of the Contact 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 Contact objects in a paged fashion with all object details.

GET Contact/Paged/Detail

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 2,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "isUsedForTax": true,
                "updated": "2021-04-26T15:25:27.587Z",
                "details": {
                    "contactPoints": [
                        {
                            "identity": 51,
                            "contactPointTypeId": 47,
                            "contactPointTypeName": "Sample Text Data",
                            "value": "Sample Text Data",
                            "contactId": 16,
                            "updated": "2021-04-26T15:25:27.587Z"
                        }
                    ],
                    "address": {
                        "identity": 33,
                        "address1": "Sample Text Data",
                        "address2": "Sample Text Data",
                        "stateId": 38,
                        "stateName": "Sample Text Data",
                        "countryId": 0,
                        "countryName": "Sample Text Data",
                        "zipCode": "Sample Text Data",
                        "latitude": 59.83,
                        "longitude": 99.71,
                        "cityName": "Sample Text Data",
                        "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z",
                        "isIncorporated": true,
                        "updated": "2021-04-26T15:25:27.587Z",
                        "stateCode": "Sample Text Data",
                        "countryCode": "Sample Text Data",
                        "fetchTaxJurisdicationAsync": true
                    }
                }
            }
        ]
    }
}

GET	Contact/{id}
Retrieve an instance of the Contact object by its ID.
{id}	Unique identifier for the Contact object.
Retrieve an instance of the Contact object by its ID. GET Contact/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "contactTypeId": 15, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } }

GET	Contact/{id}/Detail
Retrieve deep detail of the Contact 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 Contact object.
Retrieve deep detail of the Contact object by its ID. GET Contact/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "contactTypeId": 14, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z", "details": { "contactPoints": [ { "identity": 51, "contactPointTypeId": 47, "contactPointTypeName": "Sample Text Data", "value": "Sample Text Data", "contactId": 16, "updated": "2021-04-26T15:25:27.587Z" } ], "address": { "identity": 33, "address1": "Sample Text Data", "address2": "Sample Text Data", "stateId": 38, "stateName": "Sample Text Data", "countryId": 0, "countryName": "Sample Text Data", "zipCode": "Sample Text Data", "latitude": 59.83, "longitude": 99.71, "cityName": "Sample Text Data", "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z", "isIncorporated": true, "updated": "2021-04-26T15:25:27.587Z", "stateCode": "Sample Text Data", "countryCode": "Sample Text Data", "fetchTaxJurisdicationAsync": true } } } }

PATCH	Contact/{id}
Update or Add the Contact 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 Contact object.
Update or Add the Contact object and optionally make changes to any child objects. PATCH Contact/{id} { "details": {}, "contacts": { "items": [ { "patchType": "create", "patchClientId": 1, "contactTypeId": 1, "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } ] } } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "patch", "results": { "totalCount": 1, "items": [ { "identity": 1, "action": "created", "dtoTypeKey": "contact", "instance": { "identity": 1, "contactTypeId": 19, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } } ] } }

Create a new instance of the Contact object.

POST Contact/

{
    "contactTypeId": 24,
    "title": "Mr.",
    "firstName": "John",
    "lastName": "Doe",
    "isUsedForTax": true,
    "updated": "2021-04-26T15:25:27.587Z"
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 4,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "isUsedForTax": true,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}

Update an existing instance of the Contact object.

PUT Contact/{id}

{
    "identity": 1,
    "contactTypeId": 15,
    "title": "Mr.",
    "firstName": "John",
    "lastName": "Doe",
    "isUsedForTax": true,
    "updated": "2021-04-26T15:25:27.587Z"
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 17,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "isUsedForTax": true,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}