Create new Contact Person.

Prev Next
Post
/contact-persons/

Operation is used to create a new contact person.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Contact person to be created

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
201

A newly created contact person

{
  "Address": 2424968,
  "Role": 27371,
  "comments": "Test contact person via contact person rest api",
  "contact_person_restricted_type": null,
  "contact_start_date": "2025-02-07",
  "created_by": "test user",
  "created_ts": "2025-07-25T14:34:26.013Z",
  "customer_number": "ContactPerson123",
  "email": "jdoe@us.ibm.com",
  "fax": "490-521-0709",
  "id": 127120,
  "name": "John Doe",
  "phone": "1234567890",
  "phone2": "123-456-7890"
}
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.

400

There was an error in request. Usually field validation failed.

{
  "name": [
    "This field is required."
  ]
}
object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

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

Detailed description of error