Баримт бичиг / API лавлах
Түншийн бүлэг
Өөрийн дүрэмтэй бүлгүүд.
GET/v1/workspaces/{workspaceId}/program/groups
All groups of the program, default group first.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 GroupDto[]
POST/v1/workspaces/{workspaceId}/program/groups
Create a group: copies the default group's link settings, default links, allowed domains, landing page and form drafts. 402 over the plan's group limit.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (CreateGroup)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | тийм | |
color | string | | `#RRGGBB`; a palette color when omitted. |
slug | string | | Generated from the name when omitted. |
copyRewards | boolean | | Copy the default group's rewards. |
copyDiscount | boolean | | Copy the default group's discount. |
openForApplications | boolean | | Let the public application form target this group (default false). |
Хариу: 201 GroupDto
GET/v1/workspaces/{workspaceId}/program/groups/{groupId}
One group.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хариу: 200 GroupDto
PATCH/v1/workspaces/{workspaceId}/program/groups/{groupId}
Update a group. If-Match carries the version.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хүсэлтийн бие (UpdateGroup)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | | |
slug | string | | Not allowed on the default group. |
color | string | | |
holdingPeriodDays | integer (int64) | | Must be one of 0, 7, 14, 30, 60, 90 (422 otherwise). |
autoApprove | boolean | | |
hideSaleAmounts | boolean | | |
openForApplications | boolean | | Let the public application form target this group. The default group cannot be closed (422). |
applyHideSaleAmountsToAll | boolean | | With `hideSaleAmounts`: apply the value to every group. |
Хариу: 200 GroupDto
DELETE/v1/workspaces/{workspaceId}/program/groups/{groupId}
Delete a group: partners move to the default group with its link rules, pending applications are re-pointed, the landing URL starts returning 404.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
confirm | query | boolean | | Must be `true`. |
Хариу: 204
GET/v1/workspaces/{workspaceId}/program/groups/{groupId}/discount
The group's discount, or 404 when it has none.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хариу: 200 DiscountDto
PUT/v1/workspaces/{workspaceId}/program/groups/{groupId}/discount
Create or replace the group's single discount. A new discount creates a code for each approved partner of the group.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хүсэлтийн бие (PutDiscount)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
type | string | тийм | `percentage` (1..100) or `flat` (whole MNT). |
amount | integer (int64) | тийм | |
maxDuration | integer (int32) | | Months; 0 is one-time; null is lifetime. |
Хариу: 200 DiscountDto
DELETE/v1/workspaces/{workspaceId}/program/groups/{groupId}/discount
Remove the group's discount; the partners' codes are disabled and discount_code.deleted is emitted for each so the integrator can remove them.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хариу: 204
GET/v1/workspaces/{workspaceId}/program/groups/{groupId}/link-settings
Link settings of a group: structure, partner link cap, UTM template, default links and allowed domains.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хариу: 200 LinkSettingsDto
PUT/v1/workspaces/{workspaceId}/program/groups/{groupId}/link-settings
Replace link settings. Saving a changed UTM template or default link destination queues a background update of the group's partner links; new default links are generated for current partners.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хүсэлтийн бие (PutLinkSettings)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
linkStructure | string | | |
maxPartnerLinks | integer (int32) | | 0 disables partner-created links. |
utm | null | Utm | | |
defaultLinks | array | | |
allowedDomains | array | | |
Хариу: 200 LinkSettingsDto
GET/v1/workspaces/{workspaceId}/program/groups/{groupId}/move-rules
Move rules targeting this group, in evaluation order.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хариу: 200 RuleDto[]
POST/v1/workspaces/{workspaceId}/program/groups/{groupId}/move-rules
Add a move rule. Needs the partner_advanced bundle (Business and up).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хүсэлтийн бие (RuleInput)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
metric | string | | |
threshold | integer (int64) | | |
currentGroupOp | string | | `is`, `is_not`, `is_one_of`, `is_not_one_of`, or null for no condition. |
currentGroupIds | array | | |
Хариу: 201 RuleDto
PATCH/v1/workspaces/{workspaceId}/program/groups/{groupId}/move-rules/{ruleId}
Edit a move rule.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
ruleId | path | string | тийм | |
Хүсэлтийн бие (RuleInput)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
metric | string | | |
threshold | integer (int64) | | |
currentGroupOp | string | | `is`, `is_not`, `is_one_of`, `is_not_one_of`, or null for no condition. |
currentGroupIds | array | | |
Хариу: 200 RuleDto
DELETE/v1/workspaces/{workspaceId}/program/groups/{groupId}/move-rules/{ruleId}
Delete a move rule.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
ruleId | path | string | тийм | |
Хариу: 204
POST/v1/workspaces/{workspaceId}/program/groups/{groupId}/partners
Move partners into a group. Past commissions keep their amounts; links follow the new group's defaults and UTM template.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хүсэлтийн бие (MoveBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
partnerIds | string[] | тийм | `par_` ids of enrolled partners, at most 200. |
Хариу: 200 MoveResult
GET/v1/workspaces/{workspaceId}/program/partner-links
A partner's links with counters; one of partnerId or tenantId is required.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | query | string | | |
tenantId | query | string | | |
Хариу: 200 PartnerLinkDto[]
POST/v1/workspaces/{workspaceId}/program/partner-links
Create a link for an enrolled partner. Partner links have conversion tracking on and take the group's UTM template. 422 without partnerId/tenantId.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (PartnerLinkInput)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
partnerId | string | | Wins over `tenantId`. |
tenantId | string | | |
url | string | | Defaults to the program URL (required for upsert). |
key | string | | Random 7 characters when omitted. |
comments | string | | |
linkProps | null | LinkInput | | |
Хариу: 201 PartnerLinkDto
PUT/v1/workspaces/{workspaceId}/program/partner-links/upsert
Return the partner's link to the same destination, or create it (200 either way).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (PartnerLinkInput)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
partnerId | string | | Wins over `tenantId`. |
tenantId | string | | |
url | string | | Defaults to the program URL (required for upsert). |
key | string | | Random 7 characters when omitted. |
comments | string | | |
linkProps | null | LinkInput | | |
Хариу: 200 PartnerLinkDto