Contact

What can you do with Contact?


Properties

Property Details
id
"id": 13
Type: Number
This is the unique numeric identifier for the Contact
contactTypeId
"contactTypeId": 964
Type: Number
Unique identifier for the associated ContactType object.
name
"name": "Hello World"
Type: String
title
"title": "Hello World"
Type: String
firstName
"firstName": "Hello World"
Type: String
lastName
"lastName": "Hello World"
Type: String


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:

  • identity
  • contactTypeId
  • name
  • title
  • firstName
  • lastName

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 Contact object.

Standard PATCH objects:

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

DataFlow PATCH objects:

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

End Points

DELETEapi/v1/Contact/{id:int}
Delete an instance of the Contact object.
GETapi/v1/Contact
Retrieve all of the Contact objects.
GETapi/v1/Contact/Metadata
Retrieve all of the meta data details of the Contact object.
GETapi/v1/Contact/Metadata/{option}
Retrieve all the meta data details of the Contact object based on provided options.
{option}Metadata options for the Contact object.
GETapi/v1/Contact/Paged
Retreive all of the Contact objects in a paged fashion.
GETapi/v1/Contact/Paged/Detail
Retreive all of the Contact objects in a paged fashion with all object details.
GETapi/v1/Contact/{id:int}
Retrieve an instance of the Contact object by it's ID.
{id:int}Unique identifier for the Contact object.
GETapi/v1/Contact/{id:int}/Detail
Retreive all of the Detail objects for the specified Contact.
{id:int}Unique identifier for the Contact object.
PATCHapi/v1/Contact/{id:int}
Update the Contact object and optionally make changes to any child objects.
POSTapi/v1/Contact
Create a new instance of the Contact object.
PUTapi/v1/Contact/{id:int}
Update an existing instance of the Contact object.