Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /messages/templates/{Id} | Updates an existing company message templates | Update an existing company message templates. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
Id | path | int | Yes | The message template id. |
TypeId | body | int? | No | The message type id. See GET /messages/templates/types |
Default | body | bool? | No | The message should be default and the one to be used. All other messages for the same message type will be set to Default = false |
Name | body | string | No | The message template name. |
Title | body | string | No | The message template title. |
Body | body | string | No | The message template title. |
Sender | body | string | No | The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set). |
Language | body | string | Yes | Message template lanugage |
Services | body | int[] | No | The services that is connected to the template. If null it will be connected to all services. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The message template id |
Name | form | string | No | The message template name. |
Title | form | string | No | The message template title. |
Body | form | string | No | The message template title. |
Sender | form | string | No | The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set). |
Default | form | bool | No | If the message template is the default message currently in use. |
MessageType | form | MessageTypeQueryResponse | No | If the message type information. |
Language | form | string | No | Template language. |
Services | form | List<MessageServices> | No | The connected services which the template is valid for. If empty then it's valid for all services. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The message type id |
Name | form | string | No | The message type name. |
Description | form | string | No | The message type description. |
MaxCharacters | form | int | No | The maximum number of charachters that can be entered into message body using this type. |
DefaultText | form | string | No | The default text that is always included when sending messages of this type. |
SendMethodId | form | int | No | The send method for this type. 1 = Email, 2 = SMS. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | Name of the service |
ImageUrl | form | Uri | No | The image url of the service |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /messages/templates/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Id: 0,
TypeId: 0,
Default: False,
Name: String,
Title: String,
Body: String,
Sender: String,
Language: String,
Services:
[
0
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Id: 0, Name: String, Title: String, Body: String, Sender: String, Default: False, MessageType: { Id: 0, Name: String, Description: String, MaxCharacters: 0, DefaultText: String, SendMethodId: 0 }, Language: String, Services: [ { Id: 0, Name: String } ] }