digitaluapi

<back to all web services

PartnerInvitesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/partner_invites/{Id}
PartnerInvitesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathintYes
TemplateTextbodystringNo
InviteGuidbodyGuidYes
PartnerAppUserIdbodyintYes
DateCreatedbodyDateTimeOffsetYes
DateSentbodyDateTimeOffset?No
RecipientsbodystringYes
ReferencebodystringNo
RetryCountbodyintYes
StatusCodesIdbodylongYes
PartnerInvitesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TemplateTextformstringNo
InviteGuidformGuidNo
PartnerAppUserIdformintNo
DateCreatedformDateTimeOffsetNo
DateSentformDateTimeOffset?No
RecipientsformstringNo
ReferenceformstringNo
RetryCountformintNo
StatusCodesIdformlongNo
ResponseStatusformResponseStatusNo

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

HTTP + OTHER

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

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

{"Id":0,"TemplateText":"String","InviteGuid":"00000000000000000000000000000000","PartnerAppUserId":0,"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}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"TemplateText":"String","InviteGuid":"00000000000000000000000000000000","PartnerAppUserId":0,"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,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}