The API Change Log shows structural changes to API resources for each version. Each major release and current version patch release changes are shown starting with v15.0.
| RESOURCE | METHOD | VERB | ROUTE | CHANGE | VERSION | DESCRIPTION | CONTRACT | OLD | NEW |
|---|---|---|---|---|---|---|---|---|---|
| Custom | Create | Post | Custom/{resourceName} | Parameter Changed | 15.0.0 | resourceName has been marked as required. | Required | ||
| Custom | Delete | Delete | Custom/{resourceName}/{id} | Operation Changed | 15.0.0 | Route has changed from Custom/{resourceName}/{Id} to Custom/{resourceName}/{id} | Custom/{resourceName}/{Id} | Custom/{resourceName}/{id} | |
| Custom | Delete | Delete | Custom/{resourceName}/{id} | Parameter Changed | 15.0.0 | resourceName has been marked as required. | Required | ||
| Custom | Delete | Delete | Custom/{resourceName}/{id} | Parameter Added | 15.0.0 | id has changed from String to int | String | int | |
| Custom | Delete | Delete | Custom/{resourceName}/{id} | Parameter Changed | 15.0.0 | id has been marked as required. | Required | ||
| Custom | ExecuteLocalProcedure | Post | Custom/Execute | Parameter Added | 15.0.0 | New parameter added localProcedureRequest | localProcedureRequest | ||
| Custom | ExecuteLocalProcedure | Post | Custom/Execute | Parameter Removed | 15.0.0 | Parameter request removed. | request | ||
| Custom | ExecuteLocalProcedureWithMultipleResultSets | Post | Custom/Execute/MultipleResultSets | Operation Added | 15.1.0 | ExecuteLocalProcedureWithMultipleResultSets has been added. | ExecuteLocalProcedureWithMultipleResultSets | ||
| Custom | Get | Get | Custom/{resourceName}/{id} | Parameter Changed | 15.0.0 | resourceName has been marked as required. | Required | ||
| Custom | Get | Get | Custom/{resourceName}/{id} | Parameter Changed | 15.0.0 | id has been marked as required. | Required | ||
| Custom | GetAll | Get | Custom/{resourceName} | Parameter Changed | 15.0.0 | resourceName has been marked as required. | Required | ||
| Custom | GetMetadata | Get | Custom/Metadata | Response Type Changed | 15.1.0 | Response type has changed from HttpResponseMessage to TablesMetadata | HttpResponseMessage | TablesMetadata | |
| Custom | Update | Put | Custom/{resourceName}/{id} | Parameter Changed | 15.0.0 | resourceName has been marked as required. | Required | ||
| Custom | Update | Put | Custom/{resourceName}/{id} | Parameter Changed | 15.0.0 | id has been marked as required. | Required | ||
| Diagnostics | Delete | Delete | Diagnostics/{diagnosticId} | Parameter Added | 15.0.0 | diagnosticId has changed from String to int | String | int | |
| Diagnostics | Delete | Delete | Diagnostics/{diagnosticId} | Parameter Changed | 15.0.0 | diagnosticId has been marked as required. | Required | ||
| Diagnostics | GetApiPluginConfiguration | Get | Diagnostics/ApiPluginConfiguration | Operation Added | 15.1.7 | GetApiPluginConfiguration has been added. | GetApiPluginConfiguration | ||
| Diagnostics | GetStatus | Get | Diagnostics/Status | Property Added | 15.1.6 | TimeZone has been added to Status | Status | Status.TimeZone | |
| Diagnostics | Ping | Head | Diagnostics/Ping | Operation Added | 15.0.0 | Ping has been added. | Ping | ||
| Diagnostics | Put | Put | Diagnostics/{diagnosticId} | Parameter Added | 15.0.0 | diagnosticId has changed from String to int | String | int | |
| Diagnostics | Put | Put | Diagnostics/{diagnosticId} | Parameter Changed | 15.0.0 | diagnosticId has been marked as required. | Required | ||
| Emails | Send | Post | Emails/Send | Property Added | 15.1.0 | DuplicateBodyAsAttachment has been added to EmailSendRequest | EmailSendRequest | EmailSendRequest.DuplicateBodyAsAttachment | |
| Emails | Send | Post | Emails/Send | Property Added | 15.1.0 | DuplicateBodyAttachmentName has been added to EmailSendRequest | EmailSendRequest | EmailSendRequest.DuplicateBodyAttachmentName | |
| Emails | SendConstituentInfo | Post | Emails/ConstituentInfo/{constituentId}/Send | Operation Added | 15.0.0 | SendConstituentInfo has been added. | SendConstituentInfo | ||
| Emails | SendLoginCredentials | Post | Emails/LoginCredentials/{loginId}/Send | Property Added | 15.0.0 | NameValues has been added to SendTemplateEmailRequest | SendTemplateEmailRequest | SendTemplateEmailRequest.NameValues | |
| Emails | SendOrderConfirmation | Post | Emails/OrderConfirmation/{orderId}/Send | Property Added | 15.0.0 | NameValues has been added to SendTemplateEmailRequest | SendTemplateEmailRequest | SendTemplateEmailRequest.NameValues | |
| Emails | SendTickets | Post | Emails/Orders/{orderId}/Tickets/Send | Operation Added | 15.0.0 | SendTickets has been added. | SendTickets | ||
| Templates | Delete | Delete | Templates/{templateId} | Parameter Changed | 15.0.0 | templateId has been marked as required. | Required | ||
| Templates | Get | Get | Templates/{templateId} | Parameter Changed | 15.0.0 | templateId has been marked as required. | Required | ||
| Templates | GetConstituentInfo | Post | Templates/{templateId}/Constituent/{constituentId}/Info | Operation Added | 15.0.0 | GetConstituentInfo has been added. | GetConstituentInfo | ||
| Templates | GetLoginCredentials | Post | Templates/{templateId}/Login/{loginId}/Credentials | Operation Changed | 15.0.0 | Route verb has changed from Get to Post | Get | Post | |
| Templates | GetLoginCredentials | Post | Templates/{templateId}/Login/{loginId}/Credentials | Parameter Added | 15.0.0 | New parameter added request | request | ||
| Templates | GetOrderConfirmation | Post | Templates/{templateId}/Order/{orderId}/Confirmation | Operation Changed | 15.0.0 | Route verb has changed from Get to Post | Get | Post | |
| Templates | GetOrderConfirmation | Post | Templates/{templateId}/Order/{orderId}/Confirmation | Parameter Added | 15.0.0 | New parameter added request | request | ||
| Templates | GetSessionInfo | Post | Templates/{templateId}/Session/{sessionKey}/Info | Operation Removed | 15.1.0 | Operation removed. | GetSessionInfo | ||
| Templates | GetSessionInfo | Post | Templates/{templateId}/Session/{sessionKey}/Info | Operation Added | 15.0.0 | GetSessionInfo has been added. | GetSessionInfo | ||
| Templates | GetTickets | Post | Templates/{templateId}/Order/{orderId}/Tickets | Operation Changed | 15.1.0 | Route has changed from Templates/{templateId}/Orders/{orderId}/Tickets to Templates/{templateId}/Order/{orderId}/Tickets | Templates/{templateId}/Orders/{orderId}/Tickets | Templates/{templateId}/Order/{orderId}/Tickets | |
| Templates | GetTickets | Post | Templates/{templateId}/Orders/{orderId}/Tickets | Operation Added | 15.0.0 | GetTickets has been added. | GetTickets | ||
| Templates | RenderConstituentInfo | Post | Templates/Render/Constituent/{constituentId}/Info | Operation Added | 15.0.0 | RenderConstituentInfo has been added. | RenderConstituentInfo | ||
| Templates | RenderLoginCredentials | Post | Templates/Render/Login/{loginId}/Credentials | Response Type Changed | 15.0.0 | Response type has changed from TemplateBody to RenderResponse | TemplateBody | RenderResponse | |
| Templates | RenderLoginCredentials | Post | Templates/Render/Login/{loginId}/Credentials | Parameter Added | 15.0.0 | request has changed from TemplateBody to RenderRequest | TemplateBody | RenderRequest | |
| Templates | RenderOrderConfirmation | Post | Templates/Render/Order/{orderId}/Confirmation | Response Type Changed | 15.0.0 | Response type has changed from TemplateBody to RenderResponse | TemplateBody | RenderResponse | |
| Templates | RenderOrderConfirmation | Post | Templates/Render/Order/{orderId}/Confirmation | Parameter Added | 15.0.0 | request has changed from TemplateBody to RenderRequest | TemplateBody | RenderRequest | |
| Templates | RenderSessionInfo | Post | Templates/Render/Session/{sessionKey}/Info | Operation Removed | 15.1.0 | Operation removed. | RenderSessionInfo | ||
| Templates | RenderSessionInfo | Post | Templates/Render/Session/{sessionKey}/Info | Operation Added | 15.0.0 | RenderSessionInfo has been added. | RenderSessionInfo | ||
| Templates | RenderTickets | Post | Templates/Render/Order/{orderId}/Tickets | Operation Changed | 15.1.0 | Route has changed from Templates/Render/Orders/{orderId}/Tickets to Templates/Render/Order/{orderId}/Tickets | Templates/Render/Orders/{orderId}/Tickets | Templates/Render/Order/{orderId}/Tickets | |
| Templates | RenderTickets | Post | Templates/Render/Orders/{orderId}/Tickets | Operation Added | 15.0.0 | RenderTickets has been added. | RenderTickets | ||
| Templates | Update | Put | Templates/{templateId} | Parameter Changed | 15.0.0 | templateId has been marked as required. | Required |