Contact Point Type

(API Version v8)

This entity represents the different ways in which a Contact can be communicated with. Examples are "email", "phone", "text" and "address".

What can you do with ContactPointType?

GET ContactPointType/
Retrieve all of the ContactPointType objects.
GET ContactPointType/Paged
Retrieve all of the ContactPointType objects in a paged fashion.
GET ContactPointType/{id}
Retrieve an instance of the ContactPointType object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 24 Type: Number This is the unique numeric identifier for the ContactPointType
name READ-ONLY	"name": "email" Type: String System defined name of the Contact Point Type
dataTypeId	"dataTypeId": 10 Type: Number Unique identifier for the associated DataType object.
dataTypeName	"dataTypeName": "Sample Name" Type: String The name of the object associated with the dataTypeId property.
isRequired READ-ONLY	"isRequired": true Type: Boolean Whether or not this type is required.
contactTypeId	"contactTypeId": 2 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.
allowMultiple READ-ONLY	"allowMultiple": true Type: Boolean Whether or not multiple Contact Points of this type can be allowed for a Contact.
isCore READ-ONLY	"isCore": true Type: Boolean Signifies the Contact Point Type is core and cannot be modified.

End Points

Retrieve all of the ContactPointType objects.

GET ContactPointType/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "email",
            "dataTypeId": 16,
            "dataTypeName": "Sample Text Data",
            "isRequired": true,
            "contactTypeId": 21,
            "contactTypeName": "Sample Text Data",
            "allowMultiple": true,
            "isCore": true
        }
    ]
}

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

GET ContactPointType/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,
                "name": "email",
                "dataTypeId": 27,
                "dataTypeName": "Sample Text Data",
                "isRequired": true,
                "contactTypeId": 2,
                "contactTypeName": "Sample Text Data",
                "allowMultiple": true,
                "isCore": true
            }
        ]
    }
}

GET	ContactPointType/{id}
Retrieve an instance of the ContactPointType object by its ID.
{id}	Unique identifier for the ContactPointType object.
Retrieve an instance of the ContactPointType object by its ID. GET ContactPointType/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "email", "dataTypeId": 6, "dataTypeName": "Sample Text Data", "isRequired": true, "contactTypeId": 22, "contactTypeName": "Sample Text Data", "allowMultiple": true, "isCore": true } }