API Reference

Katapult Core API

Resources & Endpoints

Create address list

Create a new address list for a given organization.

POST
https://api.katapult.io/core/v1/organizations/{organization}/address_lists

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

organization Required

The organization to create the address list for.

 Organization Lookup None

properties Required

The properties for the new address list.

 AddressListArguments None

annotations

Annotations to add to this address list.

 KeyValue Array None

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_activated

An organization was found from the arguments provided but it wasn't activated yet

 403 Forbidden

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

organization_suspended

An organization was found from the arguments provided but it was suspended

 403 Forbidden

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: AddressList {
        id: String
        name: String
        global: Boolean
        entries: [ AddressListEntry {
            id: String
            address: String
            name: String
        } ]
    }
    annotations: [ KeyValue {
        key: String
        value: String?
    } ]
}