Create Contact

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

Creates a new contact.

info

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

Request

Header Parameters

Partner-Token PartnerToken
Organization-Token OrganizationToken

application/json

Body

first_namestringrequired

This Contact's first name.

Possible values: <= 255 characters

middle_namestring

This Contact's middle name.

Possible values: <= 255 characters

last_namestring

This Contact's last name.

Possible values: <= 255 characters

birth_datedate

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

Example: 1950-05-05

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

emailstring

This Contact's email address.

Possible values: <= 255 characters

mobile_phone_numberstring

This Contact's mobile phone number.

Possible values: <= 255 characters

home_phone_numberstring

This Contact's home phone number.

Possible values: <= 255 characters

work_phone_numberstring

This 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 street address of this Contact.

Possible values: <= 255 characters

street_address_line_2string

The second line of this Contact's street address.

Possible values: <= 255 characters

citystring

The city of this Contact's address.

Possible values: <= 255 characters

regionstring

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

Possible values: <= 255 characters

postal_codestring

The postal code for this Contact's address.

Possible values: <= 255 characters

countrystring

The country where this Contact resides.

Possible values: <= 255 characters

employee_numberstring

This Contact's employee number. Must be unique.

Possible values: <= 255 characters

job_titlestring

This Contact's job title.

Possible values: <= 255 characters

start_datedate

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

Example: 2023-09-09

leave_datedate

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

Example: 2023-12-12

vehicle_operatorboolean

Whether this Contact is a Vehicle Operator.

license_numberstring

The license number of this Contact.

Possible values: <= 255 characters

license_classstring

The class of this Contact's license.

Possible values: <= 255 characters

license_statestring

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

Possible values: <= 255 characters

hourly_labor_ratefloat

The hourly labor rate for this Contact.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

group_idId (integer)

Possible values: >= 1

license_expirationdate

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

Example: 2024-03-14

employeeboolean

Whether this Contact is an Employee.

technicianboolean

Whether this Contact is a Technician.

user_accessstring

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

Possible values: [true, false]

invite_userboolean

Whether to send this person a User Invitation.

delay_inviteboolean

If this person is being invited to the Account, this flag will delay the invitation email until a future time of your choosing.

account_membership_attributes object

These attributes require an Organization Token or Partner Token to be present in the request. Any role or record set attributes will be ignored if user_type is admin. admin_role_attributes will be ignored if user_type is not admin.

enable_userboolean

Whether this User is enabled.

user_typestring

Any role or record set attributes will be ignored if this is set to admin.

Possible values: [admin, regular]

role_idinteger

The ID of the Role assigned to the User.

vehicles_record_set_idinteger

The ID of the Vehicles record set the User has access to.

contacts_record_set_idinteger

The ID of the Contacts record set the User has access to.

equipments_record_set_idinteger

The ID of the Equipment record set the User has access to.

inspection_forms_record_set_idinteger

The ID of the Inspection Forms record set the User has access to.

parts_record_set_idinteger

The ID of the Parts record set the User has access to.

role_namestring

The name of the Role to be assigned to the User. Must be an exact match of an existing Role.

vehicles_record_set_namestring

The name of the Vehicles record set the User 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 User 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 User 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 User 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 User has access to. Must be an exact match of an existing record set.

invitation_messagestring

If this person is being invited, this is the message that will be sent to them.

admin_role_attributes object

Permissions for the User if the user_type is admin.

:::info required if user_type is admin :::

administration_accessstring

The level of access for the administration section. When setting as full all administration management permissions will be granted.

Possible values: [full, some, none]

manage_account_settingsboolean

Whether this User can manage account settings.

manage_subscriptionboolean

Whether this User can manage subscriptions belonging to the Account.

export_account_databoolean

Whether this User can export account data.

manage_groupsboolean

Whether this User can manage Groups.

manage_workflowsboolean

Whether this User can manage Automations.

manage_webhooksboolean

Whether this User can manage Webhooks.

manage_integrationsboolean

Whether this User can manage Integrations.

manage_integration_linksboolean

