ClubReady Api

<back to all web services

CreateZipWhipMessageRequest

The following routes are available for this service:
POST/users/{UserId}/zipwhipmessage/createAdd a ZipWhip message to a user account.

export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

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

export class CreateZipWhipMessageRequestDto extends ApiDtoBase
{
    public UserId: number;
    public Subject: string;
    public Text: string;
    public PostedBy?: number;

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

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class CreateZipWhipMessageRequest extends CreateZipWhipMessageRequestDto implements IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * ClubReady Club ID (StoreID internally)
    */
    // @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * Create note for this ClubReady User ID
    */
    // @ApiMember(DataType="integer", Description="Create note for this ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
    public UserId: number;

    /**
    * Subject of the message (Up to 255 characters)
    */
    // @ApiMember(DataType="string", Description="Subject of the message (Up to 255 characters)", IsRequired=true, Name="Subject", ParameterType="query")
    public Subject: string;

    /**
    * Text body of the message (Up to 2000 characters)
    */
    // @ApiMember(DataType="string", Description="Text body of the message (Up to 2000 characters)", IsRequired=true, Name="Text", ParameterType="query")
    public Text: string;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

export class ApiResponseBase
{
    public Success: boolean;
    public Message: string;

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

export class CreateZipWhipMessageResponseDto extends ApiResponseBase
{
    public NoteId: number;
    public ContactLogId: number;
    public TaskId: number;

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

export class CreateZipWhipMessageResponse extends CreateZipWhipMessageResponseDto
{
    public Success: boolean;
    public Message: string;
    public NoteId: number;
    public ContactLogId: number;
    public TaskId: number;

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

TypeScript CreateZipWhipMessageRequest 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.

POST /users/{UserId}/zipwhipmessage/create HTTP/1.1 
Host: clubready.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApiKey":"String","StoreId":0,"UserId":0,"Subject":"String","Text":"String","RestrictedId":0,"RestrictedResourceType":"Store","PostedBy":0,"ChainId":0}

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

{"Success":false,"Message":"String","NoteId":0,"ContactLogId":0,"TaskId":0}