Update a contact

Update the details of a single contact (required scope contacts:write)

Path Parameters

contactId int64 required

Contact id

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body

Model used to update contact. At least one optional value must be provided

reference string nullable

The internal reference of the contact - should usually be unique
Optional: Omit to retain current value or provide null to unset

name string

The name of the contact
Optional: Omit to retain current value

groupId int64

The unique identifier of the group this contact belongs to
Optional: Omit to retain current value

parentId int64 nullable

The unique identifier of the parent contact of this contact
Optional: Omit to retain current value or provide null to unset

extraInformation string nullable

A free text description about the contact
Optional: Omit to retain current value or provide null to unset

street string nullable

The contact street address
Optional: Omit to retain current value or provide null to unset

town string nullable

The contact address town / city / village / locality
Optional: Omit to retain current value or provide null to unset

postalCode string nullable

The contact address postcode or zipcode
Optional: Omit to retain current value or provide null to unset

country string nullable

The textual name of the contact address country
Optional: Omit to retain current value or provide null to unset

location object

Represents a geographical location

latitude double required

Latitude of the center of the location

longitude double required

Longitude of the center of the location

customFields object[]
Custom fields associated with the contact. Omit or use an empty list to retain current values
Optional: Omit to retain current value
Array [
definitionId int64 required
The unique identifier of the associated custom field definition
value string nullable
The value of this custom field. If set to null, any existing value will be unset
]

Responses

• 204
• 400
• 403
• 404
• 422
• 500

---

No Content

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Not Found

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

errors object
property name* string[]
Array [
string
]
type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "errors": {},
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...