Jobs
Update paycheck settings or deactivate a job
Update this job to set where pay should be deposited for paychecks related to this job, or deactivate on-demand pay for this job. Returns the job object if the update succeeded. Returns an error if update parameters are invalid.
patch/rest/jobs/{job_id}
Request
- Base URLhttps://api.dailypay.com
- AuthOAuth 2Authorization codehttps://auth.dailypay.com/oauth2/authToken URLhttps://auth.dailypay.com/oauth2/tokenScopesuser:read_write
Path parameters
job_idstring uuid required
Example:e9d84b0d-92ba-43c9-93bf-7c993313fa6f
Unique ID of the job
Headers
DailyPay-API-Versioninteger
The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.
Request body
Example request
{
"data": {
"id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f",
"relationships": {
"direct_deposit_default_depository": {
"data": {
"id": "2bc7d781-3247-46f6-b60f-4090d214936a"
}
},
"direct_deposit_default_card": {
"data": {
"id": "2bc7d781-3247-46f6-b60f-4090d214936a"
}
}
},
"attributes": {
"activation_status": "DEACTIVATED"
}
}
}Response
Returns the job object.
Example response
{
"data": {
"id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f",
"attributes": {
"external_identifiers": {
"primary_identifier": "0123456789"
},
"first_name": "Edith",
"last_name": "Clarke",
"activation_status": "DEACTIVATED",
"wage_rate": {
"amount": 2500,
"currency": "USD",
"frequency": "HOURLY"
},
"title": "Computer",
"department": "Finance",
"location": "New York, New York",
"direct_deposit_status": "SETUP_COMPLETE"
},
"links": {
"self": "https://api.dailypay.com/rest/jobs/e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "3fa8f641-5717-4562-b3fc-2c963f66afa6"
}
},
"organization": {
"data": {
"id": "f0b30634-108c-439c-a8c1-c6a91197f022"
}
},
"direct_deposit_default_depository": {
"data": {
"id": "2bc7d781-3247-46f6-b60f-4090d214936a"
}
},
"direct_deposit_default_card": {
"data": {
"id": "2bc7d781-3247-46f6-b60f-4090d214936a"
}
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.