Create Contact

POST 
https://secure.fleetio.com/api/v1/contacts

Creates a new contact

Request

application/json

Body

first_namestringrequired
The Contact's first name.
Possible values: <= 255 characters
last_namestring
The Contact's last name.
Possible values: <= 255 characters
birth_datedate
The Contact's birth date. We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14
group_namestring
The name of the Group this Contact belongs to.
Possible values: <= 255 characters
group_hierarchystring
A pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
middle_namestring
The Contact's middle name.
Possible values: <= 255 characters
emailstring
The Contact's email address.
Possible values: <= 255 characters
mobile_phone_numberstring
The Contact's mobile phone number.
Possible values: <= 255 characters
home_phone_numberstring
The Contact's home phone number.
Possible values: <= 255 characters
work_phone_numberstring
The Contact's work phone number.
Possible values: <= 255 characters
other_phone_numberstring
Any other phone number for this Contact.
Possible values: <= 255 characters
street_addressstring
The Contact's street address.
Possible values: <= 255 characters
Example: 123 Main St.
street_address_line_2string
The Contact's street address line 2.
Possible values: <= 255 characters
Example: Apt 1
citystring
The Contact's city.
Possible values: <= 255 characters
regionstring
The Contact's region, state, or province.
Possible values: <= 255 characters
postal_codestring
The Contact's postal code, zip code, or equivalent.
Possible values: <= 255 characters
countrystring
The Contact's country.
Possible values: <= 255 characters
employee_numberstring
*Must be unique
Possible values: <= 255 characters
job_titlestring
The Contact's job title.
Possible values: <= 255 characters
start_datedate
When the Contact started working for the company, if applicable. We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14
leave_datedate
When the Contact left or will leave the company, if applicable. We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14
vehicle_operatorboolean
Whether or not the Contact is a Vehicle Operator.
license_numberstring
The Contact's driver's license number.
Possible values: <= 255 characters
license_classstring
The Contact's driver's license class.
Possible values: <= 255 characters
license_statestring
The locality which issued the Contact's license.
Possible values: <= 255 characters
hourly_labor_ratefloat
The Contact's hourly labor rate.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
group_idId (integer)
Possible values: >= 1
license_expirationdate
The Contact's driver's license expiration date. We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14
employeeboolean
Whether or not the Contact is an Employee.
technicianboolean
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_namestring
The name of the Role to be assigned to the Contact. Must be an exact match of an existing Role.
vehicles_record_set_namestring
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_namestring
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_namestring
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_namestring
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_namestring
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. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.
Array [
namestring
The name to give the image which will be shown in the UI.
Possible values: <= 255 characters
file_urlstring
The URL obtained from our storage provider that points to the image.
Possible values: <= 255 characters
file_mime_typestring
The MIME type of the image. For example, image/png.
Possible values: <= 255 characters
file_namestring
The name of the image.
Possible values: <= 255 characters
file_sizeinteger
The size of the image file in bytes.
]

Responses

201

OK

Response Headers

application/json

Schema

Schema

idinteger

created_atdate-time

updated_atdate-time

emailstringnullable

The Contact's email address.

namestringnullable

The Contact's full name.

first_namestringnullable

The Contact's first name.

middle_namestringnullable

The Contact's middle name.

last_namestringnullable

The Contact's last name.

images_countinteger

The number of images associated with this Contact.

Possible values: >= 0

documents_countinteger

The number of documents associated with this Contact.

Possible values: >= 0

comments_countinteger

The number of comments associated with this Contact.

Possible values: >= 0

group_idintegernullable

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

group_namestringnullable

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

group_hierarchystringnullable

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.

Example: Group 1|Group 2|Group 3

technicianbooleannullable

Whether or not the Contact is a Technician.

vehicle_operatorbooleannullable

Whether or not the Contact is a Vehicle Operator.

employeebooleannullable

Whether or not the Contact is an Employee.

birth_datedatenullable

The Contact's birth date.

Example: 2023-03-14

street_addressstringnullable

The Contact's street address.

Example: 123 Main St

street_address_line_2stringnullable

The Contact's street address line 2.

