Receivers
Add, update and delete receivers.
POST |
Creates a new receiver in the address book.
Note
The system will return a unique receiver ID that identifies the receiver.
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/receivers POST.
GET |
Fetches information about receivers 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 | Receiver's quick ID | Optional |
receiverId | number | Unique receiver identification | Optional |
since | string | Returns receivers 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/receivers GET.
PATCH |
Updates information on a receiver.
URI parameters
Receiver ID | string | The receiver'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/receivers/{receiverId} PATCH.
PUT |
Updates a receiver by replacing it.
URI parameters
Receiver ID | string | The receiver'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/receivers/{receiverId} PUT.
DELETE |
Deletes a receiver.
Note
No response body is returned when a receiver is successfully deleted.
The receiver will be completely deleted from the system. No further operation will be possible on the receiver ID.
URI parameters
Receiver ID | string | The receiver'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/receivers/{receiverId} DELETE.