Skip to main content

Create Contact

Creates a new contact.

info

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

Header Parameters
  • Partner-Token string
  • Organization-Token string

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 is admin.

  • enable_user boolean

    Whether this User is enabled.

  • user_type string

    Possible values: [admin, regular]

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

  • manage_users boolean

    Whether this User can manage other Users.

  • manage_subscription boolean

    Whether this User can manage subscriptions belonging to the Account.

  • export_account_data boolean

    Whether this User can export account data.

  • role_id integer

    The ID of the Role assigned to the User.

  • vehicles_record_set_id integer

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

  • contacts_record_set_id integer

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

  • equipments_record_set_id integer

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

  • inspection_forms_record_set_id integer

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

  • parts_record_set_id integer

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

  • role_name string

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

  • vehicles_record_set_name string

    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_name string

    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_name string

    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_name string

    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_name string

    The name of the Parts record set the User has access to. Must be an exact match of an existing record set.

  • invitation_message string

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

  • user_attributes object
  • email string

    The email address of the User.

  • username string

    The username of the User.

  • password string

    The password of the User.

  • default_image_attributes object
  • file_url string

    The URL pointing to the default image of the Contact.

  • default boolean

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

Responses

OK

Response Headers


    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 NullableId

      Possible values: >= 1

    • email string

      The email address associated with this User.

    • username string

      The username of this User.

    • time_zone string

      The timezone set for this User.

    • user_type string

      Possible values: [admin, regular]

      This User's type.

    • archived_at date-time

      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.

    • id NullableId

      Possible values: >= 1

    • name string
    • vehicles_record_set object
    • id NullableId

      Possible values: >= 1

    • name string
    • equipments_record_set object
    • id NullableId

      Possible values: >= 1

    • name string
    • contacts_record_set object
    • id NullableId

      Possible values: >= 1

    • name string
    • parts_record_set object
    • id NullableId

      Possible values: >= 1

    • name string
    • inspection_forms_record_set object
    • id NullableId

      Possible values: >= 1

    • name string
    Loading...