Түнш элсүүлэлт

Өргөдөл, урилга, түншүүд.

GET/v1/workspaces/{workspaceId}/marketplace-settings

Marketplace opt-in of the program.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 MarketplaceSettings

PUT/v1/workspaces/{workspaceId}/marketplace-settings

Opt in or out and set the partner-facing description (at most 1000 characters) and up to three categories. Only an active program can be listed.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (PutSettings)

Нэр	Төрөл	Заавал
`listed`	boolean	тийм
`description`	string
`categories`	array

Хариу: 200 MarketplaceSettings

POST/v1/workspaces/{workspaceId}/partner-invites

Invite one or many partners.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (InviteBody)

Нэр	Төрөл	Заавал	Тайлбар
`emails`	string[]	тийм	Addresses; each entry may itself be a comma separated list. At most 100.
`name`	string		Display name for new partner accounts.
`groupId`	string
`subject`	string		Stored with the invite (per-send edit); the catalog subject is used in the mail.
`body`	string		Markdown subset replacing the default body.

Хариу: 201 InviteResult[]

GET/v1/workspaces/{workspaceId}/partner-jobs

Import and export jobs, newest first.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 JobDto[]

GET/v1/workspaces/{workspaceId}/partner-jobs/{jobId}

One job with its progress and validation counts.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`jobId`	path	string	тийм

Хариу: 200 JobDto

GET/v1/workspaces/{workspaceId}/partner-jobs/{jobId}/download

Download the export or the import error report (row number, reason).

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`jobId`	path	string	тийм
`file`	query	string		`result` (default) or `errors`.

Хариу: 200

GET/v1/workspaces/{workspaceId}/partner-tags

Every tag of the program with partner counts.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`search`	query	string

Хариу: 200 PartnerTagDto[]

POST/v1/workspaces/{workspaceId}/partner-tags

Create a tag: 409 for a duplicate folded name, tags_limit over 500.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (CreateTag)

Нэр	Төрөл	Заавал	Тайлбар
`name`	string	тийм
`color`	string		Random among red, yellow, green, blue, purple, brown, gray when omitted.

Хариу: 201 PartnerTagDto

PATCH/v1/workspaces/{workspaceId}/partner-tags/{tagId}

Rename or recolor a tag; applies everywhere.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`tagId`	path	string	тийм

Хүсэлтийн бие (PatchTag)

Нэр	Төрөл	Заавал	Тайлбар
`name`	string
`color`	string

Хариу: 200 PartnerTagDto

DELETE/v1/workspaces/{workspaceId}/partner-tags/{tagId}

Delete a tag; it is removed from every partner.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`tagId`	path	string	тийм

Хариу: 200 Deleted

GET/v1/workspaces/{workspaceId}/partners

List partners: filters, sort by any counter, cursor pagination over partner ids, X-Total-Count.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (13)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`groupId`	query	string
`status`	query	string		Comma separated; default: every status except `pending` and `rejected`.
`country`	query	string
`email`	query	string		Exact email; wins over `search`.
`tenantId`	query	string
`search`	query	string
`tagIds`	query	string		Comma separated partner tag ids (any).
`sortBy`	query	string
`sortOrder`	query	string
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string

Хариу: 200 PartnerDto[]

POST/v1/workspaces/{workspaceId}/partners

Create or update a partner: upsert by email, enrolls as approved with the default links and fires partner.enrolled. 201 on creation, 200 when already enrolled.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (CreatePartner)

Нэр	Төрөл	Заавал	Тайлбар
`email`	string	тийм
`name`	string
`username`	string
`image`	string		Accepted and ignored: partner images are uploaded by the partner (decision D-enr-5).
`tenantId`	string
`groupId`	string
`tagIds`	array
`tagNames`	array
`country`	string
`description`	string
`linkProps`	null \| LinkInput

Хариу: 200 PartnerDto, 201 PartnerDto

POST/v1/workspaces/{workspaceId}/partners/archive

Archive (list hygiene only, rule 13).

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (PartnerRef)

Нэр	Төрөл	Заавал	Тайлбар
`partnerId`	string
`tenantId`	string

Хариу: 200 PartnerIdDto

POST/v1/workspaces/{workspaceId}/partners/ban

Ban: links disabled and redirected to the program URL untracked (D3), reason emailed; pending payouts and commissions are cancelled by the partner.banned consumers.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (BanBody)

Нэр	Төрөл	Заавал	Тайлбар
`partnerId`	string
`tenantId`	string
`reason`	string	тийм	tos_violation, inappropriate_content, fake_traffic, fraud, spam or brand_abuse.
`flagForFraud`	boolean
`flagForFraudReason`	string

