Gormic.com

Tags

get
Responses
200Success
application/json
get
GET /v1/crm/tags HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "type": 1,
        "locales": {},
        "sortBy": "text",
        "uid": "text",
        "dataModelUids": [
          "text"
        ],
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text"
      }
    ],
    "next": "text"
  }
}
get
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /v1/crm/tags/{id} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "type": 1,
      "locales": {},
      "sortBy": "text",
      "uid": "text",
      "dataModelUids": [
        "text"
      ],
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text"
    },
    "dataModels": [
      {
        "uid": "text",
        "columns": [
          {
            "name": "text",
            "type": 1,
            "attribute": "text",
            "cid": "text",
            "lov": [
              {}
            ],
            "locales": {}
          }
        ]
      }
    ]
  }
}
get
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /v1/crm/tags/{id}/customers HTTP/1.1
Host: 
Accept: */*
200Success
{
  "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
Path parameters
customerstringRequired
Responses
200Success
application/json
get
GET /v1/crm/tag-assignments/{customerId} HTTP/1.1
Host: 
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": 1,
          "locales": {},
          "sortBy": "text",
          "uid": "text",
          "dataModelUids": [
            "text"
          ],
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text"
        },
        "benefits": [
          {
            "locales": {},
            "type": 1,
            "amount": 1,
            "discountRef": "text",
            "sortNumber": 1,
            "id": "text",
            "uid": "text",
            "rules": [
              {
                "conditions": [
                  {
                    "key": "basic.date",
                    "operator": "contains",
                    "value": "text"
                  }
                ],
                "action": 1,
                "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
Body
Responses
200Success
application/json
post
POST /v1/crm/tag-assignments HTTP/1.1
Host: 
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
Path parameters
idstringRequired
Responses
200Success
application/json
delete
DELETE /v1/crm/tag-assignments/{id} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}
patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/crm/tag-assignments/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "params": {
    "uid": "text",
    "eligible": true,
    "effectiveStartTime": "text",
    "effectiveEndTime": "text",
    "attrs": {}
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "success": true
  }
}
PreviousProfilesNextPartners

Was this helpful?