Required role: | service |
POST | /emails/deliver |
---|
export class PostOperationUnTenanted<TResponse> implements IPost
{
public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class DeliverEmailResponse
{
public responseStatus?: ResponseStatus;
public isDelivered: boolean;
public constructor(init?: Partial<DeliverEmailResponse>) { (Object as any).assign(this, init); }
}
export class DeliverEmailRequest extends PostOperationUnTenanted<DeliverEmailResponse>
{
public message?: string;
public constructor(init?: Partial<DeliverEmailRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript DeliverEmailRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /emails/deliver HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"message":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"isDelivered":false}