Whether this User can manage Integration Links.

manage_saml_connectorsboolean

Whether this User can manage SAML Connectors.

manage_security_settingsboolean

Whether this User can manage Security Settings.

user_management_accessstring

The level of access for the user management section. When setting as full all user management permissions will be granted.

Possible values: [full, some, none]

manage_usersboolean

Whether this User can manage other Users.

user_attributes object

emailstring

The email address of the User.

usernamestring

The username of the User.

passwordstring

The password of the User.

default_image_attributes object

file_urlstring

The URL pointing to the default image of the Contact.

defaultboolean

Whether the image should be set as the default image of the Contact.

Responses

201

OK

Response Headers

application/json

Schema

Schema

idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
namestringnullablerequired
The Contact's full name.
first_namestringnullablerequired
The Contact's first name.
middle_namestringnullablerequired
The Contact's middle name.
group_idintegernullablerequired
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_namestringnullablerequired
If this Contact belongs to a Group, this will be the Group's name.
last_namestringnullablerequired
The Contact's last name.
images_countintegerrequired
The number of images associated with this Contact.
documents_countintegerrequired
The number of documents associated with this Contact.
comments_countintegerrequired
The number of Comments associated with this Contact.
emailstringnullable
The Contact's email address.
technicianbooleannullable
Whether this Contact is a Technician.
vehicle_operatorbooleannullable
Whether this Contact is a Vehicle Operator.
employeebooleannullable
Whether this Contact is an Employee.
birth_datedatenullable
The Contact's birth date.
Example: 2023-03-14
street_addressstringnullable
The Contact's street address.
street_address_line_2stringnullable
The second line of the Contact's street address.
citystringnullable
The Contact's city.
regionstringnullable
The Contact's region.
postal_codestringnullable
The Contact's postal code.
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 license class.
license_numberstringnullable
The Contact's license number.
license_statestringnullable
The state 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 mobile phone number belonging to this Contact.
start_datedatenullable
The Contact's start date.
leave_datedatenullable
The Contact's leave date.
hourly_labor_ratefloatnullable
The Contact's hourly rate.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
default_image_urlstringnullablerequired
The URL pointing to the default image for this Contact.
account_membership_idNullableId (integer)nullable
Possible values: >= 1
archived_atdate-timenullable
The date and time at which this Contact was archived, if applicable. null if this Contact is not archived.
Example: 2023-03-14T13:46:27-06:00
user objectnullablerequired
idNullableId (integer)nullable
Possible values: >= 1
emailstringnullable
The email address associated with this User.
usernamestringnullable
The username of this User.
time_zonestringnullable
The timezone set for this User.
user_typestringnullable
This User's type.
Possible values: [admin, regular, owner]
archived_atdate-timenullable
The date and time at which the User was archived (deactivated). If null, the User is not deactivated.
role object
Basic information about this User's Role, if applicable.
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
vehicles_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
equipments_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
contacts_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
parts_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
inspection_forms_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "name": "string",
  "first_name": "string",
  "middle_name": "string",
  "group_id": 0,
  "group_name": "string",
  "last_name": "string",
  "images_count": 0,
  "documents_count": 0,
  "comments_count": 0,
  "email": "string",
  "technician": true,
  "vehicle_operator": true,
  "employee": true,
  "birth_date": "2023-03-14",
  "street_address": "string",
  "street_address_line_2": "string",
  "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": {},
  "default_image_url": "string",
  "account_membership_id": 0,
  "archived_at": "2023-03-14T13:46:27-06:00",
  "user": {
    "id": 0,
    "email": "string",
    "username": "string",
    "time_zone": "string",
    "user_type": "admin",
    "archived_at": "2024-07-29T15:51:28.071Z",
    "role": {
      "id": 0,
      "name": "string"
    },
    "vehicles_record_set": {
      "id": 0,
      "name": "string"
    },
    "equipments_record_set": {
      "id": 0,
      "name": "string"
    },
    "contacts_record_set": {
      "id": 0,
      "name": "string"
    },
    "parts_record_set": {
      "id": 0,
      "name": "string"
    },
    "inspection_forms_record_set": {
      "id": 0,
      "name": "string"
    }
  }
}

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/v2/contacts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "birth_date": "1950-05-05",
  "group_hierarchy": "Group 1|Group 2|Group 3",
  "email": "string",
  "mobile_phone_number": "string",
  "home_phone_number": "string",
  "work_phone_number": "string",
  "other_phone_number": "string",
  "street_address": "string",
  "street_address_line_2": "string",
  "city": "string",
  "region": "string",
  "postal_code": "string",
  "country": "string",
  "employee_number": "string",
  "job_title": "string",
  "start_date": "2023-09-09",
  "leave_date": "2023-12-12",
  "vehicle_operator": true,
  "license_number": "string",
  "license_class": "string",
  "license_state": "string",
  "hourly_labor_rate": 0,
  "custom_fields": {},
  "group_id": 0,
  "license_expiration": "2024-03-14",
  "employee": true,
  "technician": true,
  "user_access": "true",
  "invite_user": true,
  "delay_invite": true,
  "account_membership_attributes": {
    "enable_user": true,
    "user_type": "admin",
    "role_id": 0,
    "vehicles_record_set_id": 0,
    "contacts_record_set_id": 0,
    "equipments_record_set_id": 0,
    "inspection_forms_record_set_id": 0,
    "parts_record_set_id": 0,
    "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",
    "invitation_message": "string",
    "admin_role_attributes": {
      "administration_access": "full",
      "manage_account_settings": true,
      "manage_subscription": true,
      "export_account_data": true,
      "manage_groups": true,
      "manage_workflows": true,
      "manage_webhooks": true,
      "manage_integrations": true,
      "manage_integration_links": true,
      "manage_saml_connectors": true,
      "manage_security_settings": true,
      "user_management_access": "full",
      "manage_users": true
    },
    "user_attributes": {
      "email": "string",
      "username": "string",
      "password": "string"
    }
  },
  "default_image_attributes": {
    "file_url": "string",
    "default": true
  }
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

