Back to Teamwork CRMUpdate a contact
Updates a contact and returns it
Input
type: object
properties:
parameters:
type: object
properties:
include:
type: string
description: |-
Comma separated list of relationships to include in the response.
See
[including related entities](/crm/general/related-entities)
for more detailed documentation of how this works.
id:
type: integer
required:
- id
title: Parameters
data:
type: object
title: Data
properties:
contact:
type: object
properties:
addressLine1:
type: string
addressLine2:
type: string
city:
type: string
company:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
country:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
custom:
type: object
emailAddresses:
type: array
items:
type: object
properties:
address:
type: string
format: email
isMain:
type: boolean
description: One element in the array must have this set to true.
firstName:
type: string
lastName:
type: string
owner:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
phoneNumbers:
type: array
items:
type: object
properties:
code:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- phone-codes
isMain:
type: boolean
description: One element in the array must have this set to true.
number:
type: string
description: >-
The phone number, excluding the country code (this can be
specified with `code`).
stateOrCounty:
type: string
timezone:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
title:
type: string
zipcode:
type: string
Output
type: object
title: contactResponse
properties:
contact:
type: object
title: Contact
properties:
addressLine1:
type: string
addressLine2:
type: string
avatar:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
city:
type: string
company:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
country:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
createdAt:
type: string
description: When the item was created, as a datetime
format: date-time
createdBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
custom:
type: object
deletedAt:
type: string
description: When the item was deleted, as a datetime
format: date-time
deletedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
duplicatedFrom:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "deals".
emailAddresses:
type: array
items:
type: object
properties:
address:
type: string
format: email
isMain:
type: boolean
description: One element in the array must have this set to true.
firstName:
type: string
id:
type: integer
lastName:
type: string
owner:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
phoneNumbers:
type: array
items:
type: object
properties:
code:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- phone-codes
isMain:
type: boolean
description: One element in the array must have this set to true.
number:
type: string
description: >-
The phone number, excluding the country code (this can be
specified with `code`).
stateOrCounty:
type: string
timezone:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
title:
type: string
updatedAt:
type: string
description: When the item was last updated, as a datetime
format: date-time
updatedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
updatedSourceId:
type: integer
description: Source ID of the latest request made (API / Web app)
zipcode:
type: string
included:
type: object
title: Included