API - Settings

Settings

Those endpoints allow you to manage the settings of a specific account.

Endpoints

get/api/v3/notification/settings

Return a paginated list of notification/settings

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
send_email_categories?: unknown
send_summary_email?: unknown
sent_summary_at?: unknown
created_at?: unknown
updated_at?: unknown
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    send_email_categories?: any;
    send_summary_email?: any;
    sent_summary_at?: any;
    created_at?: any;
    updated_at?: any;
  };
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
send_email_categories?:
dictionary
Values: boolean
send_summary_email?: boolean
sent_summary_at?: datetime
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      send_email_categories?: { [key: string]: boolean };
      send_summary_email?: boolean;
      sent_summary_at?: Date;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

get/api/v3/notification/settings/:resource_id

Show a specific notification/settings

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
send_email_categories?:
dictionary
Values: boolean
send_summary_email?: boolean
sent_summary_at?: datetime
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      send_email_categories?: { [key: string]: boolean };
      send_summary_email?: boolean;
      sent_summary_at?: Date;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/notification/settings/:resource_id

Update a notification/settings

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
send_email_categories?:
dictionary
Values: boolean
send_summary_email?: boolean

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      send_email_categories?: { [key: string]: boolean };
      send_summary_email?: boolean;
    };
  };
};