Addresses

Once a tenant has a subscription, you have to define one or more physical addresses at subscription level. These addresses will be then linked to one or more numbers in the subscription. This allows our customers to be compliant with the emergency law.

List all addresses of a subscription

Use this endpoint to retrieve all addresses currently assigned to a subscription.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses

Authorization

Required role

tenants.instance.subscriptions.instance.addresses.list

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant to which the subscription belongs
`sub_id`	`integer`	Index of the subscription for which you want to list the addresses

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through full_address that look like the string passed	no
`sort`	`string`	Allows to specify one searchable property of an address to apply a sorting operation	no
`dir`	`string`	When performing a sort operation, specifies the type. Allowed values are `asc` for ascending (default) or `desc` for descending	no
`page_size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 10)	no
`page`	`integer`	Used for pagination, determines the returned page from the collection of result pages (defaults to 1)	no

Response

Status codes

Parameter	Description
`200`	One or more addresses found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`addresses`	`array`	List containing all addresses found for the subscription	no

Address Object

Parameter	Type	Description	Conditional?
`id`	`integer`	Index of the address	no
`address`	`string`	Full address	no
`data`	`object`	An address data object	no
`format`	`string`	The address format type	no
`full_address`	`string`	The full address	no
`assigned`	`boolean`	Indicates whether or not the address is currently in use	no
`assignedTo`	`string`	Provides information to which phone number the address is connected. This information is only provided when the address is assigned. See assignedTo object	no

Address Data Object

Parameter	Type	Description	Conditional?
`number`	`string`	The address number. Accepts digits, characters, space, -, /.	no
`street`	`string`	The street	no
`city`	`string`	The city	no
`state`	`string`	The state	no
`postalCode`	`integer`	The postal code	no
`country`	`string`	The country	no
`isoCode`	`string`	The isoCode	no

Address Format Type

Name of the address format type.

Value in enumeration:

google

AssignedTo Object

Parameter	Type	Description	Conditional?
`ref`	`string`	The assigned phone number in e164 format	no
`to`	`integer`	ID referring to the phone number which the address is assigned	no

Example

json

{
    "addresses": [
        {
            "assigned": false,
            "assignedTo": {},
            "id": 1,
            "data": {
                "number": 12,
                "street": "Rue du Trône",
                "city": "Bruxelles",
                "state": "Bruxelles",
                "postalCode": 1050,
                "country": "Belgium",
                "isoCode": "BE"
            },
            "format": "google",
            "full_address": "Rue du Trône, 12, Bruxelles"
        }
    ]
}

List all addresses of an entity

Use this endpoint to retrieve all addresses of all subscriptions belonging (directly or indirectly) to a group, distributor, reseller or tenant.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups/{uuid}/addresses

GET /api/v01/draas/{draas_instance}/distributors/{uuid}/addresses

GET /api/v01/draas/{draas_instance}/resellers/{uuid}/addresses

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/addresses

Authorization

Required role

groups.instance.addresses.list

distributors.instance.addresses.list

resellers.instance.addresses.list

tenants.instance.addresses.list

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group, distributor, reseller or tenant

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through full_address that look like the string passed	no
`page_size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 10)	no
`next`	`string`	A token used to get the next records in the list. This token is taken back from the results of the previous call	no

Response

Status codes

Parameter	Description
`200`	One or more addresses found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`addresses`	`array`	List containing all addresses found for the entity	no
`next`	`string`	A token used for infinite scrolling, to be used in the next call to retrieve subsequent records. Only present if the list of addresses has to be continued	yes

Example

json

{
    "addresses": [
        {
            "id": 1,
            "data": {
                "number": 12,
                "street": "Rue du Trône",
                "city": "Bruxelles",
                "state": "Bruxelles",
                "postalCode": 1050,
                "country": "Belgium",
                "isoCode": "BE"
            },
            "format": "google",
            "full_address": "Rue du Trône, 12, Bruxelles"
        }
    ],
    "next": "cGFnZV9zaXplPTI0JnBhZ2U9Mg=="
}

Get a specific address

The following endpoint returns a specific address.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses/{id}

Authorization

Required role

tenants.instance.subscription.instance.addresses.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant for which you want to get its subscriptions
`sub_id`	`integer`	Index of the subscription for which you want to update a address
`id`	`integer`	Index of the address you want to retrieve

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	The address if found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No address found
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`id`	`integer`	Index of the address	no
`address`	`string`	Full address	no
`data`	`object`	An address data object	no
`format`	`string`	The address format type	no
`full_address`	`string`	The full address	no

