AddressBook

Manage address book entries, which represent contact information (such as email, phone, or postal address) associated with entities like people or locations.
You can create, update, delete, and search for address book entries with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/address-book/index

Returns a paginated and filterable list of address book entries.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching address book entries

object

filter

object

delivery_id

string format: uuid

type

string

Allowed values: telephone email mobilephone fax skype web PEC

entity_id

string format: uuid

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

string

Allowed values: type entity_id value

Example

{
  "filter": {
    "type": "email"
  },
  "per-page": 20,
  "page": 1,
  "sort": "entity_id"
}

Responses

200

List of address book entries

Array<object>

object

delivery_id

required

string format: uuid

type

required

string

Allowed values: telephone email mobilephone fax skype web PEC

description

string

value

required

string

note

string

entity_id

required

string format: uuid

{
  "delivery_id": "123e4567-e89b-12d3-a456-426655440000",
  "type": "email",
  "description": "the email",
  "value": "theuser@theemail.com",
  "note": "work email",
  "entity_id": "123e4567-e89b-12d3-a456-426655440000"
}

Example

{
  "delivery_id": "123e4567-e89b-12d3-a456-426655440000",
  "type": "email",
  "description": "Work email",
  "value": "theuser@theemail.com",
  "note": "Main contact",
  "entity_id": "123e4567-e89b-12d3-a456-426655440000"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/address-book/create

Create a new address book entry by providing the required details.

Request Body ^required

AddressBook object to be created

object

delivery_id

required

string format: uuid

type

required

string

Allowed values: telephone email mobilephone fax skype web PEC

description

string

value

required

string

note

string

entity_id

required

string format: uuid

Example

{
  "type": "email",
  "description": "Work email",
  "value": "theuser@theemail.com",
  "note": "Main contact",
  "entity_id": "123e4567-e89b-12d3-a456-426655440000"
}

Responses

201

AddressBook created successfully

object

delivery_id

required

string format: uuid

type

required

string

Allowed values: telephone email mobilephone fax skype web PEC

description

string

value

required

string

note

string

entity_id

required

string format: uuid

Example

{
  "delivery_id": "123e4567-e89b-12d3-a456-426655440000",
  "type": "email",
  "description": "Work email",
  "value": "theuser@theemail.com",
  "note": "Main contact",
  "entity_id": "123e4567-e89b-12d3-a456-426655440000"
}

view

GET

/v2/address-book/view/{id}

Retrieve an address book entry by its unique ID.

Path Parameters

id

required

integer format: int64

ID of the address book entry to retrieve

Responses

200

AddressBook found

object

delivery_id

required

string format: uuid

type

required

string

Allowed values: telephone email mobilephone fax skype web PEC

description

string

value

required

string

note

string

entity_id

required

string format: uuid

Example

{
  "delivery_id": "123e4567-e89b-12d3-a456-426655440000",
  "type": "email",
  "description": "Work email",
  "value": "theuser@theemail.com",
  "note": "Main contact",
  "entity_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

AddressBook not found

delete

DELETE

/v2/address-book/view/{id}

Delete an address book entry by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

integer format: int64

ID of the address book entry to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

AddressBook deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/address-book/update/{id}

Update an existing address book entry by its unique ID.

Path Parameters

id

required

integer format: int64

ID of the address book entry to update

Request Body ^required

AddressBook object with updated data

object

delivery_id

required

string format: uuid

type

required

string

Allowed values: telephone email mobilephone fax skype web PEC

description

string

value

required

string

note

string

entity_id

required

string format: uuid

Example

{
  "note": "Updated contact"
}

Responses

200

AddressBook updated successfully

object

delivery_id

required

string format: uuid

type

required

string

Allowed values: telephone email mobilephone fax skype web PEC

description

string

value

required

string

note

string

entity_id

required

string format: uuid

Example

{
  "delivery_id": "123e4567-e89b-12d3-a456-426655440000",
  "note": "Updated contact"
}

404

AddressBook not found