Sign in

v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Partner Action API:Actions

Add a partner action

post/partners/actions/{act}

Path parameters

act'Job' | 'JobAd' | 'Candidate' | 'JobApplication' | 'Placement' | 'Company' | 'Contact' string required

Action type. The type cannot be changed once assigned.

Request body

actionNamestring nullable required

Menu item label that will appear to the end-user

referencestring nullable

Unique partner defined reference/identifier for the action

urlstring uri nullable

URL to open after the action is selected and assigned the "Submitted" stage.
Templates parameters can be used in the URL to identify the resource submitted to the action

<table><tr><td>`{userId}`</td><td>Replaced with the User Id of the user performing the action</td></tr><tr><td>`{jobId}`</td><td>Replaced with the Job Id</td></tr><tr><td>`{adId}`</td><td>Replaced with the Job Ad Id</td></tr><tr><td>`{candidateId}`</td><td>Replaced with the Candidate Id</td></tr><tr><td>`{applicationId}`</td><td>Replaced with the Job Application Id</td></tr><tr><td>`{placementId}`</td><td>Replaced with the Placement Id</td></tr><tr><td>`{companyId}`</td><td>Replaced with the Company Id</td></tr><tr><td>`{contactId}`</td><td>Replaced with the Contact Id</td></tr></table>
urlType'Popup' | 'Page' | 'SideDrawer' string
allowResubmitboolean

Allow resources to be resubmitted to an action.

saltstring nullable

The secret for hashing secured Url

{"stackTrail":"components:schemas:AddPartnerActionCommand:properties:webhookData","oasType":"schema","type":"unknown","description":"Additional data to include with the webhook notification","nullable":true}

Response

OK

actionIdstring uuid

Unique identifier for the partner action

actionType'Job' | 'JobAd' | 'Candidate' | 'JobApplication' | 'Placement' | 'Company' | 'Contact' string
actionNamestring nullable

Menu item label that will appear to the end-user

referencestring nullable

Unique partner defined reference/identifier for the action

urlstring uri nullable

URL to open after the action is selected and assigned the "Submitted" stage.

urlType'Popup' | 'Page' | 'SideDrawer' string
allowResubmitboolean

Allow resources to be resubmitted to an action.

{"stackTrail":"components:schemas:PartnerActionRepresentation:properties:webhookData","oasType":"schema","type":"unknown","description":"Additional data that will be included with the webhook notification","nullable":true}
createdAtstring date-time

Date the partner action was added

updatedAtstring date-time

Date the partner action was last updated