v1

latestOpenAPI 3.0.02026-07-1427437.7 KB

Addresses

Create client address

Creates new address for a given client profile.

The id field returned by this request is the addressId used to retrieve or update information of a specific address later.

Learn more about the Profile System and its other API endpoints.

post/api/storage/profile-system/profiles/{profileId}/addresses

Path parameters

profileIdstring required

Example:70caf394-8534-447e-a0ca-1803c669c771

ID of the client's profile as returned by the Create profile endpoint's response, in the id field. It can also be an alternativeKey according to your custom profile schema. In this case, this request should also send the alternativeKey parameter.

Query parameters

alternativeKeystring

Example:email

The profileId path parameter may be substituted by other profile fields in this request. When making this request, send the alternativeKey parameter with a value equal to the key of the field you wish to use as profileId.

Currently, there are two possible values for this parameter: email and document.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

administrativeAreaLevel1string required

Name of administrative area, such as the state or province.

countryCodestring

Two letter country code.

countryNamestring required

Name of the address country.

localitystring required

Name of address locality, such as the city.

localityAreaLevel1string required

Name of the address locality area, such as the neighborhood or district.

postalCodestring required

Address postal code.

routestring required

Address route or street name.

streetNumberstring required

Address street number.

Example request

{
  "administrativeAreaLevel1": "RJ",
  "countryCode": "BR",
  "countryName": "Brasil",
  "locality": "Locality",
  "localityAreaLevel1": "Locality area",
  "postalCode": "20200-000",
  "route": "51",
  "streetNumber": "999"
}

Response

Created

object required