Create an address

Method

POST

Path

addresses

Request Parameters

Name	Type	Description
end_subscriber_type	enum	Entity type of the end subscriber. Either 'company' or 'individual'.
company_name	string	Company name of address. Required if end_subscriber_type is 'company'.
first_name	string	First name of owner of address. Required if end_subscriber_type is 'individual'.
last_name	string	Last name of owner of address. Required if end_subscriber_type is 'individual'.
phone_number	string	Phone number of address owner
email_address	Email address	Email address of address owner
vat_number	string	Value Added Tax (VAT) number
street	string	Street name
street_number	string	Street number
residence	string	Residence name
floor	string	Floor number
box	string	Box number
postal_code	string	Postal/ZIP code
city	string	City name
state	string	State/province/territory name
country	Enum	2-letter ISO 3166 country code (e.g. 'GB' or 'DE')
service_usage	string	User-defined value describing use or purpose of address

Response

A JSON object with success, message, and data. The data attribute holds an Address object.

Sample Response

{
    "success": true,
    "message": "Address successfully created",
    "data": {
        "id": 51,
        "end_subscriber_type": "individual",
        "company_name": null,
        "first_name": "Max",
        "last_name": "Mustermann",
        "phone_number": null,
        "email_address": "user@example.com",
        "vat_number": null,
        "street": "Wilhelmstraße",
        "street_number": "123",
        "residence": null,
        "floor": null,
        "box": null,
        "postal_code": "12345",
        "city": "Berlin",
        "state": null,
        "country": "DE",
        "service_usage": null
    }
}