Tags

get

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

get/v1/crm/tags

HTTPcURLJavaScriptPython

GET /v1/crm/tags HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "type": "auto",
        "locales": {},
        "sortBy": "text",
        "uid": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text"
      }
    ],
    "next": "text"
  }
}

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

get/v1/crm/tags/{uid}

HTTPcURLJavaScriptPython

GET /v1/crm/tags/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "type": "auto",
      "locales": {},
      "sortBy": "text",
      "uid": "text",
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text"
    },
    "dataModels": [
      {
        "uid": "text",
        "columns": [
          {
            "name": "text",
            "type": "date",
            "attribute": "text",
            "cid": "text",
            "lov": [
              {}
            ],
            "locales": {}
          }
        ]
      }
    ]
  }
}

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

get/v1/crm/tags/{uid}/customers

HTTPcURLJavaScriptPython

GET /v1/crm/tags/{uid}/customers HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "customers": [
      {
        "customerUid": "text",
        "firstName": "text",
        "lastName": "text",
        "gender": "text",
        "tagEligible": "text",
        "tagAssigned": "text",
        "tagEffectiveStartTime": "text",
        "tagEffectiveEndTime": "text",
        "tagAssignmentUid": "text"
      }
    ],
    "count": 1,
    "next": "text"
  }
}

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

customerUidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

get/v1/crm/tag-assignments/{customerUid}

HTTPcURLJavaScriptPython

GET /v1/crm/tag-assignments/{customerUid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "eligible": true,
        "effectiveStartTime": "text",
        "effectiveEndTime": "text",
        "attrs": {},
        "uid": "text",
        "tagUid": "text",
        "customerUid": "text",
        "effective": true,
        "tag": {
          "type": "auto",
          "locales": {},
          "sortBy": "text",
          "uid": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text"
        },
        "benefits": [
          {
            "locales": {},
            "type": "dicount-flat",
            "amount": 1,
            "discountRef": "text",
            "sortNumber": 1,
            "id": "text",
            "uid": "text",
            "rules": [
              {
                "conditions": [
                  {
                    "key": "basic.date",
                    "operator": "contains",
                    "value": "text"
                  }
                ],
                "action": "apply",
                "sortNumber": 1,
                "id": "text",
                "uid": "text",
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text"
              }
            ],
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "applicable": true,
            "overwritten": true
          }
        ],
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text"
      }
    ],
    "next": "text"
  }
}

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

post/v1/crm/tag-assignments

HTTPcURLJavaScriptPython

POST /v1/crm/tag-assignments HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "params": {
    "tagUid": "text",
    "customerUid": "text",
    "eligible": true,
    "effectiveStartTime": "text",
    "effectiveEndTime": "text",
    "attrs": {}
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "id": "text"
  }
}

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

delete/v1/crm/tag-assignments/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/crm/tag-assignments/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

patch/v1/crm/tag-assignments/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/crm/tag-assignments/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "params": {
    "uid": "text",
    "eligible": true,
    "effectiveStartTime": "text",
    "effectiveEndTime": "text",
    "attrs": {}
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "success": true
  }
}