Locations

Update location by ID

Changed on

Update a location

put/locations/{locationId}

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/locations/{locationId}
  • Auth
    API key in header x-api-key

Path parameters

locationIdstring required

Request body

object_typestring required

Object type which location is.

object_idinteger required

Existing object id.

titlestring required
address_1string nullable
address_2string nullable
citystring nullable
statestring nullable
zip_codestring nullable
notesstring nullable
is_main_locationboolean
is_primary_locationboolean
primary_customer_contact_idinteger

Existing customer contact id.

Response

Successful response

errorboolean

false when the request succeeds.

responseobject

The updated record.

Changes

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property