Mutations
Mutations allow for modifying data within the Worksome API.
acceptBid
Type: Hire!
Hire a worker for a job.
Only companies can make hires.
Once a hire is created a draft contract will automatically be created also, Hire.latestContract
, which will be pending acceptance from the other party (usually a worker).
Arguments |
---|
input AcceptBidInput! |
actionApprovalApprovable
Type: ApprovalApprovable
Create action for an approval approvable.
Arguments |
---|
input ActionApprovalApprovableInput! |
approveTrustedContact
Type: TrustedContact!
Approve a trusted contact.
Only companies can approve trusted contacts.
Arguments |
---|
input ApproveTrustedContactInput! |
attachJobsToProject
Type: Project!
Attach one or more jobs to a project.
Only companies can attach jobs to projects.
Arguments |
---|
input AttachJobsToProjectInput! |
attachUsersToUserGroup
Type: UserGroup!
Attach one or more users to a group.
Only companies can attach users to groups.
Arguments |
---|
input AttachUsersToUserGroupInput! |
attributeRecruiterToHire
Type: Hire!
Attribute a recruiter to a hire.
Only companies can attribute recruiters to their hires.
Arguments |
---|
input AttributeRecruiterToHireInput! |
blockTrustedContact
Type: TrustedContact!
Block an applied trusted contact.
Only companies can block trusted contacts.
Arguments |
---|
input BlockTrustedContactInput! |
cancelHire
Type: Hire!
Cancel a hire.
Only companies can cancel their hires.
Arguments |
---|
input CancelHireInput! |
changeEmail
Type: User!
Change the email of the currently authenticated user.
Arguments |
---|
input ChangeEmailInput! |
createApproval
Type: Approval!
Create an approval.
Only companies can create approvals.
Arguments |
---|
input CreateApprovalInput! |
createApprovalRule
Type: ApprovalRule!
Create an approval rule for one or more fields.
Arguments |
---|
input CreateApprovalRuleInput! |
createApprover
Type: Approver!
Create an approver for an approver rule.
Arguments |
---|
input CreateApproverInput! |
createCompanyRecruiter
Type: CompanyRecruiter
Add and invite a new recruiter.
Only companies can add and invite recruiters.
Arguments |
---|
input CreateCompanyRecruiterInput! |
createCustomField
Type: CustomField!
Create a custom field.
Arguments |
---|
input CreateCustomFieldInput! |
createCustomTimesheet
Type: CreateCustomTimeSheetResponse!
Create a custom timesheet.
Use this endpoint to create timesheets in Worksome from a custom data format. The endpoint requires data in a custom format, as defined by the input schema.
Arguments |
---|
input CreateCustomTimesheetInput! |
createExport
Type: CreateExportResponse
Create an export.
The export URL and the number of rows will be returned (excluding headings).
Arguments |
---|
input CreateExportInput! |
createJob
Type: Job!
Create a job.
Only companies can create jobs.
Arguments |
---|
input CreateJobInput! |
createJobCandidate
Type: [JobCandidate!]!
Create a job candidate.
This will make the workers eligible and proposed for a job.
Arguments |
---|
input CreateJobCandidateInput! |
createJobShare
Type: [JobShare!]!
Create a job share.
Arguments |
---|
input CreateJobShareInput! |
createMilestones
Type: [Milestone!]!
Create one or more milestones.
Arguments |
---|
input CreateMilestonesInput! |
createNote
Type: Note!
Create a note.
Arguments |
---|
input CreateNoteInput! |
createPassword
Type: User!
Create a password for the authenticated user.
This operation is only allowed if the user currently does not have a password for changing the password see updatePassword
operation instead.
Arguments |
---|
input CreatePasswordInput! |
createPaymentRequest
Type: PaymentRequest!
Create a payment request.
Arguments |
---|
input CreatePaymentRequestInput! |
createProject
Type: Project!
Create a project.
Only companies can create projects.
Arguments |
---|
input CreateProjectInput! |
createRecruiterCandidate
Type: RecruiterCandidate
Add and invite a new candidate.
Only recruiters can add and invite candidates.
Arguments |
---|
input CreateRecruiterCandidateInput! |
createSmsMultiFactor
Type: SmsCreateMultiFactorPayload!
Create a new multi-factor authentication implementation.
Arguments |
---|
input CreateSmsMultiFactorInput! |
createTimesheet
Type: Timesheet
Create a timesheet.
Only workers can create timesheets.
Arguments |
---|
input CreateTimesheetInput! |
createTotpMultiFactor
Type: TotpCreateMultiFactorPayload!
Create a new multi-factor authentication implementation.
Arguments |
---|
input CreateTotpMultiFactorInput! |
createTrustedContact
Type: TrustedContact!
Add and invite a new trusted contact.
Only companies can add & invite trusted contacts.
Arguments |
---|
input CreateTrustedContactInput! |
createUserGroup
Type: UserGroup!
Create a user group.
Only companies can create user groups.
Arguments |
---|
input CreateUserGroupInput! |
createWebhook
Type: Webhook!
Create a webhook.
Only companies can create webhooks.
Arguments |
---|
input CreateWebhookInput! |
createWorkflow
Type: Workflow!
Create a workflow.
Only companies can create workflows.
Arguments |
---|
input CreateWorkflowInput! |
deleteCompanyRecruiter
Type: CompanyRecruiter
Delete a recruiter relationship.
Both the company and the recruiter can delete the relationship.
Arguments |
---|
input DeleteCompanyRecruiterInput! |
deleteCustomField
Type: CustomField!
Delete a custom field.
All fields details must be provided.
Arguments |
---|
input DeleteCustomFieldInput! |
deleteMilestones
Type: [Milestone!]!
Delete one or more milestones.
Arguments |
---|
input DeleteMilestonesInput! |
deleteNote
Type: Note!
Delete a note.
Arguments |
---|
input DeleteNoteInput! |
deletePaymentRequest
Type: PaymentRequest!
Delete a payment request.
Arguments |
---|
input DeletePaymentRequestInput! |
deleteProject
Type: Project!
Soft delete a project.
Only companies can delete projects.
Arguments |
---|
input DeleteProjectInput! |
deleteRecruiterCandidate
Type: RecruiterCandidate
Delete a recruiter candidate relationship.
Both the recruiter and the candidate can delete the relationship.
Arguments |
---|
input DeleteRecruiterCandidateInput! |
deleteTimesheet
Type: Timesheet!
Delete a timesheet.
Only workers can delete timesheets.
Arguments |
---|
input DeleteTimesheetInput! |
deleteTimesheetRegistration
Type: TimesheetRegistration!
Delete a timesheet registration.
Only workers can delete timesheet registrations.
Arguments |
---|
input DeleteTimesheetRegistrationInput! |
deleteTrustedContact
Type: TrustedContact
Delete a trusted contact.
Only companies can delete trusted contacts.
Arguments |
---|
input DeleteTrustedContactInput! |
deleteUserGroup
Type: UserGroup!
Soft delete a user group.
Only companies can delete user groups.
Arguments |
---|
input DeleteUserGroupInput! |
deleteWebhook
Type: Webhook!
Delete a webhook.
Arguments |
---|
input DeleteWebhookInput! |
deleteWorkflow
Type: Workflow!
Delete a workflow.
Only companies can delete workflows.
Arguments |
---|
input DeleteWorkflowInput! |
detachJobFromProject
Type: Project!
Detach a job from a project
Only companies can detach a job from a project.
Arguments |
---|
input DetachJobFromProjectInput! |
detachUsersFromUserGroup
Type: UserGroup!
Detach one or more user from a group.
Only companies can detach users from a group.
Arguments |
---|
input DetachUsersFromUserGroupInput! |
endJob
Type: Job!
End a job.
Only companies can end jobs.
Arguments |
---|
input EndJobInput! |
endProject
Type: Project!
End a project.
This is used to set an end date on the project to consider it no longer active.
Arguments |
---|
input EndProjectInput! |
forceLogoutUser
Type: ForceLogoutPayload!
Log out of other sessions.
This will invalidate all session tokens.
Arguments |
---|
input ForceLogoutInput! |
generateInviteLink
Type: Company!
Generate the company invite link token.
Arguments |
---|
input GenerateInviteLinkInput! |
hire
Type: Hire!
Hire a trusted contact.
Only companies can make hires.
Arguments |
---|
input HireInput! |
impersonateUser
Type: AuthenticationToken!
Creates a token which can be used for authenticating as the selected user.
To stop the impersonation, simply use the old token again.
Arguments |
---|
input ImpersonateInput! |
inviteCompanyRecruiter
Type: CompanyRecruiter!
Invite an existing recruiter.
Only companies can invite the recruiter.
Arguments |
---|
input InviteCompanyRecruiterInput! |
manageOnboardingDocuments
Type: Company
Manage Onboarding documents.
Arguments |
---|
input ManageOnboardingDocumentsInput! |
markFilesAsUploaded
Type: [File!]!
Mark one or more files as uploaded to the temporary URL.
Arguments |
---|
input MarkFilesAsUploadedInput! |
openProject
Type: Project!
Open a project.
This is used to set the end date on the project to null
to make it open again.
Arguments |
---|
input OpenProjectInput! |
reinviteTrustedContact
Type: TrustedContact!
Resend an invitation to a Trusted Contact that already exists in the Talent Pool.
This can be used for workers that has not responded to the initial invitation or for workers that was previously managed by a Staffing Agency.
Arguments |
---|
input ReinviteTrustedContactInput! |
rejectHire
Type: Hire!
Reject a hire.
Arguments |
---|
input RejectHireInput! |
removeJobShare
Type: [JobShare!]!
Remove a job share.
Arguments |
---|
input RemoveJobShareInput! |
removeMultiFactor
Type: MultiFactor
Remove a multi-factor authentication implementation.
Arguments |
---|
input RemoveMultiFactorInput! |
removeOnboardingDocuments
Type: Company
Remove Onboarding documents.
Arguments |
---|
input RemoveOnboardingDocumentsInput! |
removeRecruiterFromHire
Type: Hire!
Remove a recruiter from a hire.
Only companies can remove recruiters from their hires.
Arguments |
---|
input RemoveRecruiterFromHireInput! |
retryWebhookEvent
Type: WebhookEvent!
Retry a webhook event.
Only companies can retry webhook events.
Arguments |
---|
input RetryWebhookEventInput! |
sendVerificationEmail
Type: User!
Sends a new verification email.
This operation is only allowed if the user has not verified their email.
setInternalBudgetOnJob
Type: Job!
Set the internal budget of a job.
Only companies can set the internal budget on the job.
Arguments |
---|
input SetInternalBudgetOnJobInput! |
shareHire
Type: Hire!
Share/offer a hire with a worker.
Only companies can remove recruiters from their hires.
Arguments |
---|
input ShareHireInput! |
storeBankDetails
Type: BankDetail!
Update the bank account details.
Arguments |
---|
input StoreBankDetailsInput! |
terminateHire
Type: Hire!
Terminate a hire.
Arguments |
---|
input TerminateHireInput! |
updateApproval
Type: Approval!
Update an approval.
Arguments |
---|
input UpdateApprovalInput! |
updateApprover
Type: Approver!
Update an approver.
Arguments |
---|
input UpdateApproverInput! |
updateCompanyRecruiter
Type: CompanyRecruiter
Update a recruiter relationship.
Only companies can edit recruiter relationships.
Arguments |
---|
input UpdateCompanyRecruiterInput! |
updateCustomField
Type: CustomField!
Update a custom field.
All fields must be provided.
Arguments |
---|
input UpdateCustomFieldInput! |
updateJob
Type: Job!
Update a job.
Only companies can update jobs.
Arguments |
---|
input UpdateJobInput! |
updateJobCandidatePreferred
Type: JobCandidate!
Update job candidates “preferred” status.
Arguments |
---|
input UpdateJobCandidatePreferredInput! |
updateJobCandidateStatus
Type: JobCandidate!
Update a job candidate status.
A reason and comment can be provided.
Arguments |
---|
input UpdateJobCandidateStatusInput! |
updateMilestones
Type: [Milestone!]!
Update one or more milestones.
Arguments |
---|
input UpdateMilestonesInput! |
updateNote
Type: Note!
Update a note.
Arguments |
---|
input UpdateNoteInput! |
updatePassword
Type: User!
Update a user’s password.
Arguments |
---|
input UpdatePasswordInput! |
updatePaymentRequest
Type: PaymentRequest!
Update a payment request.
Arguments |
---|
input UpdatePaymentRequestInput! |
updateProject
Type: Project!
Update a project.
Only companies can update projects.
Arguments |
---|
input UpdateProjectInput! |
updateRecruiterCandidate
Type: RecruiterCandidate
Update a recruiter candidate information.
Only recruiters can edit the relationship.
Arguments |
---|
input UpdateRecruiterCandidateInput! |
updateTimesheet
Type: Timesheet!
Update a timesheet.
Only workers can update timesheets.
Arguments |
---|
input UpdateTimesheetInput! |
updateTimesheetRegistration
Type: TimesheetRegistration!
Update a timesheet registration.
Only workers can update timesheet registrations.
Arguments |
---|
input UpdateTimesheetRegistrationInput! |
updateTrustedContact
Type: TrustedContact!
Update a trusted contact.
Only companies can edit trusted contacts.
Arguments |
---|
input UpdateTrustedContactInput! |
updateUserGroup
Type: UserGroup!
Update a user group.
Only companies can update user groups.
Arguments |
---|
input UpdateUserGroupInput! |
updateWebhook
Type: Webhook!
Update a webhook.
Arguments |
---|
input UpdateWebhookInput! |
updateWorker
Type: Worker!
Update a worker.
Arguments |
---|
input UpdateWorkerInput! |
updateWorkflow
Type: Workflow!
Update a workflow.
Only companies can create workflows.
Arguments |
---|
input UpdateWorkflowInput! |
updateWorksomeIntelligenceConsent
Type: Boolean!
Update consent to use Worksome Intelligence for the current user.
Arguments |
---|
input UpdateWorksomeIntelligenceConsentInput! |
uploadFiles
Type: [TemporaryFileUploadResponse!]!
Generate temporary upload URLs for files for the given account.
The temporary URL will expire after 1 week.
Arguments |
---|
input [UploadFileInput!]! |
verifySmsMultiFactor
Type: SmsMultiFactor
Verify a multi-factor authentication implementation.
Arguments |
---|
input VerifySmsMultiFactorInput! |
verifyTotpMultiFactor
Type: TotpMultiFactor
Verify a TOTP multi-factor authentication implementation.
Arguments |
---|
input VerifyTotpMultiFactorInput! |