FLfleetio
Contacts

Create Contact

Creates a new contact.

:::info account_membership_attributes are only available to Fleetio partners with an Organization Token or Partner Token. :::

post/contacts

Request

Headers

Partner-Tokenstring

Used by Fleetio Partners to manage integrations.

Organization-Tokenstring

Used by organizations to manage multiple accounts.

Request body

first_namestring required

This Contact's first name.

middle_namestring

This Contact's middle name.

last_namestring

This Contact's last name.

birth_datestring date

This Contact's birth date. We recommend using ISO-8601 formatted dates to avoid ambiguity.

group_hierarchystring nullable

If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.

emailstring

This Contact's email address.

mobile_phone_numberstring

This Contact's mobile phone number.

home_phone_numberstring

This Contact's home phone number.

work_phone_numberstring

This Contact's work phone number.

other_phone_numberstring

Any other phone number for this Contact.

street_addressstring

The street address of this Contact.

street_address_line_2string

The second line of this Contact's street address.

citystring

The city of this Contact's address.

regionstring

The region, state, province, or territory of this Contact's address.

postal_codestring

The postal code for this Contact's address.

countrystring

The country where this Contact resides.

employee_numberstring

This Contact's employee number. Must be unique.

job_titlestring

This Contact's job title.

start_datestring date

The date at which this Contact started, or is expected to start. We recommend using ISO-8601 formatted dates to avoid ambiguity.

leave_datestring date

The date at which this Contact left, or is expected to leave. We recommend using ISO-8601 formatted dates to avoid ambiguity.

vehicle_operatorboolean

Whether this Contact is a Vehicle Operator.

license_numberstring

The license number of this Contact.

license_classstring

The class of this Contact's license.

license_statestring

The state, province, region, or territory of this Contact's license.

hourly_labor_ratenumber float

The hourly labor rate for this Contact.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

group_idinteger
license_expirationstring date

The date and time at which this Contact's license expires. We recommend using ISO-8601 formatted dates to avoid ambiguity.

employeeboolean

Whether this Contact is an Employee.

technicianboolean

Whether this Contact is a Technician.

user_accessboolean

Whether this Contact has User Access. This must be set to true if using account_membership_attributes.

Example request

{
  "birth_date": "1950-05-05",
  "group_hierarchy": "Group 1|Group 2|Group 3",
  "start_date": "2023-09-09",
  "leave_date": "2023-12-12",
  "license_expiration": "2024-03-14"
}

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

namestring nullable required

The Contact's full name.

first_namestring nullable required

The Contact's first name.

middle_namestring nullable required

The Contact's middle name.

group_idinteger nullable required

If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

group_namestring nullable required

If this Contact belongs to a Group, this will be the Group's name.

last_namestring nullable required

The Contact's last name.

images_countinteger required

The number of images associated with this Contact.

documents_countinteger required

The number of documents associated with this Contact.

comments_countinteger required

The number of Comments associated with this Contact.

emailstring nullable

The Contact's email address.

technicianboolean nullable

Whether this Contact is a Technician.

vehicle_operatorboolean nullable

Whether this Contact is a Vehicle Operator.

employeeboolean nullable

Whether this Contact is an Employee.

birth_datestring date nullable

The Contact's birth date.

street_addressstring nullable

The Contact's street address.

street_address_line_2string nullable

The second line of the Contact's street address.

citystring nullable

The Contact's city.

regionstring nullable

The Contact's region.

postal_codestring nullable

The Contact's postal code.

countrystring nullable

The Contact's country.

employee_numberstring nullable

The Contact's employee number.

job_titlestring nullable

The Contact's job title.

license_classstring nullable

The Contact's license class.

license_numberstring nullable

The Contact's license number.

license_statestring nullable

The state which issued the Contact's license.

license_expirationstring date nullable

The Contact's driver's license expiration date.

home_phone_numberstring nullable

The Contact's home phone number.

mobile_phone_numberstring nullable

The Contact's mobile phone number.

work_phone_numberstring nullable

The Contact's work phone number.

other_phone_numberstring nullable

Any other mobile phone number belonging to this Contact.

start_datestring date nullable

The Contact's start date.

leave_datestring date nullable

The Contact's leave date.

hourly_labor_ratenumber float nullable

The Contact's hourly rate.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

default_image_urlstring nullable required

The URL pointing to the default image for this Contact.

account_membership_idinteger nullable
archived_atstring date-time nullable

The date and time at which this Contact was archived, if applicable. null if this Contact is not archived.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "birth_date": "2023-03-14",
  "license_expiration": "2023-03-14",
  "archived_at": "2023-03-14T13:46:27-06:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.