Update Contact Person partially.

Prev Next
Patch
/contact-persons/{id}/

Operation is used to update specific fields in existing contact person.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of contact person to update

Body parameters

Contact person attributes and values to be updated

object

A flat representation of a Contact Person object, used for creating or updating contact person.

comments
string

Additional comments about the contact person.

contact_start_date
string (date)

Start date of the contact person.

customer_number
string

Customer number associated with the contact person.

email
string (email)

Email address of the contact person.

fax
string

Fax number of the contact person.

name
string

Name of the contact person.

phone
string

Primary phone number of the contact person.

phone2
string

Secondary phone number of the contact person.

Address
integer

ID of the address associated with the contact person.

Role
integer

ID of the role associated with the contact person. Must be a valid TxtConstant with group name CONTACT_ROLE

contact_person_restricted_type
integer

ID of the restricted type for the contact person.

Responses
200

Object was updated successfully

object

A flat representation of a Contact Person object, used for creating or updating contact person.

comments
string

Additional comments about the contact person.

contact_start_date
string (date)

Start date of the contact person.

created_by
string

User who created the contact person.

created_ts
string (date-time)

Timestamp when the contact person was created.

customer_number
string

Customer number associated with the contact person.

email
string (email)

Email address of the contact person.

fax
string

Fax number of the contact person.

id
integer

Unique identifier for the contact person.

name
string

Name of the contact person.

phone
string

Primary phone number of the contact person.

phone2
string

Secondary phone number of the contact person.

Address
integer

ID of the address associated with the contact person.

Role
integer

ID of the role associated with the contact person. Must be a valid TxtConstant with group name CONTACT_ROLE

contact_person_restricted_type
integer

ID of the restricted type for the contact person.

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error