Sign in

v1

latestOpenAPI 3.0.02026-07-14311851.4 KB
Subscriptions

Insert Addresses for Subscription

Inserts address's information to complement the Subscription details.

post/subscriptions/{subscriptionId}/addresses

Path parameters

subscriptionIdstring required
Example:1

Subscription ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Request body

additionalComponentsstring nullable required
addressIdstring required
addressNamestring required
addressTypestring required
citystring required
complementstring nullable required
countrystring required
formattedAddressstring nullable required
geoCoordinatestring nullable required
neighborhoodstring required
numberstring required
postalCodestring required
receiverNamestring required
referencestring nullable required
statestring required
streetstring required

Example request

[
  {
    "additionalComponents": null,
    "addressId": "1234567890",
    "addressName": "xt5353818181nhshs",
    "addressType": "residential",
    "city": "Rio de Janeiro",
    "complement": null,
    "country": "BRA",
    "formattedAddress": null,
    "geoCoordinate": null,
    "neighborhood": "Barra da Tijuca",
    "number": "1",
    "postalCode": "22204-004",
    "receiverName": "Fulano",
    "reference": null,
    "state": "RJ",
    "street": "Avenida do Estado"
  }
]

Response

OK