digitaluapi

<back to all web services

ChannelSmsMessagesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/channel_sms_messages/{Id}
ChannelSmsMessagesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
StatusCodesIdbodylongYes
ReferencebodystringNo
TenantsIdbodyintYes
ChannelMessagesIdbodylongYes
RecipientsbodystringYes
TemplatesIdbodyintYes
TemplateTextbodystringYes
DateCreatedbodyDateTimeOffsetYes
DateSentbodyDateTimeOffset?No
RetryCountbodyintYes
MessageGuidbodyGuidYes
ChannelSmsMessagesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
StatusCodesIdformlongNo
ReferenceformstringNo
TenantsIdformintNo
ChannelMessagesIdformlongNo
RecipientsformstringNo
TemplatesIdformintNo
TemplateTextformstringNo
DateCreatedformDateTimeOffsetNo
DateSentformDateTimeOffset?No
RetryCountformintNo
MessageGuidformGuidNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /channel_sms_messages/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"StatusCodesId":0,"Reference":"String","TenantsId":0,"ChannelMessagesId":0,"Recipients":"String","TemplatesId":0,"TemplateText":"String","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","RetryCount":0,"MessageGuid":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"StatusCodesId":0,"Reference":"String","TenantsId":0,"ChannelMessagesId":0,"Recipients":"String","TemplatesId":0,"TemplateText":"String","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","RetryCount":0,"MessageGuid":"00000000000000000000000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}