Түнш хөтөлбөр

Хөтөлбөрийн тохиргоо ба брэндинг.

GET/v1/workspaces/{workspaceId}/program

The workspace's program.

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

Параметр (1)

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

Хариу: 200 ProgramDto

POST/v1/workspaces/{workspaceId}/program

Create the program (the wizard commit, spec 20 rules 1 to 13, 71, 72). One transaction creates the program, its default group (slug = workspace slug), the first reward, the default link definition, empty page drafts and the payout settings row.

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

Параметр (1)

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

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

Нэр	Төрөл	Заавал	Тайлбар
`name`	string	тийм
`domain`	string	тийм	Referral link domain: a verified workspace domain or a free az domain.
`url`	string	тийм	Default destination of partner links.
`logoFileId`	string	тийм	File id from `POST .../program/assets?purpose=logo`.
`wordmarkFileId`	string
`brandColor`	string
`supportEmail`	string	тийм
`helpUrl`	string
`termsUrl`	string
`timezone`	string
`attributionWindowDays`	integer (int32)
`reward`	RewardInput	тийм	The first reward of the default group (wizard step 2).
`inviteEmails`	string[]		Wizard step 3: invitations are requested after the program exists.

Хариу: 201 ProgramDto

PATCH/v1/workspaces/{workspaceId}/program

Update program settings. If-Match carries the version; changing the domain needs the owner or an admin and an explicit confirmation.

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

Параметр (1)

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

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

Нэр	Төрөл	Тайлбар
`name`	string
`url`	string
`supportEmail`	string
`helpUrl`	string
`termsUrl`	string
`brandColor`	string
`logoFileId`	string
`wordmarkFileId`	string
`attributionWindowDays`	integer (int32)
`customerDataSharing`	boolean
`messagingEnabled`	boolean
`timezone`	string
`domain`	string	New referral domain; needs `confirmDomainChange`.
`confirmDomainChange`	boolean
`payoutCutoff`	null \| PayoutCutoffInput

Хариу: 200 ProgramDto

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

Archive the program: partner links redirect to the program URL untracked and dashboards turn read-only. Needs confirm=true, the owner or an admin.

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

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`confirm`	query	boolean		Must be `true` to archive.

Хариу: 200 ProgramDto

POST/v1/workspaces/{workspaceId}/program/assets

Upload a program image or resource file: the raw bytes as the request body (at most 25 MB for resources, 2 MB for logos). Logos are PNG, JPEG or SVG and square. Pass the returned fileId to program create or update, or to a resource.

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

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`purpose`	query	string	тийм	`logo`, `wordmark` or `resource`.
`name`	query	string		File name shown to partners (resource uploads).

Хариу: 201 AssetDto

GET/v1/workspaces/{workspaceId}/program/groups/{groupId}/application-form

The group's application form draft (fixed fields plus custom questions).

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

Параметр (2)

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

Хариу: 200 PageDto

PUT/v1/workspaces/{workspaceId}/program/groups/{groupId}/application-form

Save the application form draft.

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

Параметр (2)

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

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

Нэр	Төрөл	Заавал	Тайлбар
`draft`	object	тийм	The whole draft document.
`locale`	string		`en` or `mn`.

Хариу: 200 PageDto

POST/v1/workspaces/{workspaceId}/program/groups/{groupId}/application-form/preview

Signed 24 hour preview link of the unpublished form.

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

Параметр (2)

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

Хариу: 200 PreviewDto

POST/v1/workspaces/{workspaceId}/program/groups/{groupId}/application-form/publish

Publish the application form.

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

Параметр (2)

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

Хариу: 200 PageDto

GET/v1/workspaces/{workspaceId}/program/groups/{groupId}/landing-page

The group's landing page draft with publish state. ETag carries the version.

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

Параметр (2)

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

Хариу: 200 PageDto

PUT/v1/workspaces/{workspaceId}/program/groups/{groupId}/landing-page

Save the landing page draft. If-Match guards concurrent editors.

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

Параметр (2)

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

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

Нэр	Төрөл	Заавал	Тайлбар
`draft`	object	тийм	The whole draft document.
`locale`	string		`en` or `mn`.

Хариу: 200 PageDto

POST/v1/workspaces/{workspaceId}/program/groups/{groupId}/landing-page/preview

Signed 24 hour preview link of the unpublished landing page.

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

Параметр (2)

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

Хариу: 200 PreviewDto

POST/v1/workspaces/{workspaceId}/program/groups/{groupId}/landing-page/publish

Publish the landing page draft atomically. Owner or admin; 409 while paused.

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

Параметр (2)

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

Хариу: 200 PageDto

POST/v1/workspaces/{workspaceId}/program/pause

Pause the program: landing pages show a notice, applications stop, links record clicks flagged paused and accrue nothing.

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

Параметр (1)

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

Хариу: 200 ProgramDto

GET/v1/workspaces/{workspaceId}/program/resources

Resources shown to partners, ordered by kind then position.

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

Параметр (1)

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

Хариу: 200 ResourceDto[]

POST/v1/workspaces/{workspaceId}/program/resources

Add a resource: at most 20 per kind.

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

Параметр (1)

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

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

Нэр	Төрөл	Заавал	Тайлбар
`kind`	string	тийм	`logo`, `color`, `link` or `file`.
`name`	string
`value`	string		Hex color (`color`) or https URL (`link`).
`fileId`	string		File from `POST .../program/assets?purpose=resource` (`file`, `logo`).

Хариу: 201 ResourceDto

PUT/v1/workspaces/{workspaceId}/program/resources/order

Reorder the resources of one kind.

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

Параметр (1)

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

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

Нэр	Төрөл	Заавал	Тайлбар
`kind`	string	тийм
`ids`	string[]	тийм	Every resource id of the kind in the new order.

Хариу: 200 ResourceDto[]

DELETE/v1/workspaces/{workspaceId}/program/resources/{resourceId}

Delete a resource: it disappears from partner dashboards at once and its download URL is revoked.

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

Параметр (2)

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

Хариу: 204

POST/v1/workspaces/{workspaceId}/program/resume

Resume a paused program; tracking restarts immediately.

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

Параметр (1)

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

Хариу: 200 ProgramDto

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

Reverse an archive within 90 days. Owner only.

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

Параметр (1)

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

Хариу: 200 ProgramDto