API Reference

Katapult Core API

Resources & Endpoints

Create address list entry

Create a new address list entry for a given address list.

POST
https://api.katapult.io/core/v1/address_lists/{address_list}/entries

If successful, this endpoint will return a 201 Created status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

address_list Required

The address list under which the new entry should be created.

 Address List Lookup None

properties Required

The properties for the new address list entry.

 AddressListEntryArguments None

Potential Errors

The following errors may occur during this request.

Details HTTP status

address_list_not_found

No address list was found matching any of the criteria provided in the arguments.

 404 Not Found

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    address_list_entry: AddressListEntry {
        id: String
        address: String
        name: String
    }
}