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}
"use strict";
export class ClientInvitesEditResponse {
    /** @param {{Id?:number,InviteGuid?:string,DateCreated?:string,DateSent?:string,Recipients?:string,Reference?:string,RetryCount?:number,StatusCodesId?:number,TempateText?:string,TenantsId?:number,ClientsUserAuthId?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    InviteGuid;
    /** @type {string} */
    DateCreated;
    /** @type {?string} */
    DateSent;
    /** @type {string} */
    Recipients;
    /** @type {string} */
    Reference;
    /** @type {number} */
    RetryCount;
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    TempateText;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ClientsUserAuthId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ClientInvitesEdit {
    /** @param {{Id?:number,InviteGuid?:string,DateCreated?:string,DateSent?:string,Recipients?:string,Reference?:string,RetryCount?:number,StatusCodesId?:number,TempateText?:string,TenantsId?:number,ClientsUserAuthId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    InviteGuid;
    /** @type {string} */
    DateCreated;
    /** @type {?string} */
    DateSent;
    /** @type {string} */
    Recipients;
    /** @type {string} */
    Reference;
    /** @type {number} */
    RetryCount;
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    TempateText;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ClientsUserAuthId;
}

JavaScript ClientInvitesEdit DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}