digitaluapi

<back to all web services

ArchiveCampaign

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/campaign/archive/{PublicAccessGuid}Archive Campaign

export class ArchiveCampaignResponse
{
    public Success: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ArchiveCampaignResponse>) { (Object as any).assign(this, init); }
}

export class ArchiveCampaign
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public PublicAccessGuid: string;

    public constructor(init?: Partial<ArchiveCampaign>) { (Object as any).assign(this, init); }
}

TypeScript ArchiveCampaign DTOs

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.

POST /campaign/archive/{PublicAccessGuid} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PublicAccessGuid":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Success":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}