Example: Apt 1

citystringnullable

The Contact's city.

regionstringnullable

The Contact's region, state, or province.

postal_codestringnullable

The Contact's postal code, zip code, or equivalent.

countrystringnullable

The Contact's country.

employee_numberstringnullable

The Contact's employee number.

job_titlestringnullable

The Contact's job title.

Possible values: <= 255 characters

license_classstringnullable

The Contact's driver's license class.

license_numberstringnullable

The Contact's driver's license number.

license_statestringnullable

The locality which issued the Contact's license.

license_expirationdatenullable

The Contact's driver's license expiration date.

Example: 2023-03-14

home_phone_numberstringnullable

The Contact's home phone number.

mobile_phone_numberstringnullable

The Contact's mobile phone number.

work_phone_numberstringnullable

The Contact's work phone number.

other_phone_numberstringnullable

Any other phone number for this Contact.

start_datedatenullable

When the Contact started working for the company, if applicable.

leave_datedatenullable

When the Contact left or will leave the company, if applicable.

hourly_labor_ratefloatnullable

The Contact's hourly rate.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

attachment_permissions objectnullable

read_photosboolean

Indicates whether the user has read permission for photos.

manage_photosboolean

Indicates whether the user has permission to manage (eg. upload, delete) photos.

read_documentsboolean

Indicates whether the user has read permission for documents.

manage_documentsboolean

Indicates whether the user has permission to manage (eg. upload, delete) documents.

default_image_urlstringnullable

The URL of the Contact's default image/profile photo, if any.

userobjectnullable

If the Contact is a Fleetio User, those details will be included here.

account_membership_idNullableId (integer)nullable

Possible values: >= 1

last_api_requestdate-timenullable

The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.

last_web_accessdate-timenullable

The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.

last_mobile_app_accessdate-timenullable

The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.

Example (auto)

{
  "id": 0,
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "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-07-29",
  "leave_date": "2024-07-29",
  "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,
  "last_api_request": "2024-07-29T15:51:28.071Z",
  "last_web_access": "2024-07-29T15:51:28.071Z",
  "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

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

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/contacts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "first_name": "string",
  "last_name": "string",
  "birth_date": "2023-03-14",
  "group_name": "string",
  "group_hierarchy": "string",
  "middle_name": "string",
  "email": "string",
  "mobile_phone_number": "string",
  "home_phone_number": "string",
  "work_phone_number": "string",
  "other_phone_number": "string",
  "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",
  "start_date": "2023-03-14",
  "leave_date": "2023-03-14",
  "vehicle_operator": true,
  "license_number": "string",
  "license_class": "string",
  "license_state": "string",
  "hourly_labor_rate": 0,
  "custom_fields": {},
  "group_id": 0,
  "license_expiration": "2023-03-14",
  "employee": true,
  "technician": true,
  "account_membership_attributes": {
    "role_name": "string",
    "vehicles_record_set_name": "string",
    "contacts_record_set_name": "string",
    "equipments_record_set_name": "string",
    "inspection_forms_record_set_name": "string",
    "parts_record_set_name": "string"
  },
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "first_name": "string",
  "last_name": "string",
  "birth_date": "2023-03-14",
  "group_name": "string",
  "group_hierarchy": "string",
  "middle_name": "string",
  "email": "string",
  "mobile_phone_number": "string",
  "home_phone_number": "string",
  "work_phone_number": "string",
  "other_phone_number": "string",
  "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",
  "start_date": "2023-03-14",
  "leave_date": "2023-03-14",
  "vehicle_operator": true,
  "license_number": "string",
  "license_class": "string",
  "license_state": "string",
  "hourly_labor_rate": 0,
  "custom_fields": {},
  "group_id": 0,
  "license_expiration": "2023-03-14",
  "employee": true,
  "technician": true,
  "account_membership_attributes": {
    "role_name": "string",
    "vehicles_record_set_name": "string",
    "contacts_record_set_name": "string",
    "equipments_record_set_name": "string",
    "inspection_forms_record_set_name": "string",
    "parts_record_set_name": "string"
  },
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!