Booklinker.API

<back to all web services

PutAccountRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/account

// @DataContract
export class V2BaseResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

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

// @DataContract
export class PutAccountResponseData
{
    // @DataMember(Name="oneTimeToken")
    public oneTimeToken: string;

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

// @DataContract
export class PutAccountResponse extends V2BaseResponse
{
    // @DataMember(Name="data")
    public data: PutAccountResponseData;

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

export enum SignatureAppearance
{
    None = 'none',
    Text = 'text',
    Upload = 'upload',
}

// @DataContract
export class PutAccountRequest
{
    // @DataMember(Name="emailAddress")
    public emailAddress: string;

    // @DataMember(Name="fullName")
    public fullName: string;

    // @DataMember(Name="profileImageId")
    public profileImageId: string;

    // @DataMember(Name="signatureImageId")
    public signatureImageId: string;

    // @DataMember(Name="signatureFont")
    public signatureFont: string;

    // @DataMember(Name="signatureAppearance")
    public signatureAppearance: SignatureAppearance;

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

TypeScript PutAccountRequest DTOs

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 /v1/account HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"newEmail":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false,"oneTimeToken":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}