--- title: set address catalog subscription slug: api-documentation/set-address-catalog-subscription docTags: createdAt: 2026-08-27T17:02:13.658Z --- { "id": "fNaQUA3usnh3gxYRZrIkv", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/customer/{customerId}/subscriptions/addresscatalogs", "servers": [ { "url": "https://api.upstartcommerce.com/v1/customer/{customerId}/subscriptions/addresscatalogs" } ], "name": "set address catalog subscription", "description": "

This endpoint allows administrators to set the address catalog subscription, by label, for a given consumer.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "customerId", "type": "string", "description": "Unique identifier for the consumer that the call should be interacting with." } ], "headerParameters": [ { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." }, { "kind": "optional", "name": "x-upstart-site", "type": "string", "description": "Unique identifier for the site." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "This is a consumer's address associated with a subscription.", "customType": "AddressSubscription", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "A representation of an address as used by the consumer APIs.", "modelRef": "#/components/schemas/Address", "customType": "Address", "schema": [ { "name": "businessName", "kind": "optional", "type": "string", "description": "An optional name representing the business that this address is for.", "example": "Acme Fireworks" }, { "name": "city", "kind": "required", "type": "string", "description": "The city associated with the address.", "example": "Boston" }, { "name": "country", "kind": "required", "type": "string", "description": "

The country associated with the address. This should be a 2-character country code.

", "example": "US", "pattern": "^[A-Z]{2}$" }, { "name": "county", "kind": "optional", "type": "string", "description": "" }, { "name": "label", "kind": "required", "type": "string", "description": "

A user-friendly name to identify the consumer's address.

", "example": "Home" }, { "name": "name", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Name", "customType": "Name", "schema": [ { "name": "first", "kind": "required", "type": "string", "description": "The first name of the individual being addressed.", "example": "John" }, { "name": "last", "kind": "required", "type": "string", "description": "The last name of the individual being addressed.", "example": "Smith" }, { "name": "middleInitial", "kind": "optional", "type": "string", "description": "The middle initial of the individual being addressed.", "example": "D." }, { "name": "salutation", "kind": "optional", "type": "string", "description": "The salutation of the individual being addressed.", "example": "Capt." }, { "name": "suffix", "kind": "optional", "type": "string", "description": "The optional suffix of the individual being addressed.", "example": "Sr." } ] }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "Phone number associated with this address.", "example": "8668675309" }, { "name": "poBox", "kind": "optional", "type": "boolean", "description": "

A binary indicator to say that this is/is not a PO Box.

", "default": false }, { "name": "postalCode", "kind": "required", "type": "string", "description": "

The country-specific postal code.

", "example": "03031" }, { "name": "stateOrRegion", "kind": "required", "type": "string", "description": "

This identifies the state (or region) that the address is in.

", "example": "NH" }, { "name": "street1", "kind": "required", "type": "string", "description": "The primary address line.", "example": "123 Main St. Suite 1" }, { "name": "street2", "kind": "optional", "type": "string", "description": "

An optional second-line of an address (optional). It is primarily used in special circumstances, such as secondary addresses, attention designations, C/O (in care of) addresses or special instructions.

", "example": "C/O Bob" } ] }, { "name": "label", "kind": "required", "type": "string", "description": "This label links the address to a given subscription.", "example": "The Big Catalog" } ], "modelRef": "#/components/schemas/AddressSubscription", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-subscription updated.

", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "

An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "UW-vSn0OhXmwH71RxUaws", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/customer/{customerId}/subscriptions/addresscatalogs \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"address\": {\n \"city\": \"Boston\",\n \"country\": \"US\",\n \"label\": \"Home\",\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\"\n },\n \"postalCode\": \"03031\",\n \"stateOrRegion\": \"NH\",\n \"street1\": \"123 Main St. Suite 1\"\n },\n \"label\": \"The Big Catalog\"\n }'" }, { "id": "jtLMUeEgHpMEqej8vFuR0", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"address\": {\n \"city\": \"Boston\",\n \"country\": \"US\",\n \"label\": \"Home\",\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\"\n },\n \"postalCode\": \"03031\",\n \"stateOrRegion\": \"NH\",\n \"street1\": \"123 Main St. Suite 1\"\n },\n \"label\": \"The Big Catalog\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/customer/{customerId}/subscriptions/addresscatalogs\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "kNScIlYSfEzrmHKOTW8UK", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/customer/{customerId}/subscriptions/addresscatalogs\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"address\": {\n \"city\": \"Boston\",\n \"country\": \"US\",\n \"label\": \"Home\",\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\"\n },\n \"postalCode\": \"03031\",\n \"stateOrRegion\": \"NH\",\n \"street1\": \"123 Main St. Suite 1\"\n },\n \"label\": \"The Big Catalog\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "NGjIIu0YblDotPeP3DEFn", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/customer/{customerId}/subscriptions/addresscatalogs\"\n\npayload = json.dumps({\n \"address\": {\n \"city\": \"Boston\",\n \"country\": \"US\",\n \"label\": \"Home\",\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\"\n },\n \"postalCode\": \"03031\",\n \"stateOrRegion\": \"NH\",\n \"street1\": \"123 Main St. Suite 1\"\n },\n \"label\": \"The Big Catalog\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "UW-vSn0OhXmwH71RxUaws" }, "results": { "languages": [ { "id": "bdDO8gFTn8IA8a16IfHNm", "language": "200", "code": "// Success-subscription updated.\n" }, { "id": "F1JmMYPJQ7BZvEISovwgF", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "2lkz8ispetRhdUhMfXk14", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "tbQsouFMpfkx3PqnWqOKQ", "language": "403", "code": "// An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "lsF-hTHCXESOocJiCm1Zs", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "bdDO8gFTn8IA8a16IfHNm" } }, "children": [ { "text": "" } ] }