Partner-Token — header

Organization-Token — header

Body

{
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "birth_date": "1950-05-05",
  "group_hierarchy": "Group 1|Group 2|Group 3",
  "email": "string",
  "mobile_phone_number": "string",
  "home_phone_number": "string",
  "work_phone_number": "string",
  "other_phone_number": "string",
  "street_address": "string",
  "street_address_line_2": "string",
  "city": "string",
  "region": "string",
  "postal_code": "string",
  "country": "string",
  "employee_number": "string",
  "job_title": "string",
  "start_date": "2023-09-09",
  "leave_date": "2023-12-12",
  "vehicle_operator": true,
  "license_number": "string",
  "license_class": "string",
  "license_state": "string",
  "hourly_labor_rate": 0,
  "custom_fields": {},
  "group_id": 0,
  "license_expiration": "2024-03-14",
  "employee": true,
  "technician": true,
  "user_access": "true",
  "invite_user": true,
  "delay_invite": true,
  "account_membership_attributes": {
    "enable_user": true,
    "user_type": "admin",
    "role_id": 0,
    "vehicles_record_set_id": 0,
    "contacts_record_set_id": 0,
    "equipments_record_set_id": 0,
    "inspection_forms_record_set_id": 0,
    "parts_record_set_id": 0,
    "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",
    "invitation_message": "string",
    "admin_role_attributes": {
      "administration_access": "full",
      "manage_account_settings": true,
      "manage_subscription": true,
      "export_account_data": true,
      "manage_groups": true,
      "manage_workflows": true,
      "manage_webhooks": true,
      "manage_integrations": true,
      "manage_integration_links": true,
      "manage_saml_connectors": true,
      "manage_security_settings": true,
      "user_management_access": "full",
      "manage_users": true
    },
    "user_attributes": {
      "email": "string",
      "username": "string",
      "password": "string"
    }
  },
  "default_image_attributes": {
    "file_url": "string",
    "default": true
  }
}

ResponseClear

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