Pega API HTTP status codes and errors

The Pega API returns several HTTP status codes. When an error occurs, a Pega API error ID and corresponding message may also be returned in the response body.

The table below provides a complete list of HTTP status codes and Pega API errors.

For more information on the Pega API, see the Pega API documentation provided in the Designer Studio Pega API resources page.

For more information about HTTP status codes, refer to the IANA Hypertext Transfer Protocol (HTTP) Status Code Registry.

HTTP status code	HTTP status reason	Pega API error ID	Pega API error message	APIs that return HTTP status code
200	OK	None		All APIs except: Create a new case `POST/cases` Update a case `PUT/cases/{ID}`
201	Created	None		Create a new case `POST/cases`
204	No content	None		Update a case `PUT/cases/{ID}`
400	Bad request	`Pega_API_001`	Invalid request data	Perform assignment action `POST/assignments/{ID}` Create a new case `POST/cases` Update a case `PUT/cases/{ID}`
		`Pega_API_002`	The parameter actionID is required for this request	Perform assignment action `POST/assignments/{ID}`
		`Pega_API_003`	The parameter ID is required for this request	Perform assignment action `POST/assignments/{ID}` Update a case `PUT/cases/{ID}`
		`Pega_API_004`	The parameter caseTypeID is required for this request	Create a new case `POST/cases`
		`Pega_API_007`	Action not found for the given parameter actionID	Perform assignment action `POST/assignments/{ID}` Update a case `PUT/cases/{ID}`
		`Pega_API_008`	Case Type not found for the given parameter caseTypeID	Create a new case `POST/cases`
		`Pega_API_009`	Process not found for the given parameter processID	Create a new case `POST/cases`
		`Pega_API_010`	Parent case not found for the given parameter parentCaseID	Create a new case `POST/cases`
401	Unauthorized	None		All APIs
403	Forbidden	`Pega_API_012`	Unauthorized access for the given parameter ID	Perform assignment action `POST/assignments/{ID}` Get case details `GET/cases/{ID}` Update a case `PUT/cases/{ID}`
		`Pega_API_016`	Unauthorized to create a new case	Create a new case `POST/cases`
		`Pega_API_019`	Insufficient privilege	All APIs
		`Pega_API_020`	Missing If-Match request header	Update a case `PUT/cases/{ID}`
		`Pega_API_022`	Use of TLS/SSL is required	All APIs
404	Not found	`Pega_API_006`	Assignment not found for the given parameter ID	Get assignment details `GET /assignments/{ID}` Perform assignment action `POST /assignments/{ID}`
		`Pega_API_011`	Case not found for the given parameter ID	Get case details `GET /cases/{ID}` Update a case `PUT/cases/{ID}`
		`Pega_API_017`	Data page not found for the given parameter ID	Get data page contents `GET /data/{ID}` Get data page metadata `GET /data/{ID}/metadata`
		`Pega_API_018`	Missing required data page parameters	Get data page contents `GET /data/{ID}`
405	Method not allowed	None		All APIs
412	Precondition failed	`Pega_API_021`	Unauthorized access: If-Match does match ETag	Update a case `PUT/cases/{ID}`
500	Internal server error	None		All APIs