Sign in

v1

latestOpenAPI 3.0.02026-07-14311851.4 KB
Subscription Group

Insert Addresses by groupId

Insert address information of a given Subscription group, filtering by groupId.

post/subscriptions-group/{groupId}/addresses

Path parameters

groupIdstring required
Example:1

Group ID.

Headers

Acceptstring required

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

Content-Typestring required

Type of the content being sent.

Request body

addressIdstring required
addressNamestring required
addressTypestring required
citystring required
complementstring required
countrystring required
formattedAddressstring required
geoCoordinateinteger[] required
neighborhoodstring required
numberstring required
postalCodestring required
receiverNamestring required
referencestring required
statestring required
streetstring required

Example request

{
  "additionalComponents": [
    {
      "longName": "string",
      "shortName": "string",
      "types": [
        "string"
      ]
    }
  ],
  "addressId": "string",
  "addressName": "string",
  "addressType": "string",
  "city": "string",
  "complement": "string",
  "country": "string",
  "formattedAddress": "string",
  "geoCoordinate": [
    0
  ],
  "neighborhood": "string",
  "number": "string",
  "postalCode": "string",
  "receiverName": "string",
  "reference": "string",
  "state": "string",
  "street": "string"
}

Response

OK