Create Contact
Creates a new contact.
account_membership_attributes
are only available to Fleetio partners with an Organization Token or Partner Token.
Header Parameters
- Partner-Token string
- Organization-Token string
- application/json
Request Body
- first_name string required
Possible values:
<= 255 characters
This Contact's first name.
- middle_name string
Possible values:
<= 255 characters
This Contact's middle name.
- last_name string
Possible values:
<= 255 characters
This Contact's last name.
- birth_date date
This Contact's birth date. We recommend using ISO-8601 formatted dates to avoid ambiguity.
- 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. - email string
Possible values:
<= 255 characters
This Contact's email address.
- mobile_phone_number string
Possible values:
<= 255 characters
This Contact's mobile phone number.
- home_phone_number string
Possible values:
<= 255 characters
This Contact's home phone number.
- work_phone_number string
Possible values:
<= 255 characters
This 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 street address of this Contact.
- street_address_line_2 string
Possible values:
<= 255 characters
The second line of this Contact's street address.
- city string
Possible values:
<= 255 characters
The city of this Contact's address.
- region string
Possible values:
<= 255 characters
The region, state, province, or territory of this Contact's address.
- postal_code string
Possible values:
<= 255 characters
The postal code for this Contact's address.
- country string
Possible values:
<= 255 characters
The country where this Contact resides.
- employee_number string
Possible values:
<= 255 characters
This Contact's employee number. Must be unique.
- job_title string
Possible values:
<= 255 characters
This Contact's job title.
- start_date date
The date at which this Contact started, or is expected to start. We recommend using ISO-8601 formatted dates to avoid ambiguity.
- leave_date date
The date at which this Contact left, or is expected to leave. We recommend using ISO-8601 formatted dates to avoid ambiguity.
- vehicle_operator boolean
Whether this Contact is a Vehicle Operator.
- license_number string
Possible values:
<= 255 characters
The license number of this Contact.
- license_class string
Possible values:
<= 255 characters
The class of this Contact's license.
- license_state string
Possible values:
<= 255 characters
The state, province, region, or territory of this Contact's license.
- hourly_labor_rate float
The hourly labor rate for this Contact.
- custom_fields object
*Full details on working with Custom Fields here.
- group_id integer
Possible values:
>= 1
- license_expiration date
The date and time at which this Contact's license expires. We recommend using ISO-8601 formatted dates to avoid ambiguity.
- employee boolean
Whether this Contact is an Employee.
- technician boolean
Whether this Contact is a Technician.
- user_access string
Possible values: [
true
,false
]Whether this Contact has User Access. This must be set to "true" if using
account_membership_attributes
. - invite_user boolean
Whether to send this person a User Invitation.
- delay_invite boolean
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
isadmin
.admin_role_attributes
will be ignored ifuser_type
is notadmin
.enable_user booleanWhether this
User
is enabled.user_type stringPossible values: [
admin
,regular
]Any role or record set attributes will be ignored if this is set to
admin
.role_id integerThe ID of the
Role
assigned to theUser
.vehicles_record_set_id integerThe ID of the
Vehicles
record set theUser
has access to.contacts_record_set_id integerThe ID of the
Contacts
record set theUser
has access to.equipments_record_set_id integerThe ID of the
Equipment
record set theUser
has access to.inspection_forms_record_set_id integerThe ID of the
Inspection Forms
record set theUser
has access to.parts_record_set_id integerThe ID of the
Parts
record set theUser
has access to.role_name stringThe name of the
Role
to be assigned to theUser
. Must be an exact match of an existingRole
.vehicles_record_set_name stringThe name of the
Vehicles
record set theUser
has access to. Must be an exact match of an existing record set.contacts_record_set_name stringThe name of the
Contacts
record set theUser
has access to. Must be an exact match of an existing record set.equipments_record_set_name stringThe name of the
Equipment
record set theUser
has access to. Must be an exact match of an existing record set.inspection_forms_record_set_name stringThe name of the
Inspection Forms
record set theUser
has access to. Must be an exact match of an existing record set.parts_record_set_name stringThe name of the
Parts
record set theUser
has access to. Must be an exact match of an existing record set.invitation_message stringIf this person is being invited, this is the message that will be sent to them.
admin_role_attributes object
Permissions for the
User
if theuser_type
isadmin
.inforequired if
user_type
isadmin
administration_access stringPossible values: [
full
,some
,none
]The level of access for the administration section. When setting as full all administration management permissions will be granted.
manage_account_settings booleanWhether this
User
can manage account settings.manage_subscription booleanWhether this
User
can manage subscriptions belonging to theAccount
.export_account_data booleanWhether this
User
can export account data.manage_groups booleanWhether this
User
can manageGroups
.manage_workflows booleanWhether this
User
can manageAutomations
.manage_webhooks booleanWhether this
User
can manageWebhooks
.manage_integrations booleanWhether this
User
can manageIntegrations
.manage_integration_links booleanWhether this
User
can manageIntegration Links
.manage_saml_connectors booleanWhether this
User
can manageSAML Connectors
.manage_security_settings booleanWhether this
User
can manage Security Settings.user_management_access stringPossible values: [
full
,some
,none
]The level of access for the user management section. When setting as full all user management permissions will be granted.
manage_users booleanWhether this
User
can manage otherUsers
.user_attributes object
email stringThe email address of the
User
.username stringThe username of the
User
.password stringThe password of the
User
.default_image_attributes object
file_url stringThe URL pointing to the default image of the Contact.
default booleanWhether the image should be set as the default image of the Contact.
- 201
- 401
- 403
- 422
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- id integer
Possible values:
>= 1
- created_at date-time
The date and time at which this record was created.
- updated_at date-time
The date and time at which this record was most recently updated.
- name string
The Contact's full name.
- first_name string
The Contact's first name.
- middle_name string
The Contact's middle name.
- 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.
- 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. - email string
The Contact's email address.
- technician boolean
Whether this Contact is a Technician.
- vehicle_operator boolean
Whether this Contact is a Vehicle Operator.
- employee boolean
Whether this 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 second line of the Contact's street address.
- city string
The Contact's city.
- region string
The Contact's region.
- postal_code string
The Contact's postal code.
- 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 license class.
- license_number string
The Contact's license number.
- license_state string
The state 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 mobile phone number belonging to this Contact.
- start_date date
The Contact's start date.
- leave_date date
The Contact's leave date.
- hourly_labor_rate float
The Contact's hourly rate.
- custom_fields object
*Full details on working with Custom Fields here.
- default_image_url string
The URL pointing to the default image for this Contact.
- account_membership_id NullableId
Possible values:
>= 1
user object
id NullableIdPossible values:
>= 1
email stringThe email address associated with this
User
.username stringThe username of this
User
.time_zone stringThe timezone set for this
User
.user_type stringPossible values: [
admin
,regular
]This
User
's type.archived_at date-timeThe date and time at which the User was archived (deactivated). If
null
, the User is not deactivated.role object
Basic information about this
User
'sRole
, if applicable.id NullableIdPossible values:
>= 1
name stringvehicles_record_set object
id NullableIdPossible values:
>= 1
name stringequipments_record_set object
id NullableIdPossible values:
>= 1
name stringcontacts_record_set object
id NullableIdPossible values:
>= 1
name stringparts_record_set object
id NullableIdPossible values:
>= 1
name stringinspection_forms_record_set object
id NullableIdPossible values:
>= 1
name string
{
"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-09-06",
"leave_date": "2024-09-06",
"hourly_labor_rate": 0,
"custom_fields": {},
"default_image_url": "string",
"account_membership_id": 0,
"user": {
"id": 0,
"email": "string",
"username": "string",
"time_zone": "string",
"user_type": "admin",
"archived_at": "2024-09-06",
"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"
}
}
}
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
typeitems 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"
}