Example

json

{
    "id": 1,
    "data": {
        "number": 12,
        "street": "Rue du Trône",
        "city": "Bruxelles",
        "state": "Bruxelles",
        "postalCode": 1050,
        "country": "Belgium",
        "isoCode": "BE"
    },
    "format": "google",
    "full_address": "Rue du Trône, 12, Bruxelles"
}

Create a new address

Use this endpoint to create a new address

Request

Endpoint

POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses

Authorization

Required role

tenants.instance.subscriptions.instance.addresses.create

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant to which the subscription belongs
`sub_id`	`integer`	Index of the subscription to which you want to add a address

URL/Query parameters

N/A

Body

Parameter	Type	Description	Conditional?
`data`	`object`	An address data object	no
`format`	`string`	The address format type	no
`full_address`	`string`	The full address	no

Example

json

{
    "data": {
        "number": 12,
        "street": "Rue du Trône",
        "city": "Bruxelles",
        "state": "Bruxelles",
        "postalCode": 1050,
        "country": "Belgium",
        "isoCode": "BE"
    },
    "format": "google"
}

Response

Status codes

Parameter	Description
`201`	The address was created successfully
`400`	Error while creating the address
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`id`	`integer`	Index of the address	no
`address`	`string`	Full address	no
`data`	`object`	An address data object	no
`format`	`string`	The address format type	no
`full_address`	`string`	The full address	no

Example

json

{
    "id": 1,
    "data": {
        "number": 12,
        "street": "Rue du Trône",
        "city": "Bruxelles",
        "state": "Bruxelles",
        "postalCode": 1050,
        "country": "Belgium",
        "isoCode": "BE"
    },
    "format": "google",
    "full_address": "Rue du Trône, 12, Bruxelles"
}

Modify an existing address

Use this endpoint to modify an existing address for a subscription.

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses/{id}

Authorization

Required role

tenants.instance.subscriptions.instance.addresses.instance.update

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant for which you want to modify the address
`sub_id`	`integer`	Index of the subscription for which you want to update a address
`id`	`integer`	Index of the address you want to update

<URL/Query parameters>

N/A

Body

Parameter	Type	Description	Conditional?
`data`	`object`	An address data object	no
`format`	`string`	The address format type	no
`full_address`	`string`	The full address	no

Example

json

{
    "data": {
        "number": 15,
        "street": "Rue du Trône",
        "city": "Bruxelles",
        "state": "Bruxelles",
        "postalCode": 1050,
        "country": "Belgium",
        "isoCode": "BE"
    },
    "format": "google"
}

Response

Status codes

Parameter	Description
`200`	The address was updated successfully
`400`	Error while updating the address
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	The address does not exist
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`id`	`integer`	Index of the address	no
`address`	`string`	Full address	no
`data`	`object`	An address data object	no
`format`	`string`	The address format type	no
`full_address`	`string`	The full address	no

Example

json

{
    "id": 1,
    "data": {
        "number": 15,
        "street": "Rue du Trône",
        "city": "Bruxelles",
        "state": "Bruxelles",
        "postalCode": 1050,
        "country": "Belgium",
        "isoCode": "BE"
    },
    "format": "google",
    "full_address": "Rue du Trône, 15, Bruxelles"
}

Delete a address

Use this endpoint to delete an existing address for a subscription on the platform.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses/{id}

Authorization

Required role

tenants.instance.subscriptions.instance.addresses.instance.delete

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant that owns the subscription
`sub_id`	`integer`	Index of the subscription for which you want to delete a address
`id`	`integer`	Index of the address you want to delete

URL/Query parameters

N/A

Body

N/A

Response

Status codes

Parameter	Description
`204`	The address was deleted successfully. If the address didn't exist, delete will be considered as being executed successfully
`400`	Error while deleting the address
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Delete multiple addresses

Use this endpoint to delete one or more existing addresses of a subscription in one call.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses

Authorization

Required role

tenants.instance.subscriptions.instance.addresses.delete

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant that owns the subscription
`sub_id`	`integer`	Index of the subscription for which you want to delete the addresses

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`addresses`	`array`	List of indexes (`integer`) of the addresses to delete, as returned by this API	yes

Example

json

{
    "addresses": [1, 4, 7]
}

