카탈로그 선택 항목 만들기

post

/catalogs/{catalog_name}/selections

이 엔드포인트를 사용하여 카탈로그에서 선택 항목을 생성합니다.

important:

이 엔드포인트는 현재 얼리 액세스 중입니다. 이 얼리 액세스에 참여하려면 고객 성공 관리자에게 문의하세요.

필수 구성 요소

이 엔드포인트를 사용하려면 catalogs.create_selection 권한이 있는 API 키가 필요합니다.

사용량 제한

경로 매개변수

매개변수 필수 데이터 유형 설명

catalog_name 필수 문자열 카탈로그의 이름입니다.

요청 매개변수

매개변수 필수 데이터 유형 설명

selection 필수 객체 선택 기준이 포함된 개체입니다. 선택 개체에는 name, description, filters, results_limit, sort_field, sort_order 이 포함될 수 있습니다 .

요청 예시

curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/selections' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "selection": {
    "name": "favorite-restaurants",
    "description": "Favorite restaurants in NYC",
    "filters": [
      {
        "field": "City",
        "operator": "equals",
        "value": "NYC"
      },
      {
        "field": "Rating",
        "operator": "greater than",
        "value": 7
      }
    ]
  }
}'

필터 연산자

필드 유형 지원되는 사업자

string equals, does not equal

number equals, does not equal, greater than, less than

boolean is

time before, after

array includes value, does not include value

응답

이 엔드포인트에 대한 상태 코드 응답은 202, 400, 404 등 세 가지가 있습니다.

성공 응답의 예

202 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다.

{
  "message": "success"
}

오류 응답의 예

400 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다. 발생할 수 있는 오류에 대한 자세한 내용은 문제 해결을 참조하세요.

{
  "errors": [
    {
      "id": "catalog-not-found",
      "message": "Could not find catalog",
      "parameters": [
        "catalog_name"
      ],
      "parameter_values": [
        "restaurants"
      ]
    }
  ],
  "message": "Invalid Request"
}