Type Alias ListCreateParameters

ListCreateParameters: {
    additional_permissions?: ListPermission[];
    is_public: boolean;
    name: string;
    owner_id?: number;
    type: EntityType;
}

Type declaration

  • Optionaladditional_permissions?: ListPermission[]

    A list of additional internal persons and the permissions they should have on the list.

  • is_public: boolean

    Set to true to make the list publicly accessible to all users in your Affinity account. Set to false to make the list private to the list's owner and additional users.

  • name: string

    The title of the list that is displayed in Affinity.

  • Optionalowner_id?: number

    The unique ID of the internal person who should own the list. Defaults to the owner of the API key being used. See here for permissions held by a list's owner.

  • type: EntityType

    The type of the entities (people, organizations, or opportunities) contained within the list. Each list only supports one entity type.

Settings

Member Visibility