API Reference

Katapult Core API

Resources & Endpoints

Update address list entry

Update an address list entry with new properties.

PATCH
https://api.katapult.io/core/v1/address_list_entries/{address_list_entry}

If successful, this endpoint will return a 200 OK 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_entry Required

The address list entry to update.

 Address List Entry Lookup None

properties Required

The updated properties for the address list entry.

 AddressListEntryArguments None

Potential Errors

The following errors may occur during this request.

Details HTTP status

address_list_entry_not_found

No address list entry 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
    }
}