Create CRM segment

POST/v1/crm/segments

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

descriptionstring

filter_logicstring

Allowed:andor

filtersany

namestringrequired

object_kindstringrequired

segment_typestring

Allowed:dynamicstatic

Responses

200OK

contact_countinteger<int32>required

created_atstringrequired

descriptionstring | nullrequired

filter_logicstringrequired

filtersanyrequired

idstringrequired

namestringrequired

object_kindstringrequired

predefinedbooleanrequired

segment_typestringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/crm/segments" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "filter_logic": "and",
  "filters": "string",
  "name": "string",
  "object_kind": "string",
  "segment_type": "dynamic"
}'

const response = await fetch("/v1/crm/segments", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "description": "string",
  "filter_logic": "and",
  "filters": "string",
  "name": "string",
  "object_kind": "string",
  "segment_type": "dynamic"
})
});

import requests

response = requests.post(
    "/v1/crm/segments",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "description": "string",
  "filter_logic": "and",
  "filters": "string",
  "name": "string",
  "object_kind": "string",
  "segment_type": "dynamic"
},
)

Response

{
  "contact_count": 0,
  "created_at": "string",
  "description": "string",
  "filter_logic": "string",
  "filters": "string",
  "id": "string",
  "name": "string",
  "object_kind": "string",
  "predefined": true,
  "segment_type": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}