Хариу: 200 PartnerIdDto

POST/v1/workspaces/{workspaceId}/partners/bulk

Bulk archive, deactivate, ban or change group: all rows must be eligible or the whole request is a 422 and nothing changes.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (BulkAction)

Нэр	Төрөл	Заавал	Тайлбар
`action`	string	тийм	`archive`, `deactivate`, `ban` or `changeGroup`.
`partnerIds`	string[]	тийм
`reason`	string
`flagForFraud`	boolean
`flagForFraudReason`	string
`groupId`	string

Хариу: 200 BulkOut

POST/v1/workspaces/{workspaceId}/partners/deactivate

Deactivate.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (PartnerRef)

Нэр	Төрөл	Заавал	Тайлбар
`partnerId`	string
`tenantId`	string

Хариу: 200 PartnerIdDto

POST/v1/workspaces/{workspaceId}/partners/export

Export the filtered partner list as CSV.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (ListQuery)

Нэр	Төрөл	Тайлбар
`groupId`	string
`status`	string	Comma separated; default: every status except `pending` and `rejected`.
`country`	string
`email`	string	Exact email; wins over `search`.
`tenantId`	string
`search`	string
`tagIds`	string	Comma separated partner tag ids (any).
`sortBy`	string
`sortOrder`	string
`pageSize`	integer (int32)
`startingAfter`	string
`endingBefore`	string

Хариу: 202 JobDto

POST/v1/workspaces/{workspaceId}/partners/import

Start the import job. Existing enrollments are returned unchanged, unknown groups fail the row, unknown tags are created, banned partners are skipped.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (ImportBody)

Нэр	Төрөл	Заавал	Тайлбар
`csv`	string	тийм	The CSV text (header row required).
`mapping`	null \| ImportMapping

Хариу: 202 JobDto

POST/v1/workspaces/{workspaceId}/partners/import/preview

Mapping step and preview: detected headers, the remembered or suggested mapping and the first 10 rows validated.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (PreviewBody)

Нэр	Төрөл	Заавал	Тайлбар
`template`	string	тийм
`locale`	string		`en` (default) or `mn`.
`vars`	object

Хариу: 200 Preview

POST/v1/workspaces/{workspaceId}/partners/reactivate

Reactivate a deactivated partner; their links are re-enabled.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (PartnerRef)

Нэр	Төрөл	Заавал	Тайлбар
`partnerId`	string
`tenantId`	string

Хариу: 200 PartnerIdDto

GET/v1/workspaces/{workspaceId}/partners/stats

Enrollment counters of the program: partners per status and summed stats of enrolled ones.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 StatsDto

POST/v1/workspaces/{workspaceId}/partners/tags

Bulk "update tags": add and/or remove tags on up to 100 partners.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (BulkTags)

Нэр	Төрөл	Заавал
`linkIds`	string[]	тийм
`addTagIds`	string[]
`removeTagIds`	string[]

Хариу: 200 BulkOut

POST/v1/workspaces/{workspaceId}/partners/unarchive

Unarchive.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (PartnerRef)

Нэр	Төрөл	Заавал	Тайлбар
`partnerId`	string
`tenantId`	string

Хариу: 200 PartnerIdDto

POST/v1/workspaces/{workspaceId}/partners/unban

Unban: back to approved, links re-enabled.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (PartnerRef)

Нэр	Төрөл	Заавал	Тайлбар
`partnerId`	string
`tenantId`	string

Хариу: 200 PartnerIdDto

GET/v1/workspaces/{workspaceId}/partners/{partnerId}

Detail page data: the partner object plus applications, group history, advanced settings and the comment count.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм

Хариу: 200 PartnerDetail

PATCH/v1/workspaces/{workspaceId}/partners/{partnerId}

