Zum Hauptinhalt springen
POST
Publish an offer

Autorisierungen

Authorization
string
header
erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Pfadparameter

id
string<ulid>
erforderlich

Offer ID (ULID).

Body

application/json
recipientIds
string[]

IDs of existing recipients to notify.

notifyRecipients
boolean
Standard:false

Whether to send the invitation emails.

customMessage
string | null

Optional message for the invitation email.

newRecipients
object[]

Recipients to create and notify in one step.

Antwort

The publish outcome.

outcome
enum<string>
erforderlich

PUBLISHED when the offer went live, PENDING_APPROVAL when an approval workflow opened a request.

Verfügbare Optionen:
PUBLISHED,
PENDING_APPROVAL
requestId
string | null

Approval request ID when outcome is PENDING_APPROVAL.