Skip to main content

Senders

Add, update and delete senders.

Create a new sender

POST /addresses/senders

Creates a new sender in the address book.

Note

The system will return a unique sender ID that identifies the sender.

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /addresses/senders POST.

Fetch sender information

GET addresses/senders

Fetches information about senders from the address book.

Note

Check of Swedish zip codes is not supported.

Query parameters

page

number

Result pages containing max. 50 senders

Required

Provides a way to page through the complete result.

Starts at zero and increments upwards.

quickId

string

Sender's quick ID

Optional

senderId

number

Unique sender identification

Optional

since

string

Returns senders that have been changed since a specified date.

Optional

Valid formats: yyyyMMddHHmmss, yyyyMMddHHmm, yyyyMMdd or yyMMdd

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /addresses/senders GET.

Update a sender

PATCH/addresses/senders/{senderId}

Updates information on a sender.

URI parameters

Sender ID

string

The sender's ID

Required

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /addresses/senders/{senderId} PATCH.

Replace a sender

PUT/addresses/senders/{senderId}

Updates a sender by replacing it.

URI parameters

Sender ID

string

The sender's ID

Required

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /addresses/senders/{senderId} PUT.

Delete a sender

DELETE /addresses/senders/{senderId}

Deletes a sender.

Note

No response body is returned when a sender is successfully deleted.

The sender will be completely deleted from the system. No further operation will be possible on the sender ID.

URI parameters

Sender ID

string

The sender's ID

Required

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /addresses/senders/{senderId} DELETE.

In this section: