Contact Type

(API Version v3)

What can you do with ContactType?

DELETE api/v3/ContactType/{id:int}
GET api/v3/ContactType
GET api/v3/ContactType/Paged
GET api/v3/ContactType/Paged/Detail
GET api/v3/ContactType/{id:int}
GET api/v3/ContactType/{id:int}/Detail
PATCH api/v3/ContactType/{id:int}
POST api/v3/ContactType
PUT api/v3/ContactType/{id:int}

Properties

Property Details

id	"id": 14 Type: Number This is the unique numeric identifier for the ContactType
name	"name": "Hello World" Type: String
ownerId	"ownerId": 0 Type: Number Unique identifier for the associated Owner object.
isRequired	"isRequired": true Type: Boolean
contactTypeTypeId	"contactTypeTypeId": 10 Type: Number Unique identifier for the associated ContactTypeType object.
description	"description": "Hello World" Type: String
sendEmail	"sendEmail": true Type: Boolean
showOnOverview	"showOnOverview": true Type: Boolean
showOnNewAccount	"showOnNewAccount": true Type: Boolean

Update Request Filters

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:

name
isRequired
contactTypeTypeId
description
sendEmail
showOnOverview
showOnNewAccount

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 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:

contactPointType - create, update, delete

DataFlow PATCH objects:

contactType - create, update, delete
contactPointType - create, update, delete

End Points

DELETE	api/v3/ContactType/{id:int}
Delete an instance of the ContactType object.

GET	api/v3/ContactType
Retrieve all of the ContactType objects.

GET	api/v3/ContactType/Paged
Retreive all of the ContactType objects in a paged fashion.

GET	api/v3/ContactType/Paged/Detail
Retreive all of the ContactType objects in a paged fashion with all object details.

GET	api/v3/ContactType/{id:int}
Retrieve an instance of the ContactType object by it's ID.
{id:int}	Unique identifier for the ContactType object.

GET	api/v3/ContactType/{id:int}/Detail
Retreive all of the Detail objects for the specified ContactType.
{id:int}	Unique identifier for the ContactType object.

PATCH	api/v3/ContactType/{id:int}
Update the ContactType object and optionally make changes to any child objects.

POST	api/v3/ContactType
Create a new instance of the ContactType object.

PUT	api/v3/ContactType/{id:int}
Update an existing instance of the ContactType object.