Create Contact

Creates a new contact

application/json

Request Body

first_name string required
Possible values: <= 255 characters
The Contact's first name.
last_name string
Possible values: <= 255 characters
The Contact's last name.
birth_date date
The Contact's birth date. We recommend using ISO-8601 formatted dates to avoid ambiguity.
group_name string
Possible values: <= 255 characters
The name of the Group this Contact belongs to.
group_hierarchy string
A pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
middle_name string
Possible values: <= 255 characters
The Contact's middle name.
email string
Possible values: <= 255 characters
The Contact's email address.
mobile_phone_number string
Possible values: <= 255 characters
The Contact's mobile phone number.
home_phone_number string
Possible values: <= 255 characters
The Contact's home phone number.
work_phone_number string
Possible values: <= 255 characters
The Contact's work phone number.
other_phone_number string
Possible values: <= 255 characters
Any other phone number for this Contact.
street_address string
Possible values: <= 255 characters
The Contact's street address.
street_address_line_2 string
Possible values: <= 255 characters
The Contact's street address line 2.
city string
Possible values: <= 255 characters
The Contact's city.
region string
Possible values: <= 255 characters
The Contact's region, state, or province.
postal_code string
Possible values: <= 255 characters
The Contact's postal code, zip code, or equivalent.
country string
Possible values: <= 255 characters
The Contact's country.
employee_number string
Possible values: <= 255 characters
*Must be unique
job_title string
Possible values: <= 255 characters
The Contact's job title.
start_date date
When the Contact started working for the company, if applicable. We recommend using ISO-8601 formatted dates to avoid ambiguity.
leave_date date
When the Contact left or will leave the company, if applicable. We recommend using ISO-8601 formatted dates to avoid ambiguity.
vehicle_operator boolean
Whether or not the Contact is a Vehicle Operator.
license_number string
Possible values: <= 255 characters
The Contact's driver's license number.
license_class string
Possible values: <= 255 characters
The Contact's driver's license class.
license_state string
Possible values: <= 255 characters
The locality which issued the Contact's license.
hourly_labor_rate float
The Contact's hourly labor rate.
custom_fields object
*Full details on working with Custom Fields here.
group_id integer
Possible values: >= 1
license_expiration date
The Contact's driver's license expiration date. We recommend using ISO-8601 formatted dates to avoid ambiguity.
employee boolean
Whether or not the Contact is an Employee.
technician boolean
Whether or not the Contact is a Technician.
account_membership_attributes object
This set of attributes will update 'Regular User' only. Other User types cannot be modified this way. Each attribute can be updated individually, or up to all at once.
role_name string
The name of the Role to be assigned to the Contact. Must be an exact match of an existing Role.
vehicles_record_set_name string
The name of the Vehicles record set the Contact has access to. Must be an exact match of an existing record set.
contacts_record_set_name string
The name of the Contacts record set the Contact has access to. Must be an exact match of an existing record set.
equipments_record_set_name string
The name of the Equipment record set the Contact has access to. Must be an exact match of an existing record set.
inspection_forms_record_set_name string
The name of the Inspection Forms record set the Contact has access to. Must be an exact match of an existing record set.
parts_record_set_name string
The name of the Parts record set the Contact has access to. Must be an exact match of an existing record set.
images_attributes object[]
An array of one or more image objects to add to the record. You may provide your own file_url, or follow our Attaching Documents and Images guide to upload to our third party storage provider.
name string
Possible values: <= 255 characters
The name to give the image which will be shown in the UI.
file_url string
Possible values: <= 255 characters
The URL pointing to the image.
file_mime_type string
Possible values: <= 255 characters
The MIME type of the image. For example, image/png.
file_name string
Possible values: <= 255 characters
The name of the image.
file_size integer
The size of the image file in bytes.

Responses

Response Headers

application/json

Schema
Example (from schema)

Schema

id integer
created_at date-time
updated_at date-time
email string
The Contact's email address.
name string
The Contact's full name.
first_name string
The Contact's first name.
middle_name string
The Contact's middle name.
last_name string
The Contact's last name.
images_count integer
The number of images associated with this Contact.
documents_count integer
The number of documents associated with this Contact.
comments_count integer
The number of comments associated with this Contact.
group_id integer
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_name string
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchy string
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.
technician boolean
Whether or not the Contact is a Technician.
vehicle_operator boolean
Whether or not the Contact is a Vehicle Operator.
employee boolean
Whether or not the Contact is an Employee.
birth_date date
The Contact's birth date.
street_address string
The Contact's street address.
street_address_line_2 string
The Contact's street address line 2.
city string
The Contact's city.
region string
The Contact's region, state, or province.
postal_code string
The Contact's postal code, zip code, or equivalent.
country string
The Contact's country.
employee_number string
The Contact's employee number.
job_title string
Possible values: <= 255 characters
The Contact's job title.
license_class string
The Contact's driver's license class.
license_number string
The Contact's driver's license number.
license_state string
The locality which issued the Contact's license.
license_expiration date
The Contact's driver's license expiration date.
home_phone_number string
The Contact's home phone number.
mobile_phone_number string
The Contact's mobile phone number.
work_phone_number string
The Contact's work phone number.
other_phone_number string
Any other phone number for this Contact.
start_date date
When the Contact started working for the company, if applicable.
leave_date date
When the Contact left or will leave the company, if applicable.
hourly_labor_rate float
The Contact's hourly rate.
custom_fields object
*Full details on working with Custom Fields here.
attachment_permissions object
read_photos boolean
Indicates whether the user has read permission for photos.
manage_photos boolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents boolean
Indicates whether the user has read permission for documents.
manage_documents boolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url string
The URL of the Contact's default image/profile photo, if any.
user object
If the Contact is a Fleetio User, those details will be included here.
account_membership_id NullableId
Possible values: >= 1

{
  "id": 0,
  "created_at": "2024-11-21",
  "updated_at": "2024-11-21",
  "email": "string",
  "name": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "images_count": 0,
  "documents_count": 0,
  "comments_count": 0,
  "group_id": 0,
  "group_name": "string",
  "group_hierarchy": "Group 1|Group 2|Group 3",
  "technician": true,
  "vehicle_operator": true,
  "employee": true,
  "birth_date": "2023-03-14",
  "street_address": "123 Main St",
  "street_address_line_2": "Apt 1",
  "city": "string",
  "region": "string",
  "postal_code": "string",
  "country": "string",
  "employee_number": "string",
  "job_title": "string",
  "license_class": "string",
  "license_number": "string",
  "license_state": "string",
  "license_expiration": "2023-03-14",
  "home_phone_number": "string",
  "mobile_phone_number": "string",
  "work_phone_number": "string",
  "other_phone_number": "string",
  "start_date": "2024-11-21",
  "leave_date": "2024-11-21",
  "hourly_labor_rate": 0,
  "custom_fields": {},
  "attachment_permissions": {
    "read_photos": true,
    "manage_photos": true,
    "read_documents": true,
    "manage_documents": true
  },
  "default_image_url": "string",
  "user": {},
  "account_membership_id": 0
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (from schema)
Example

Schema

errors object
type
items string

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}