Update an address

post

https://api.geoconcept.com/delivery/api/nd/missions/updateAddress

updates the specified address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

addressComplement

string

New address complement. Leave it null to let unchanged. Will be ignored if a Location object is provided.

addressType

string

Whether the address is used for pickup, delivery, or both. One of DELIVERY, PICKUP or BOTH, in any casing; any other value is rejected with INVALID_REQUEST. Omit the property to leave the stored value unchanged - this is a partial update - or send null or an empty string to clear the type. This differs from address creation, where an absent or empty value defaults to BOTH instead of clearing.

agencyId

string

allSkillsRequired

boolean

building

string

New building name. Leave it null to let unchanged, or send an empty string to clear it. Takes precedence over a building carried by the location object.

company

string

New company name. Leave it null to let unchanged, or send an empty string to clear it. Takes precedence over a company carried by the location object.

contractorId

string

Contractor of the address to update. This field is required to confirm which address is to be updated. It is possible to leave it blank, in which case the updated address will be searched in user's address list.

customData

object

Values of addresses' custom fields created by user. If an identifier does not correspond to any address custom field, it will be ignored.

daysBetweenMissions

int32

daysTolerance

int32

designation

string

New designation of the address. Leave it null to let unchanged. Will be ignored if a Location object is provided.

externId

string

Identifier of the address to update. Required.

fixedVisitDuration

string

Time, can be expressed in minutes or in hh:mm:ss format.

floor

string

New floor number. Leave it null to let unchanged, or send an empty string to clear it. Takes precedence over a floor carried by the location object.

frequency

string

geocodingThreshold

int32

If geocodingThreshold is set, an update with a geocoded score lower than the threshold is rejected. Must be between 0 and 100. Default is null (no check).

lastSucceededMissionDate

date

location

object

New location of the sub-contractor. Leave it null to let unchanged.

missionCustomData

object

Values of missions custom fields created by the user. map of [id,value] or [name,value] (depending on the value you set for CustomFieldRepresentation). These values will be used as default values for missions using this address.

nextParcelsDuration

string

Time, can be expressed in minutes or in hh:mm:ss format.

office

string

New office number. Leave it null to let unchanged, or send an empty string to clear it. Takes precedence over an office carried by the location object.

openingDays

array of strings

openingDays

openingHours

array of objects

openingHours

overrideGeoThreshold

boolean

If overrideGeoThreshold is true, an update whose geocoded score is under geocodingThreshold is still applied. Default is false.

priority

int32

quantities

array of doubles

quantities

requiredSkills

array of strings

requiredSkills

sector

string

sharedWithContractor

boolean

Whether this General BO Address Book entry is visible to contractor users. Omit it to leave the stored value unchanged - this is a partial update.

Headers

CustomFieldRepresentation

string

enum

Allowed:

UseHTTPCodeOnError

boolean

Defaults to false

Response

defaultResponse containing the updated address