Partners

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/partners

HTTPcURLJavaScriptPython

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

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "domain": "text",
        "locales": {},
        "id": "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/partners/{uid}

HTTPcURLJavaScriptPython

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

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "domain": "text",
      "locales": {},
      "id": "text",
      "programs": [
        {
          "locales": {},
          "excludedLevels": {},
          "period": 1,
          "periodUnit": {},
          "alias": "text",
          "id": "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"
            }
          ]
        }
      ]
    }
  }
}

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/partners/{uid}/customers

HTTPcURLJavaScriptPython

GET /v1/crm/partners/{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"
  }
}

post

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

post/v1/crm/partners/{uid}/member

HTTPcURLJavaScriptPython

POST /v1/crm/partners/{uid}/member HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "params": {
    "membershipId": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true,
    "programs": [
      {
        "locales": {},
        "excludedLevels": {},
        "period": 1,
        "periodUnit": {},
        "alias": "text",
        "id": "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"
          }
        ]
      }
    ]
  }
}

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

membershipUidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

delete/v1/crm/partners/{uid}/member/{membershipUid}

HTTPcURLJavaScriptPython

DELETE /v1/crm/partners/{uid}/member/{membershipUid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

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

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

400

Functional Error

application/json

post/v1/crm/partners/register

HTTPcURLJavaScriptPython

POST /v1/crm/partners/register HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "params": {
    "email": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "token": "text",
    "creationTime": 1,
    "life": 1
  }
}

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

400

Functional Error

application/json

post/v1/crm/partners/verify

HTTPcURLJavaScriptPython

POST /v1/crm/partners/verify HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "params": {
    "email": "text",
    "otp": "text",
    "otpToken": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true,
    "programs": [
      {
        "locales": {},
        "excludedLevels": {},
        "period": 1,
        "periodUnit": {},
        "alias": "text",
        "id": "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"
          }
        ]
      }
    ]
  }
}