{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Managing templates","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"managing-templates","__idx":0},"children":["Managing templates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following API endpoints can be used to create, update, view, and delete templates."," ","Templates can be used to create ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/spd_create_spdevent_workflow"},"children":["specialty desk trips"]}," and ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/spd_create_session_workflow"},"children":["session events"]},"."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Only the user profiles with the role of"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPANY_ADMIN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPANY_TRAVEL_ARRANGER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TRAVEL_ARRANGER"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TMC_ADMIN"]}," are allowed to create and manage templates."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-a-new-template","__idx":1},"children":["Creating a new template"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"30%","data-label":"Endpoint"},"children":["Endpoint "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/createeventtemplate"},"children":["Create a new template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/event-templates"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a new template for a recurring company program.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body contains:"]}," The event name, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldResponses"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["travelerTypes"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingStyle"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateId"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Other APIs will use:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateId"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Payment sources cannot be mapped using this endpoint."," ","After creating a new template, use the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/updatetemplatebookingguidelines"},"children":["update template guidelines"]}," endpoint to map the payment source to the template."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/createeventtemplate"},"children":["create a new template"]}," endpoint request"," ","there are optional fields such as the event ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},","," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["location"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedBookingTypes"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalNotes"]},", etc."," ","Any information provided in the request schema (i.e., both required and optional) of a template"," ","can be inherited when creating an ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/spd_create_spdevent_workflow"},"children":["SPD trip"]}," ","or a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/spd_create_session_workflow"},"children":["SPD session event"]}," from that template."," ","For example, administrators can use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalNotes"]}," field to provide"," ","instructions to the event coordinators when they create a new ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/spd_create_spdevent_workflow"},"children":["SPD trip"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ideally, a template should contain as much reusable information as possible."," ","This allows the event coordinators to prefill most recurring information, making the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/spd_create_spdevent_workflow"},"children":["SPD trip"]}," ","and the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/spd_create_session_workflow"},"children":["SPD event"]}," creation process faster and more efficient."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"updating-a-template","__idx":2},"children":["Updating a template"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following endpoints allow you to update an existing template."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Use the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/geteventtemplate"},"children":["get template"]}," ","endpoint to view template information before making any updates."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"30%","data-label":"Endpoint"},"children":["Endpoint "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/updatetemplatebasicinfo"},"children":["Update a template’s basic information"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/event-templates/{templateId}/edit-basic-info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a template’s basic information such as the name, description, internal notes, location, traveler types, booking style,"," ","and policy details.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateId"]}," generated using the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/createeventtemplate"},"children":["create an event template"]}," endpoint.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," The event ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalNotes"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["location"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["travelerTypes"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingStyle"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["policyId"]},"."," ","Include these optional fields based on which information you’d like to update."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/updatetemplatebookingguidelines"},"children":["Update a template’s booking guidelines"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/event-templates/{templateId}/edit-booking-guidelines"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a template’s booking guidelines such as allowed booking types (e.g., air, hotel, etc.),"," ","booking guidelines (e.g., allowed airports, departure and arrival windows, etc), and payment mappings.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateId"]}," generated using the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/createeventtemplate"},"children":["create an event template"]}," endpoint.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," The event ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingGuidelines"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowedBookingTypes"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentMappings"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/updatetemplatecustomfieldresponses"},"children":["Update a template’s custom field responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/event-templates/{templateId}/custom-field-responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update the template’s custom field responses that are presented to a traveler during checkout.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateId"]}," generated using the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/templateapi#operation/createeventtemplate"},"children":["create an event template"]}," endpoint.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseItems"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["travelerAccess"]}," (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["READ_ACCESS"]},")."]}]}]}]}]}]},"headings":[{"value":"Managing templates","id":"managing-templates","depth":1},{"value":"Creating a new template","id":"creating-a-new-template","depth":2},{"value":"Updating a template","id":"updating-a-template","depth":2}],"frontmatter":{"seo":{"title":"Managing templates"}},"lastModified":"2025-07-16T05:50:49.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/spotnana/spd_manage_template_workflow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}