Upsert newsletter subscribers in bulk

POST

https://core.shopimind.com/v1/newsletter-subscribers

Upserts up to 100 newsletter subscribers per request. Records are matched on email (case-insensitive). Setting is_subscribed=false removes the address from active marketing audiences but preserves history. Processing is asynchronous (Kafka).

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

"^[a-zA-Z0-9-]{20,64}$"

Request Body

application/json

[

  

{

  

  

"email": "test@test.com",

  

  

"is_subscribed": true,

  

  

"first_name": "John",

  

  

"last_name": "Doe",

  

  

"postal_code": "12345",

  

  

"lang": "en",

  

  

"updated_at": "2023-01-29T14:47:00.000Z"

  

}

]

Responses

Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items.

Content-Type

application/json

{

  

"statusCode": 200,

  

"sent_count": 5,

  

"rejected_count": 0,

  

"rejected_items": [

  

]

}

POST

https://core.shopimind.com/v1/newsletter-subscribers

Playground

Headers

spm-api-key*

Body

Samples

Upsert newsletter subscribers in bulk Upserts up to 100 newsletter subscribers per request. Records are matched on email (case-insensitive). Setting is_subscribed=false removes the address from active marketing audiences but preserves history. Processing is asynchronous (Kafka). POST /v1/newsletter-subscribers bulkCreateNewsletterSubscribers Newsletter subscribers spm-api-key [Authentication] Required API key. Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items. All objects are invalid, or the request body is not an array, or the array exceeds the maximum allowed size Server error - Internal processing failure