TAG LINE
TAG LINE
SMALL TITLE
This entity represents the different ways in which a Contact can be communicated with. Examples are "email", "phone", "text" and "address".
identity READ-ONLY | "identity": 23 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": 2 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": 1 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. |
GET | ContactPointType/ |
Retrieve all of the ContactPointType objects. | |
Retrieve all of the ContactPointType objects. GET ContactPointType/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "email", "dataTypeId": 5, "dataTypeName": "Sample Text Data", "isRequired": true, "contactTypeId": 13, "contactTypeName": "Sample Text Data", "allowMultiple": true, "isCore": true } ] } |
GET | ContactPointType/Paged |
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 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": 13, "dataTypeName": "Sample Text Data", "isRequired": true, "contactTypeId": 20, "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} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "email", "dataTypeId": 1, "dataTypeName": "Sample Text Data", "isRequired": true, "contactTypeId": 13, "contactTypeName": "Sample Text Data", "allowMultiple": true, "isCore": true } } |