Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
ContactPerson

Add contact person to a profile (group, company, or travel agent)

post/group-profile/v1/contact-persons

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Request body

profileIdinteger

Optional profile ID to link this contact person to a specific profile (group, company, or travel agent)

isMainContactboolean

Whether this is the main contact (stored in profile-person relationship, requires profileId)

role'BOOKING_COORDINATOR' | 'ONSITE_COORDINATOR' | 'ROOMING_LIST_CONTACT' | 'ACCOUNTS_PAYABLE' | 'BILLING' | 'INVOICING' | 'ACCOUNT_MANAGER' | 'SALES_LEAD' | 'TRAVEL_AGENT_ACCOUNT_MANAGER' | 'CORPORATE_CONTACT' | 'AUTHORIZED_SIGNER' | 'EXECUTIVE_APPROVER' | 'MARKETING' | 'MAIN_POINT_OF_CONTACT' | 'ADMINISTRATIVE' | 'OTHER'

Role of person in the profile relationship

anonymizedboolean

Whether the contact is anonymized

prefixstring

Name prefix (Mr., Mrs., Dr., etc.)

firstNamestring required

First name

lastNamestring required

Last name

statusstring required

Contact person status. Allowed values are ACTIVE, DELETED

Example request

{
  "role": "BOOKING_COORDINATOR",
  "prefix": "Mr.",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    {
      "emailType": "work",
      "email": "john.doe@example.com"
    }
  ],
  "phones": [
    {
      "phoneType": "mobile",
      "phone": "+1-555-123-4567"
    }
  ],
  "status": "ACTIVE",
  "billingDetails": {
    "address1": "3033 5th Ave.",
    "address2": "Ste 100",
    "city": "San Diego",
    "country": "US",
    "document_number": "142-test",
    "name": "Denise Foreman",
    "postal_code": "60601",
    "phone": "1234567890",
    "state": "IL"
  }
}

Response

Contact person added successfully

idstring

Contact person ID

isMainContactboolean

Whether this is the main contact (from profile-person relationship, only populated when profileId filter was provided)

role'BOOKING_COORDINATOR' | 'ONSITE_COORDINATOR' | 'ROOMING_LIST_CONTACT' | 'ACCOUNTS_PAYABLE' | 'BILLING' | 'INVOICING' | 'ACCOUNT_MANAGER' | 'SALES_LEAD' | 'TRAVEL_AGENT_ACCOUNT_MANAGER' | 'CORPORATE_CONTACT' | 'AUTHORIZED_SIGNER' | 'EXECUTIVE_APPROVER' | 'MARKETING' | 'MAIN_POINT_OF_CONTACT' | 'ADMINISTRATIVE' | 'OTHER'

Role of person in the profile relationship

relationshipType'EMPLOYEE' | 'BOOKED_BY' | 'PART_OF_GROUP' | 'CONTACT' | 'GUEST' | 'DECISION_MAKER' | 'TRAVELER' | 'PRIMARY' | 'SECONDARY' | 'BILLING_CONTACT' | 'EMERGENCY_CONTACT'

Type of relationship between person and profile

startDatestring date

Start date of the relationship (from profile-person relationship, only populated when profileId filter was provided)

endDatestring date

End date of the relationship (from profile-person relationship, only populated when profileId filter was provided)

anonymizedboolean

Whether the contact is anonymized

prefixstring

Name prefix (Mr., Mrs., Dr., etc.)

firstNamestring

First name

lastNamestring

Last name

statusstring

Contact person status. Allowed values are ACTIVE, DELETED

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

Example response

{
  "role": "BOOKING_COORDINATOR",
  "relationshipType": "PRIMARY",
  "prefix": "Mr.",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    {
      "emailType": "work",
      "email": "john.doe@example.com"
    }
  ],
  "phones": [
    {
      "phoneType": "mobile",
      "phone": "+1-555-123-4567"
    }
  ],
  "status": "ACTIVE",
  "billingDetails": {
    "address1": "3033 5th Ave.",
    "address2": "Ste 100",
    "city": "San Diego",
    "country": "US",
    "document_number": "142-test",
    "name": "Denise Foreman",
    "postal_code": "60601",
    "phone": "1234567890",
    "state": "IL"
  }
}