Add members to a segment

POST /v2/marketing/segments/add_to_membership_segment

Adds external IDs to a membership segment. You're limited to providing 50,000 or less external IDs per request. For larger sets, batch the IDs across multiple calls.

Security

Name	In	Description
Authorization	header	The Authorization header with the client bearer token acquired during authentication.

For more information, see Get a client access token.

Parameters

None.

Request

Field	Type	Required	Description
segment_id	string		The ID of the segment to update. Required.
external_ids	Array(string)		The external IDs to add to or remove from the segment. Required; must contain at least 1 and at most 50000 entries.

Request examples

cURL

curl --request POST \
  --url https://connect.instacart.com/v2/marketing/segments/add_to_membership_segment \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "segment_id": "string",
  "external_ids": [
    "string"
  ]
}'

Java

HttpResponse<String> response = Unirest.post("https://connect.instacart.com/v2/marketing/segments/add_to_membership_segment")
  .header("Accept", "application/json")
  .header("Content-Type", "application/json")
  .header("Authorization", "Bearer <token>")
  .body("{\n  \"segment_id\": \"string\",\n  \"external_ids\": [\n    \"string\"\n  ]\n}")
  .asString();

Python

import http.client

conn = http.client.HTTPSConnection("connect.instacart.com")

payload = "{\n  \"segment_id\": \"string\",\n  \"external_ids\": [\n    \"string\"\n  ]\n}"

headers = {
    'Accept': "application/json",
    'Content-Type': "application/json",
    'Authorization': "Bearer <token>"
}

conn.request("POST", "/v2/marketing/segments/add_to_membership_segment", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.instacart.com/v2/marketing/segments/add_to_membership_segment"

	payload := strings.NewReader("{\n  \"segment_id\": \"string\",\n  \"external_ids\": [\n    \"string\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

Field	Type	Required	Description
success	boolean		Whether the add succeeded for all supplied external IDs.
processed	integer		The number of external IDs added successfully.
failed	integer		The number of external IDs that could not be added.
failed_external_ids	Array(string)		The external IDs that could not be added. Omitted when none failed.
error_message	string		A human-readable summary of the failure. Omitted on full success.

Response examples

200 Success

200 Success

{
  "success": true,
  "processed": 2,
  "failed": 0
}

200 Partial failure

{
  "success": false,
  "processed": 1,
  "failed": 1,
  "failed_external_ids": [
    "ext-2"
  ],
  "error_message": "1 external ID could not be resolved"
}

4XX Errors

Error responses return either a single error or multiple errors.

HTTP Code	Cause	Error Message	Error Code	Error Meta
400	Invalid body	"Invalid request body"	1001	Not applicable
400	Missing field	"can't be blank"	1001	{"key":"segment_id"}
400	Too many external IDs	"external_ids cannot exceed 50000 entries"	1001	{"key":"external_ids"}
401	Unauthorized	"Unauthorized"	null	Not applicable
403	Forbidden	"Forbidden"	null	Not applicable