FlashPost Bayt documentation

Create listing

full example minimal example

Field	Mandatory	Description
anonymous	forbidden	cannot be used for this job board
companyDetails	required	Company details
customerId	required	ID number
jobBoardIds	required	ID number
jobDetails	required	Job details
providerReferenceId	required	string length must be between 1 and 255
templateId	forbidden	cannot be used for this job board
walletId	optional	ID number will be provided by your Sales Representative if needed

Update listing

full example minimal example

Field	Mandatory	Description
companyDetails	required	Company details
jobBoardIds	required	ID number
jobDetails	required	Job details
templateId	forbidden	cannot be used for this job board

Company details

Field	Mandatory	Description
contactAddress	optional	Contact address
contactName	required	string length must be between 1 and 255
contactPhone	optional	string length must be between 7 and 255

Job details

Field	Mandatory	Description
applicationMethod	required	Application method
categories	required	Categories
description	required	Description
jobAddress	optional	Job address
language	required	string ISO 639 alpha-2 language code
salary	optional	Salary
title	required	string length must be between 1 and 255

Contact address

Field	Mandatory	Description
city	optional	string length must be between 1 and 255
country	optional	string ISO 3166 alpha-2 country code. length must be exactly 2
postcode	optional	string length must be between 1 and 255
street	optional	string length must be between 1 and 255

Application method

must contain at least one of the following: applicationUrl, email

Field	Mandatory	Description
applicationUrl	optional	string must have a valid URL format (i.e. https://example.org/page) length must be between 1 and 2083
email	optional	string must have a valid email format length must be between 1 and 255

Categories

Field	Mandatory	Description
contractType	required	ID number See also: Available IDs
education	optional	ID number See also: Available IDs
experience	required	ID number See also: Available IDs
geography	required	array of ID numbers See also: Available IDs
sector	required	ID number See also: Available IDs
workfield	required	ID number See also: Available IDs

Description

Field	Mandatory	Description
structuredDescription	required	Structured description

Job address

Field	Mandatory	Description
country	optional	string ISO 3166 alpha-2 country code.

Salary

information required only in case salary property is specified for the job listing
the information submitted may be converted to match job board's requirements
salary's max value cannot be higher than 160% of salary's min

Field	Mandatory	Description
currency	required	string ISO 4217 currency code See also: List of accepted currency codes
hidden	forbidden	cannot be used for this job board
max	required	number
min	required	number
period	required	one of: "MONTH", "YEAR"

Structured description

Field	Mandatory	Description
companyIntroduction	required	string length must be between 1 and 2500
description	required	string length must be between 1 and 2500
requiredProfile	required	string length must be between 1 and 2500
typeOfContent	optional	one of: "HTML", "TEXT"