Response

Status codes

Parameter	Description
`204`	The addresses were deleted successfully
`400`	Error while deleting the addresses
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Bulk create addresses

Bulk API to handle addresses.

This endpoint internally will call the create APIs. This means that, once completed, a notification will be sent through email (if enabled).

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses/bulk

Authorization

Required role

tenants.instance.subscriptions.instance.addresses.bulk

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`subscription_id`	`integer`	Index of a subscription to manage the bulk job for

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	Bulk job descriptive name	yes
`data`	`array`	List of addresses bulk data objects to be updated	yes

Example

json

{
  "bulks": [
    {
      "created_on": "2025-09-04T14:27:50.277639",
      "id": 40,
      "job_id": "1756996070",
      "kind": "addresses",
      "status": "success",
      "success_count": 1,
      "title": "Create address",
      "total_count": 1,
      "updated_on": "2025-09-04T14:27:50.715226"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Response

Status codes

Parameter	Description
`200`	All address numbers were successfully updated
`400`	None of address numbers were successfully updated
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	The path tenant / subscription doesn't exist
`500`	Uncaught error on server side

Body

Parameter	Type	Description	Conditional?
`code`	`integer`	Error code (see below for a complete error list)	no
`reason`	`string`	Message providing more context to the error that occurred	no

Success example

json

{
    "code": 3076,
    "reason": "Addresses bulk provisioning process is started"
}

Get address numbers bulk jobs history

Retrieve the history of address numbers bulk jobs runs related to the given subscription.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/addresses/bulk_jobs

Authorization

Required role

tenants.instance.subscriptions.instance.addresses.bulk.jobs

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`subscription_id`	`integer`	Index of a subscription to retrieve the bulk jobs history for

URL/Query parameters

Parameter	Type	Description	Required
`page_size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 10)	no
`next`	`string`	A token used to get the next records in the list. This token is taken back from the results of the previous call	no
`search`	`string`	A case insensitive search on the bulk job `title` or `kind` (that contains the passed value)	no
`filters`	`array`	An object representing the conditions to filter out the results	no

Response

Status codes

Parameter	Description
`200`	The list of the bulk jobs has been retrieved
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No bulk history found or the path tenant / subscription doesn't exist
`500`	Uncaught error on server side

Success

Body

Parameter	Type	Description	Conditional?
`bulks`	`array`	The list of the bulk jobs related to the given `subscription_id`	no
`results`	`integer`	Total number of bulk jobs retrieved	no
`pages`	`integer`	Total number of pages	no
`page`	`integer`	Current page	no
`next`	`string`	A token used for infinite scrolling, to be used in the next call to retrieve subsequent records. Only present if the list of bulk jobs has to be continued	yes

Example

json

{
  "created_on": "2025-09-04T14:27:50.277639",
  "id": 40,
  "job_id": "1756996070",
  "job_items": [
    {
      "created_on": "2025-09-04T14:27:50.854857",
      "data": {
        "city": "Bruxelles",
        "country": "Belgium",
        "isoCode": "BE",
        "number": 5,
        "postalCode": 10650,
        "state": "Bruxelles",
        "street": "Rue de la Mer"
      },
      "id": 3,
      "key": "Rue de la Mer, 5, Bruxelles, Belgium",
      "status": "success",
      "updated_on": "2025-09-04T14:27:50.854857"
    }
  ],
  "kind": "addresses",
  "status": "success",
  "success_count": 1,
  "title": "Create address",
  "total_count": 1,
  "updated_on": "2025-09-04T14:27:50.715226"
}

Bulk update address numbers

Bulk API to handle address to numbers assignations.

This endpoint internally will call the update APIs. This means that, once completed, a notification will be sent through email (if enabled).

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/address_numbers/bulk

Authorization

Required role

tenants.instance.subscriptions.instance.address_numbers.bulk

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`subscription_id`	`integer`	Index of a subscription to retrieve the manage the bulk job for

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	Bulk job descriptive name	yes
`data`	`array`	List of address numbers bulk data objects to be updated	yes

Example

json

{
  "name": "Bulk assign address to number",
  "data": [
    {
        "full_address": "Rue de la Mer, 5, Bruxelles, Belgium",
        "number": "+3226260128"
    },
    {
        "full_address": "Rue de la Mer, 5, Bruxelles, Belgium",
        "number": "+3226260130"
    }
  ]
}

Response

Status codes

Parameter	Description
`200`	All address numbers were successfully updated
`400`	None of address numbers were successfully updated
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	The path tenant / subscription doesn't exist
`500`	Uncaught error on server side

Body

Parameter	Type	Description	Conditional?
`code`	`integer`	Error code (see below for a complete error list)	no
`reason`	`string`	Message providing more context to the error that occurred	no

Success example

json

{
    "code": 3067,
    "reason": "Address Numbers bulk provisioning process is started"
}

Get address numbers bulk jobs history

Retrieve the history of address numbers bulk jobs runs related to the given subscription.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/address_numbers/bulk_jobs

Authorization

Required role

tenants.instance.subscriptions.instance.address_numbers.bulk.jobs

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the tenant managing the subscription
`subscription_id`	`integer`	Index of a subscription to retrieve the bulk jobs history for

URL/Query parameters

Parameter	Type	Description	Required
`page_size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 10)	no
`next`	`string`	A token used to get the next records in the list. This token is taken back from the results of the previous call	no
`search`	`string`	A case insensitive search on the bulk job `title` or `kind` (that contains the passed value)	no
`filters`	`array`	An object representing the conditions to filter out the results	no

Response

Status codes

Parameter	Description
`200`	The list of the bulk jobs has been retrieved
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No bulk history found or the path tenant / subscription doesn't exist
`500`	Uncaught error on server side

Success

Body

Parameter	Type	Description	Conditional?
`bulks`	`array`	The list of the bulk jobs related to the given `subscription_id`	no
`results`	`integer`	Total number of bulk jobs retrieved	no
`pages`	`integer`	Total number of pages	no
`page`	`integer`	Current page	no
`next`	`string`	A token used for infinite scrolling, to be used in the next call to retrieve subsequent records. Only present if the list of bulk jobs has to be continued	yes

Example

json

{
  "bulks": [
    {
      "created_on": "2025-09-05T10:13:21.050812",
      "id": 50,
      "job_id": "1757067200",
      "kind": "address_numbers",
      "status": "partial",
      "success_count": 1,
      "title": "Assign address to numbers",
      "total_count": 2,
      "updated_on": "2025-09-05T10:13:22.757355"
    },
    {
      "created_on": "2025-09-05T09:42:52.475829",
      "id": 49,
      "job_id": "1757065372",
      "kind": "address_numbers",
      "status": "partial",
      "success_count": 1,
      "title": "Assign address to numbers",
      "total_count": 2,
      "updated_on": "2025-09-05T09:42:54.093276"
    },
    {
      "created_on": "2025-09-05T09:15:26.911946",
      "id": 48,
      "job_id": "1757063726",
      "kind": "address_numbers",
      "status": "partial",
      "success_count": 1,
      "title": "Assign address to numbers",
      "total_count": 2,
      "updated_on": "2025-09-05T09:15:28.800659"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 3
}

Addresses bulk data objects

Parameter	Type	Description	Conditional?
`premises`	`string`	The company name or premises	no
`city`	`string`	The city	no
`country`	`string`	The country	no
`isoCode`	`string`	The ISO code	no
`number`	`string`	The address number. Accepts digits, characters, space, -, /.	no
`postalCode`	`integer`	The postal code	no
`state`	`string`	The state	no
`street`	`string`	The street	no

Address numbers bulk data objects

Parameter	Type	Description	Conditional?
`full_address`	`string`	The full address	no
`number`	`string`	The phone number	no

Addresses ​

List all addresses of a subscription ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Address Object ​

Address Data Object ​

Address Format Type ​

AssignedTo Object ​

Example ​

List all addresses of an entity ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Get a specific address ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Create a new address ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Body ​

Example ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Modify an existing address ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

<URL/Query parameters> ​

Body ​

Example ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Delete a address ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Body ​

Response ​

Status codes ​

Success ​

Body ​

Delete multiple addresses ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

Addresses

List all addresses of a subscription

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Address Object

Address Data Object

Address Format Type

AssignedTo Object

Example

List all addresses of an entity

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Get a specific address

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Create a new address

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Body

Example

Response

Status codes

Success

Body

Example

Modify an existing address

Request

Endpoint

Authorization

Path Parameters

<URL/Query parameters>

Body

Example

Response

Status codes

Success

Body

Example

Delete a address

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Body

Response

Status codes

Success

Body

Delete multiple addresses

Request

Endpoint

Authorization

Path Parameters