{"openapi":"3.1.0","info":{"title":"Admin Management: Subscribers","version":"1.0.0"},"paths":{"/stores/{store_hash}/v3/customers/subscribers":{"get":{"operationId":"getSubscribers","summary":"List Subscribers","description":"Returns a list of *Subscribers*. Optional filter parameters can be passed in.","tags":["subscribers"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter items by email.\n","required":false,"schema":{"type":"string"}},{"name":"first_name","in":"query","description":"Filter items by first_name.\n","required":false,"schema":{"type":"string"}},{"name":"last_name","in":"query","description":"Filter items by last_name.\n","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","description":"Filter items by source.\n","required":false,"schema":{"type":"string"}},{"name":"order_id","in":"query","description":"Filter items by order_id.\n","required":false,"schema":{"type":"integer"}},{"name":"date_created","in":"query","description":"Filter items by date_created.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_created:min","in":"query","description":"Filter items by minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_created:max","in":"query","description":"Filter items by maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_modified","in":"query","description":"Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15`","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_modified:min","in":"query","description":"Filter items by minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_modified:max","in":"query","description":"Filter items by maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Specifies the page number in a limited (paginated) list of products.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Controls the number of items per page in a limited (paginated) list of products.","required":false,"schema":{"type":"integer"}},{"name":"id","in":"query","description":"Filter items by ID.\n","required":true,"schema":{"type":"integer"}},{"name":"id:in","in":"query","description":"Filter items by ID.\n`id:in=4,5,6`\n","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Customers | modify | `store_v2_customers` |\n|  Customers | read-only | `store_v2_customers_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscribers_getSubscribers_Response_200"}}}}}},"post":{"operationId":"createSubscriber","summary":"Create Subscriber","description":"Creates a *Subscriber*.\n\n**Required Fields**\n* email\n\n**Read Only Fields**\n* id","tags":["subscribers"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Customers | modify | `store_v2_customers` |\n|  Customers | read-only | `store_v2_customers_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscribers_createSubscriber_Response_200"}}}},"409":{"description":"The `Subscriber` was in conflict with another subscriber. This is the result of duplicate unique values, such as email.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriberRequestConflictError"}}}},"422":{"description":"The `Subscriber` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriberRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_Post"}}}}},"delete":{"operationId":"deleteSubscribers","summary":"Delete Subscribers","description":"By default, it deletes all subscribers. Use a filter to avoid deleting all subscribers in a store.","tags":["subscribers"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter items by email.\n","required":false,"schema":{"type":"string"}},{"name":"first_name","in":"query","description":"Filter items by first_name.\n","required":false,"schema":{"type":"string"}},{"name":"last_name","in":"query","description":"Filter items by last_name.\n","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","description":"Filter items by source.\n","required":false,"schema":{"type":"string"}},{"name":"order_id","in":"query","description":"Filter items by order_id.\n","required":false,"schema":{"type":"integer"}},{"name":"date_created","in":"query","description":"Filter items by date_created.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_modified","in":"query","description":"Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15`","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Customers | modify | `store_v2_customers` |\n|  Customers | read-only | `store_v2_customers_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/stores/{store_hash}/v3/customers/subscribers/{subscriber_id}":{"get":{"operationId":"getSubscriber","summary":"Get Subscriber","description":"Returns a *Subscriber*.","tags":["subscribers"],"parameters":[{"name":"subscriber_id","in":"path","description":"The ID of the `Subscriber` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Customers | modify | `store_v2_customers` |\n|  Customers | read-only | `store_v2_customers_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscribers_getSubscriber_Response_200"}}}},"404":{"description":"The resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSubscriberRequestNotFoundError"}}}}}},"put":{"operationId":"updateSubscriber","summary":"Update Subscriber","description":"Updates a *Subscriber*.\n\n**Read Only Fields**\n* id","tags":["subscribers"],"parameters":[{"name":"subscriber_id","in":"path","description":"The ID of the `Subscriber` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Customers | modify | `store_v2_customers` |\n|  Customers | read-only | `store_v2_customers_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscribers_updateSubscriber_Response_200"}}}},"404":{"description":"The resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberRequestNotFoundError"}}}},"409":{"description":"The `Subscriber` was in conflict with another subscriber. This is the result of duplicate unique values, such as `email`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberRequestConflictError"}}}},"422":{"description":"The `Subscriber` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriberRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_Put"}}}}},"delete":{"operationId":"deleteSubscriber","summary":"Delete Subscriber","description":"Deletes a *Subscriber*.","tags":["subscribers"],"parameters":[{"name":"subscriber_id","in":"path","description":"The ID of the `Subscriber` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Customers | modify | `store_v2_customers` |\n|  Customers | read-only | `store_v2_customers_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}}},"servers":[{"url":"https://api.bigcommerce.com","description":"https://api.bigcommerce.com"}],"components":{"schemas":{"SubscriberBaseConsentsItems":{"type":"string","enum":["marketing_newsletter","abandoned_cart"],"title":"SubscriberBaseConsentsItems"},"SubscriberFullConsentsItems":{"type":"string","enum":["marketing_newsletter","abandoned_cart"],"title":"SubscriberFullConsentsItems"},"subscriber_Full":{"type":"object","properties":{"email":{"type":"string","description":"The email of the subscriber. Must be unique.\n"},"first_name":{"type":"string","description":"The first name of the subscriber.\n"},"last_name":{"type":"string","description":"The last name of the subscriber.\n"},"source":{"type":"string","description":"The source of the subscriber. Values are: `storefront`, `order`, or `custom`.\n"},"order_id":{"type":["integer","null"],"description":"The ID of the source order, if source was an order.\n"},"channel_id":{"type":"integer","description":"The channel ID where the subscriber was created."},"consents":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberFullConsentsItems"},"description":"Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'."},"id":{"type":"integer","description":"The unique numeric ID of the subscriber; increments sequentially."},"date_modified":{"type":"string","format":"date-time","description":"The date on which the subscriber was modified.\n"},"date_created":{"type":"string","format":"date-time","description":"The date of which the subscriber was created.\n"}},"description":"Full subscriber object returned in responses.","title":"subscriber_Full"},"CollectionMetaPaginationLinks":{"type":"object","properties":{"previous":{"type":"string","description":"Link to the previous page returned in the response.\n"},"current":{"type":"string","description":"Link to the current page returned in the response.\n"},"next":{"type":"string","description":"Link to the next page returned in the response.\n"}},"description":"Pagination links for the previous and next parts of the whole collection.\n","title":"CollectionMetaPaginationLinks"},"CollectionMetaPagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items in the result set.\n"},"count":{"type":"integer","description":"Total number of items in the collection response.\n"},"per_page":{"type":"integer","description":"The amount of items returned in the collection per page, controlled by the limit parameter.\n"},"current_page":{"type":"integer","description":"The page you are currently on within the collection.\n"},"total_pages":{"type":"integer","description":"The total number of pages in the collection.\n"},"links":{"$ref":"#/components/schemas/CollectionMetaPaginationLinks","description":"Pagination links for the previous and next parts of the whole collection.\n"}},"description":"Data about the response, including pagination and collection totals.","title":"CollectionMetaPagination"},"CollectionMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/CollectionMetaPagination","description":"Data about the response, including pagination and collection totals."}},"description":"Data about the response, including pagination and collection totals.","title":"CollectionMeta"},"Subscribers_getSubscribers_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/subscriber_Full"}},"meta":{"$ref":"#/components/schemas/CollectionMeta"}},"description":"Response payload for the BigCommerce API.\n","title":"Subscribers_getSubscribers_Response_200"},"subscriber_Post":{"type":"object","properties":{"email":{"type":"string","description":"The email of the subscriber. Must be unique.\n"},"first_name":{"type":"string","description":"The first name of the subscriber.\n"},"last_name":{"type":"string","description":"The last name of the subscriber.\n"},"source":{"type":"string","description":"The source of the subscriber. Values are: `storefront`, `order`, or `custom`.\n"},"order_id":{"type":["integer","null"],"description":"The ID of the source order, if source was an order.\n"},"channel_id":{"type":"integer","description":"The channel ID where the subscriber was created."},"consents":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberBaseConsentsItems"},"description":"Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'."}},"description":"The model for a POST to create a subscriber.\n","title":"subscriber_Post"},"OpenMeta":{"type":"object","properties":{},"description":"Response metadata.","title":"OpenMeta"},"Subscribers_createSubscriber_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/subscriber_Full"},"meta":{"$ref":"#/components/schemas/OpenMeta"}},"title":"Subscribers_createSubscriber_Response_200"},"CustomersSubscribersPostResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{},"title":"CustomersSubscribersPostResponsesContentApplicationJsonSchemaErrors"},"CreateSubscriberRequestConflictError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/CustomersSubscribersPostResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"CreateSubscriberRequestConflictError"},"CreateSubscriberRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/CustomersSubscribersPostResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"CreateSubscriberRequestUnprocessableEntityError"},"Subscribers_getSubscriber_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/subscriber_Full"},"meta":{"$ref":"#/components/schemas/OpenMeta"}},"title":"Subscribers_getSubscriber_Response_200"},"GetSubscriberRequestNotFoundError":{"type":"object","properties":{"status":{"type":"integer","description":"404 HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error."},"type":{"type":"string"},"instance":{"type":"string"}},"description":"Error payload for the BigCommerce API.","title":"GetSubscriberRequestNotFoundError"},"subscriber_Put":{"type":"object","properties":{"email":{"type":"string","description":"The email of the subscriber. Must be unique.\n"},"first_name":{"type":"string","description":"The first name of the subscriber.\n"},"last_name":{"type":"string","description":"The last name of the subscriber.\n"},"source":{"type":"string","description":"The source of the subscriber. Values are: `storefront`, `order`, or `custom`.\n"},"order_id":{"type":["integer","null"],"description":"The ID of the source order, if source was an order.\n"},"channel_id":{"type":"integer","description":"The channel ID where the subscriber was created."},"consents":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberBaseConsentsItems"},"description":"Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'."}},"description":"The model for a PUT to update a subscriber.\n","title":"subscriber_Put"},"Subscribers_updateSubscriber_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/subscriber_Full"},"meta":{"$ref":"#/components/schemas/OpenMeta"}},"title":"Subscribers_updateSubscriber_Response_200"},"UpdateSubscriberRequestNotFoundError":{"type":"object","properties":{"status":{"type":"integer","description":"404 HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error."},"type":{"type":"string"},"instance":{"type":"string"}},"description":"Error payload for the BigCommerce API.","title":"UpdateSubscriberRequestNotFoundError"},"CustomersSubscribersSubscriberIdPutResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"additionalProperties":{"type":"string"}},"title":"CustomersSubscribersSubscriberIdPutResponsesContentApplicationJsonSchemaErrors"},"UpdateSubscriberRequestConflictError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/CustomersSubscribersSubscriberIdPutResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"UpdateSubscriberRequestConflictError"},"UpdateSubscriberRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/CustomersSubscribersSubscriberIdPutResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"UpdateSubscriberRequestUnprocessableEntityError"}},"securitySchemes":{"X-Auth-Token":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Customers | modify | `store_v2_customers` |\n|  Customers | read-only | `store_v2_customers_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes)."}}}}