ShopCreate Promote Clickout Link

Create Promote Clickout Link

Create a clickout link that signs the user in and drops them on the promote page of a single job, ready to book reach for it.

The job is looked up by its external_job_id within the company. Kini refreshes the job from the ATS first, and creates the job if it does not exist yet, so the link also works for a job your system has only just published.

curl -X POST "https://api.getkini.com/clickout/promote/" \
  -H "Content-Type: application/json" \
  -H "Company-Id: 1" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "email": "jane.doe@example.com",
  "external_job_id": "EXT-123456",
  "product_type": "campaign"
}'
{
  "data": "https://app.getkini.com/companies/1/jobs/123456/promote?tab=campaign"
}
POST
/clickout/promote/
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Authenticate every request with an API key from the Kini Partner App, sent as Authorization: Bearer <your_api_key>.

Authenticate every request with an API key from the Kini Partner App, sent as Authorization: Bearer <your_api_key>.
Content-Typestring
Required

The media type of the request body

Options: application/json
header
Company-Idinteger
Required

Kini ID of the company the key is associated with

emailstring
Required

Email address of the user the link is issued for. A shop user is created and added to the company on first use.

Format: email
external_job_idstring
Required

The job's ID in your system. Must be unique within the company.

product_typestring

Preselect a tab on the promote page. Enum: single (single job bookings), campaign (campaigns).

Options: single, campaign
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Authenticate every request with an API key from the Kini Partner App, sent as Authorization: Bearer \<your_api_key\>.

Headers

Company-Idinteger
Required

Kini ID of the company the key is associated with

Example:
1

Body

application/json
emailstring
Required

Email address of the user the link is issued for. A shop user is created and added to the company on first use.

Example:
jane.doe@example.com
external_job_idstring
Required

The job's ID in your system. Must be unique within the company.

Example:
EXT-123456
product_typestring

Preselect a tab on the promote page. Enum: single (single job bookings), campaign (campaigns).

Allowed values:singlecampaign

Responses

datastring

Clickout URL. Signs the user in and lands them on the target page. Valid for one hour.