Skip to main content

Create Location Entry

Create a new LocationEntry for a Vehicle or for a Contact. If you need to create many Location Entries at once, use the Bulk API to avoid Rate Limiting errors.

Request Body

    oneOf
  • contact_id integer required

    Possible values: >= 1

  • date date-time required

    We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • latitude Coordinate required

    Possible values: >= -90 and <= 90

  • longitude Coordinate required

    Possible values: >= -90 and <= 90

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.

    • account_id integer

      Possible values: >= 1

    • date date-time

      The date and time at which this Location Entry was recorded.

    • item_type string

      Possible values: [Vehicle, Contact]

      The type of object that this Location Entry is associated with.

    • item_id NullableId

      Possible values: >= 1

    • locatable_type string

      Possible values: [FuelEntry, ServiceEntry, SubmittedInspectionForm]

      The type of object that triggered the creation of this Location Entry, if applicable.

    • locatable_id NullableId

      Possible values: >= 1

    • contact_id NullableId

      Possible values: >= 1

    • address string

      The full address where this Location Entry took place.

    • address_components object
    • street_number string

      The street number in the address.

    • street string

      The street name in the address.

    • city string

      The city in the address.

    • region string

      The region, state or province in the address.

    • region_short string

      The abbreviated region, state or province code.

    • country string

      The country in the address.

    • country_short string

      The abbreviated country code.

    • postal_code string

      The postal code, ZIP, or equivalent in the address.

    • is_current boolean

      Indicates whether this Location Entry is the most recent one for this object.

    • location string

      A string representation of the recorded location.

    • account_membership_id NullableId

      Possible values: >= 1

    • vehicle_archived_at date-time

      The date and time at which the Vehicle associated with this Location Entry was archived, if applicable.

    • contact_archived_at date-time

      The date and time at which the Contact associated with this Location Entry was archived, if applicable.

    Loading...