POST /benefitPartner/v1/programs
Creates a single benefit program instance.
Creates a single benefit program instance with the specified data. In the request body, specify at least these required fields: url, startDate, endDate, description, title, urlAlias, and programPartner <b>Secured By Domain:</b> Manage: Benefit Program Software Partner <b>Scope:</b> Benefits Contains attachment(s)
Authentication
[
{
"OAuth2": []
}
]Request, responses and operation details
{
"tags": [
"programs"
],
"summary": "Creates a single benefit program instance.",
"description": "Creates a single benefit program instance with the specified data. \n\nIn the request body, specify at least these required fields: url, startDate, endDate, description, title, urlAlias, and programPartner\n\n<b>Secured By Domain:</b> Manage: Benefit Program Software Partner\n\n<b>Scope:</b> Benefits\n\nContains attachment(s)",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/benefitProgramsView_0216b21ecae410002d4cc96bee440000"
},
"x-workday-multipart-root-part-name": "jsonData"
}
},
"x-workday-multipart-root-part-name": "jsonData"
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/benefitProgramsView_0216b21ecae410002d4cc96bee440000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A1586 | End Date can't be before the Start Date. |\n| Critical | A1587 | Some of the required fields are missing : [fields] |\n| Critical | A1588 | URL Address must start with \"http://\" or \"https://\" |\n| Critical | A1624 | You don't have access to the web service. Request access from your Workday customer. |\n| Critical | A1625 | This image file type is unsupported. Use 1 of the following file types: JPG, JPEG, PNG, BMP or TIFF. |\n| Critical | A1626 | Use an image file with a size 5 MB or less. |\n| Critical | A1627 | Description: 120 character maximum. |\n| Critical | A1655 | Specify an image description in the Alternative Text field for workers that use assistive technology. Character limit: 60. |\n| Critical | A1655 | Title: 60 character maximum. |\n| Critical | A1656 | URL Alias: 24 character maximum. |\n| Critical | A1848 | Specify either the Wellbeing Interest or Wellbeing Category for the Benefit Programs, but not both. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "0216b21ecae410002d526247b5a50000",
"x-workday-secured-by-domains": [
"Manage: Benefit Program Software Partner"
]
}