Other endpoints

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-other-endpoints"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9b8b485e-df2a-4959-8c16-36d30bd083b0/social-card.svg?v=3e7ae33eec8b" alt="Other endpoints" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/postal-address-groups

Address id -> user groups that may use it (absent = everyone)

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/postal-address-groups" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "map": {}
}
Schema
mapobjectrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/postal-address-groups

PUThttps://hermeticor.com/v1/postal-addresses/{id}/groups

Parameters

idstringpathrequired

Request body

application/json
groupIdsstring[]required
{
  "groupIds": [
    "string"
  ]
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/postal-addresses/{id}/groups" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"groupIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "groupIds": [
    "string"
  ]
}
Schema
groupIdsstring[]required
4XX Default Response

Same as 4XX · GET /v1/postal-address-groups

5XX Default Response

Same as 4XX · GET /v1/postal-address-groups

GEThttps://hermeticor.com/v1/postal-addresses/usable

Ids of the saved addresses the caller may pick (open ones, plus those of the caller's user groups)

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/postal-addresses/usable" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ids": [
    "string"
  ]
}
Schema
idsstring[]required
4XX Default Response

Same as 4XX · GET /v1/postal-address-groups

5XX Default Response

Same as 4XX · GET /v1/postal-address-groups

Updated