Change group, tenant id (re-tenants the partner's links) or the guarded advanced settings.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм

Хүсэлтийн бие (PatchPartner)

Нэр	Төрөл	Заавал	Тайлбар
`groupId`	string
`tenantId`	string
`ignoreMoveRules`	boolean
`excludeFromRisk`	boolean
`customerDataSharing`	boolean

Хариу: 200 PartnerDto

DELETE/v1/workspaces/{workspaceId}/partners/{partnerId}

Permanently delete a deactivated or banned partner without activity, or cancel an invite. Their links are deleted.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм

Хариу: 200 PartnerIdDto

GET/v1/workspaces/{workspaceId}/partners/{partnerId}/comments

Private comments on a partner, newest first.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм

Хариу: 200 CommentDto[]

POST/v1/workspaces/{workspaceId}/partners/{partnerId}/comments

Add a private comment.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм

Хүсэлтийн бие (CommentBody)

Нэр	Төрөл	Заавал	Тайлбар
`body`	string	тийм

Хариу: 201 CommentDto

PATCH/v1/workspaces/{workspaceId}/partners/{partnerId}/comments/{commentId}

Edit your own comment.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм
`commentId`	path	string	тийм

Хүсэлтийн бие (CommentBody)

Нэр	Төрөл	Заавал	Тайлбар
`body`	string	тийм

Хариу: 200 CommentDto

DELETE/v1/workspaces/{workspaceId}/partners/{partnerId}/comments/{commentId}

Delete your own comment.

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм
`commentId`	path	string	тийм

Хариу: 200 Deleted

POST/v1/workspaces/{workspaceId}/partners/{partnerId}/resend-invite

Resend an open invite (at most once per 24 hours; resets the 30 day expiry).

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм

Хариу: 200 PartnerIdDto

PUT/v1/workspaces/{workspaceId}/partners/{partnerId}/tags

Replace the tags of one partner (ids win over names; unknown names are created).

Шаардлагатай API түлхүүрийн хамрах хүрээ: partners.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`partnerId`	path	string	тийм

Хүсэлтийн бие (SetTags)

Нэр	Төрөл	Заавал	Тайлбар
`tagIds`	array
`tagNames`	array

Хариу: 200 TagBrief[]

GET/v1/workspaces/{workspaceId}/program-applications

The review queue: newest first, cursor pagination, X-Total-Count.

Шаардлагатай API түлхүүрийн хамрах хүрээ: applications.read

Параметр (9)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`status`	query	string		`pending` (default), `approved` or `rejected`.
`country`	query	string
`groupId`	query	string
`search`	query	string
`sortOrder`	query	string		`asc` or `desc` (default).
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string

Хариу: 200 ApplicationDto[]

POST/v1/workspaces/{workspaceId}/program-applications/approve

Approve an application: enrolls immediately, creates the links, emails the partner and fires partner.enrolled. 409 for a banned partner.

Шаардлагатай API түлхүүрийн хамрах хүрээ: applications.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (ApproveBody)

Нэр	Төрөл	Заавал	Тайлбар
`access`	string		`editor` (default) or `owner`.

Хариу: 200 PartnerIdDto

PUT/v1/workspaces/{workspaceId}/program-applications/auto-approve

Switch auto-approve for every group at once. Disabling needs confirm: true.

Шаардлагатай API түлхүүрийн хамрах хүрээ: applications.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (AutoApproveBody)

Нэр	Төрөл	Заавал	Тайлбар
`enabled`	boolean	тийм
`confirm`	boolean		Required when disabling.

Хариу: 200 AutoApproveOut

POST/v1/workspaces/{workspaceId}/program-applications/bulk

Bulk approve or reject: up to 100 partners, each decided independently.

Шаардлагатай API түлхүүрийн хамрах хүрээ: applications.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (BulkBody)

Нэр	Төрөл	Заавал	Тайлбар
`action`	string	тийм	`approve` or `reject`.
`partnerIds`	string[]	тийм
`groupId`	string
`tagIds`	array
`tagNames`	array
`rejectionReason`	string
`rejectionNote`	string
`reapplicationTimeframe`	string
`flagForFraud`	boolean
`flagForFraudReason`	string

Хариу: 200 BulkItem[]

GET/v1/workspaces/{workspaceId}/program-applications/pending-count

Badge count of the applications page.

Шаардлагатай API түлхүүрийн хамрах хүрээ: applications.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 PendingCount

POST/v1/workspaces/{workspaceId}/program-applications/reject

Reject an application.

Шаардлагатай API түлхүүрийн хамрах хүрээ: applications.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (RejectBody)

Нэр	Төрөл	Заавал	Тайлбар
`partnerId`	string	тийм
`applicationId`	string
`rejectionReason`	string
`rejectionNote`	string
`reapplicationTimeframe`	string		`instant`, `standard` (default, 30 days) or `never`.
`flagForFraud`	boolean
`flagForFraudReason`	string

Хариу: 200 PartnerIdDto

GET/v1/workspaces/{workspaceId}/program-applications/{applicationId}

One application with the partner profile and earlier submissions.

Шаардлагатай API түлхүүрийн хамрах хүрээ: applications.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`applicationId`	path	string	тийм

Хариу: 200 ApplicationDto