digitaluapi

<back to all web services

ClientInvitesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/client_invites/{Id}
ClientInvitesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathintYes
InviteGuidbodyGuidYes
DateCreatedbodyDateTimeOffsetYes
DateSentbodyDateTimeOffset?No
RecipientsbodystringYes
ReferencebodystringNo
RetryCountbodyintYes
StatusCodesIdbodylongYes
TempateTextbodystringNo
TenantsIdbodyintYes
ClientsUserAuthIdbodyintYes
ClientInvitesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
InviteGuidformGuidNo
DateCreatedformDateTimeOffsetNo
DateSentformDateTimeOffset?No
RecipientsformstringNo
ReferenceformstringNo
RetryCountformintNo
StatusCodesIdformlongNo
TempateTextformstringNo
TenantsIdformintNo
ClientsUserAuthIdformintNo
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /client_invites/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":0,"InviteGuid":"00000000000000000000000000000000","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","Recipients":"String","Reference":"String","RetryCount":0,"StatusCodesId":0,"TempateText":"String","TenantsId":0,"ClientsUserAuthId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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